---
name: technical-writing
description: Write maintainable technical docs, RFCs, READMEs, PR descriptions, and commit messages. Use for durable engineering prose.
---
# Technical Writing

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