Writing Docs

Use one page for one topic.

Rules of thumb

• Start with the reader's goal.
• Put the most useful information first.
• Show examples early.
• Keep paragraphs short.
• Prefer explicit names and concrete terms.

Good page shape

1. What this page covers.
2. The main workflow or concept.
3. One or two examples.
4. Edge cases or caveats.
5. Links to related pages.