# Documentation Plan

## Goal

Create clear, maintainable documentation that helps new users understand what they can do in Axon on day 1.

## Audience

* End users: people booking spaces and checking daily workspace status.
* Team leads and managers: people managing schedules, team capacity, and zone ownership.
* Organization admins: people managing users, roles, policies, and billing.

## Scope For V1

* Onboarding and orientation docs for the current `/app` and `/dashboard` experience.
* One page per major module/area so users can find features fast.
* Practical usage guidance that matches current product behavior.
* Permission guidance so users understand why they may not see certain sections.

## Information Architecture

1. Getting started
2. App modules (`/app`)
3. Dashboard and settings (`/dashboard`)
4. Internal operational docs (existing QA checklists)

## Writing Standards

* Use plain language and task-first headings.
* Keep each page focused on one area of the product.
* Separate "what it is" from "how to use it" and "access required".
* Call out "coming soon" and gated functionality explicitly.
* Avoid internal API or implementation details unless needed for admins.

## Maintenance Workflow

1. Update docs in the same PR as product changes.
2. Keep `docs/SUMMARY.md` in sync with any new page.
3. Treat this set as the canonical source for GitBook sync.
4. Add screenshots after the content baseline is stable.

## Feature Parity Review Checklist

Use this quick pass before closing a release or grouped feature branch:

1. Compare changed user-facing routes/components against `docs/SUMMARY.md`.
2. Verify new dashboard/app sections are linked from `docs/README.md`.
3. Verify task-driven flows have a matching page in `docs/task-guides/`.
4. Check permission-sensitive behavior against `getting-started/access-and-permissions.md`.
5. Update "what you can do" sections when labels or workflow steps changed.
6. Add/update troubleshooting notes when security or validation rules changed.

## Next Content Iteration

* Add role-based walkthroughs: member, team lead, org admin.
* Add short task guides (for example: "book a desk", "create recurring schedule").
* Add troubleshooting/FAQ pages for top support questions.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xdbx.gitbook.io/axon/documentation-plan.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.