What this screen does
The User Guide tab turns the specification into a document a person with no technical or domain background can read: a short brief (what the application is, who uses it, what problems it solves, what you can do), one walkthrough per user journey grouped by role ("Approve a leave request", step by step, naming the screen each step happens on), and a glossary of the domain words a newcomer would not know.
It is written from the locked specification, the User Journeys document and the Screen Map, so roles and screen names in the guide are the ones the application will actually show. Nothing in it is invented beyond those sources.
Typical workflow
- Generate the User Journeys and the Screen Map first — the guide is written from them. Then open the User Guide tab on the Specification page and click Write User Guide.
- Read the brief as a stranger would: does the first paragraph say what the app is for and who it serves? Read one walkthrough per role: would that person get the task done following these steps?
- Fix the sources, not the guide. A wrong step usually means a journey is wrong; a missing screen chip means the screen map never defined that screen. Correct those, then click Regenerate.
- When the journeys or screen map change after the guide was written, the tab shows a notice. The guide is never rewritten behind your back — Regenerate when you are ready.
- Share it: the guide is the first toggle on the project's Share page, and on the showcase it renders below the project anatomy as "About this app". It also ships as the first document in every downloaded or deployed application's docs menu.
Examples & tips
- The guide is written in the language of the specification. A specification written in English yields an English guide.
- Download Markdown gives you the guide as a file you can hand to a client or paste into a proposal.
- Full agent runs write the guide automatically after the screen map; untick "Write the user guide" in the launcher to skip it.
- Walkthroughs follow the journeys one to one, so a journey you would not show a customer is best trimmed on the User Journeys tab before regenerating.