Technical Writing

Documentation Structure

Getting Started (Quickstart)

• Goal: first success in under 5 minutes.
• Prerequisites listed upfront.
• Copy-paste commands that work.
• Expected output shown.

Guides (How-To)

• Task-oriented. "How to deploy to production."
• Step-by-step with numbered instructions.
• One task per guide.
• Link to related guides at the end.