Documentation
Purpose
Accurate, user-focused documentation.
Core Principles
- •Write for target audience & their goals
- •Sync docs w/ code changes
- •Use examples to reduce ambiguity
Rules
Structure
- •Short overview & prerequisites
- •Step-by-step for tasks
- •Troubleshooting for common failures
Clarity
- •Consistent terminology & naming
- •Avoid unnecessary jargon
- •Runnable, up-to-date examples
Examples
✅ "Include minimal example + explanation of expected output" ❌ "List config options w/o context or examples"
Edge Cases
- •Breaking changes: add migration guide
- •Complex systems: diagrams or architecture summaries
See COMMON.md.
Refs: Google doc guide, Dev style (2026-01-26)