Create an end-to-end service guide or roadmap

These documents support planning, service context, integration points, and links to technical specifications so teams can move from discovery to delivery.

Choose the right format

• Use concise guidance when readers need direct steps for specific tasks.
• Use a roadmap when readers need phased plans, dependencies, and sequencing.

Plan the guide

Define audiences, map user journeys, shape content structure, and use clear terminology so readers can find information quickly.

Build and publish

Set up your documentation workspace, configure publishing, complete peer review, and release updates through a controlled process.

Design principles

• Support multiple pages with consistent structure and labels.
• Provide accessible standalone text alongside diagrams.
• Keep navigation shallow and predictable.
• Test with representative users before wider release.
• Maintain clear changelogs for updates and decisions.

Keep it current

Schedule regular reviews, monitor feedback, and update the guide when workflows or requirements change.

Need support?

If you are blocked, ask for help through your normal support route.

Got feedback?

Share feedback to help improve this guidance.