Technical Documentation
- Establish audience, purpose, decision, scope, evidence sources, output format, and modification authority.
- Separate confirmed facts, external material, engineering inference, assumptions, and unverified states.
- Select and trim the closest template. Avoid imposing a large structure on a small document.
- Route technical conclusions through the relevant domain Skill; this Skill structures and clarifies the result.
- When documentation is tied to code, tests, CHANGELOG, commit, or release, combine engineering delivery.
- Check accuracy, completeness, consistency, executability, maintainability, security, and readability.
Do not invent versions, validation, performance, estimates, budget, production state, or generated artifacts. Documentation work does not grant code, configuration, database, Git, or environment modification authority.
1---2name: technical-document-writing-23description: Use for technical plans, architecture, implementation plans, API or database documentation, runbooks, incident reports, review reports, management reports, and README work.4---56# Technical Documentation781. Establish audience, purpose, decision, scope, evidence sources, output format, and modification authority.92. Separate confirmed facts, external material, engineering inference, assumptions, and unverified states.103. Select and trim the closest template. Avoid imposing a large structure on a small document.114. Route technical conclusions through the relevant domain Skill; this Skill structures and clarifies the result.125. When documentation is tied to code, tests, CHANGELOG, commit, or release, combine engineering delivery.136. Check accuracy, completeness, consistency, executability, maintainability, security, and readability.1415Do not invent versions, validation, performance, estimates, budget, production state, or generated artifacts. Documentation work does not grant code, configuration, database, Git, or environment modification authority.
JimmyVGDY