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

• What this page covers.
• The main workflow or concept.
• One or two examples.
• Edge cases or caveats.
• Links to related pages.