Documentation template

Help center

Organize answers around customer tasks instead of the structure of your own company.

nav.yaml
01Start here
02Account
03Using the product
04Billing
05Troubleshooting
06Contact support

What this structure is for

Organize answers around customer tasks instead of the structure of your own company. Start with the smallest path that gets a reader to a result, then add reference and recovery material around it.

How to use it

  1. Replace every generic noun with the language your customers use.
  2. Give each page one job and one clear next step.
  3. Name an owner and review interval for facts that change.
  4. Publish early, then use search and feedback to find the gaps.

Page-by-page writing brief

Start here

Route customers by the task they came to complete.

Include: Top tasks, search, service status, new-user path, and contact expectations.

Account

Resolve access, profile, security, and team questions.

Include: Sign-in recovery, roles, invitations, profile settings, deletion, and safeguards.

Using the product

Explain customer jobs in their language.

Include: Goal, prerequisites, numbered steps, result, alternatives, and related tasks.

Billing

Make money and entitlement questions unambiguous.

Include: Plans, invoices, payment changes, taxes, cancellation, and refund policy.

Troubleshooting

Diagnose from a visible symptom.

Include: Symptom, checks in order, resolution, data to collect, and escalation route.
Use this template

Start with the docs you already have

Beautiful docs are easy.
Keeping them accurate is the hard part.