Docs Write

Quick Checklist

• Audience and doc type (tutorial/how-to/reference/explanation)
• Clear style, active voice, consistent terms
• Structure: headings, skimmable, examples first
• Include visuals when helpful (mermaid inline; puml when reused)
• API: auth, requests/responses, errors, breaking changes
• ADR/runbook: context, decision/steps, rollback, contacts
• Cross-links and filenames; run docs-check after edits

Workflow

Writing Documentation

IMPORTANT: Before writing documentation, read references/documentation-guide.md to understand all standards, patterns, and requirements. Do not make assumptions about documentation style, structure, or content - always reference the guide for specific details.