Documentation

Technical Documentation Skill

Core Principles

1. Read before you write. Always read existing docs before rewriting. Preserve good content.
2. Audience is developers. Assume technical competence. Skip basics, get to the point.
3. Show, don't tell. Code examples > prose explanations.
4. Keep it current. Docs that lag behind code are worse than no docs.
5. One source of truth. Don't duplicate information across files — link instead.

Structure

Page Anatomy

Every doc page should have:

• Title — what this page covers (H1)
• Opening paragraph — what and why in 2-3 sentences
• Body — organized with H2/H3 sections
• Examples — real, runnable code blocks