Technical Writing
- Identify the reader and the action/decision the document should enable.
- Put prerequisites and outcome before implementation history.
- Use task-oriented sections for procedures, concept-oriented sections for mental models, and reference tables only for lookup material.
- Keep terminology stable and sentences concrete. Define unavoidable jargon once.
- Examples must be runnable or explicitly illustrative. Never fabricate commands, links, benchmarks, or compatibility claims.
- For change documents, include impact, design/behavior, verification, migration/rollback if relevant, and open risks.