writing-technical-documentation
Installation
SKILL.md
Writing technical documentation
Organize durable documentation along two independent axes:
- Reader purpose: what relationship does the reader have to the material?
- Delivery: when and how does the reader or agent receive it?
The first axis comes from Diátaxis. The second prevents agent repositories from turning Diátaxis into a rigid four-folder taxonomy.
Classify the reader purpose
| Purpose | Reader need | Shape |
|---|---|---|
| Tutorial | Learn through a safe, guided experience | A complete path that teaches by doing |
| How-to | Accomplish a real task | Goal-oriented procedure for a competent reader |
| Reference | Look up accurate facts while working | Concise description structured like the machinery |
| Explanation | Understand why the system has its shape | Rationale, tradeoffs, failure narratives, and connections |