What this structure is for
Guide customers from first success through everyday workflows, integrations, and recovery. Start with the smallest path that gets a reader to a result, then add reference and recovery material around it.
How to use it
- Replace every generic noun with the language your customers use.
- Give each page one job and one clear next step.
- Name an owner and review interval for facts that change.
- Publish early, then use search and feedback to find the gaps.
Page-by-page writing brief
Overview
Set the promise and help readers choose a path.
Include: Who the product is for, the result it creates, prerequisites, and next steps.Quickstart
Create the smallest meaningful success.
Include: A starting state, numbered steps, expected result, and a recovery link.Core concepts
Explain the model readers need to predict behavior.
Include: Named objects, their relationships, lifecycle, limits, and one concrete example.Workflows
Guide a real job from trigger to outcome.
Include: When to use it, decisions, steps, checkpoints, and what happens next.Troubleshooting
Help readers identify and recover from failure.
Include: Observable symptom, likely cause, safe fix, verification, and escalation details.