User Guides
Use this section to design user-facing documentation that answers real tasks quickly and consistently.
What this section covers
- Audience targeting and intent-driven writing
- Content selection by outcome (tutorial, how-to, reference, concept)
- Scannable structure and consistent terminology
- Review workflows that improve accuracy and readability
Start here
If you are documenting a new feature or workflow, use this path:
- Define the reader and their task outcome.
- Choose the content type that fits the task.
- Draft steps with concrete examples and expected results.
- Run the review checklist before publishing.
Writing workflow
1) Plan
- Identify user role, prerequisites, and completion criteria.
- Define scope so one page solves one problem well.
2) Draft
- Lead with the task goal, not background context.
- Use short sections, meaningful headings, and plain language.
- Include copy-paste-safe commands where needed.
3) Validate
- Run steps in a clean environment.
- Confirm screenshots, URLs, and command flags are current.
- Check that first-time readers can complete the task.
4) Maintain
- Add ownership and update cadence.
- Track support tickets to identify unclear pages.
- Prioritize fixes for high-traffic docs.
Practical standards
- Prefer active voice and direct instructions.
- Keep terminology stable across all pages.
- Use warnings only for real risk conditions.
- Link related pages so users can continue without searching.