technical-documentation
Installation
SKILL.md
Technical Documentation
Make each document serve one user need. Classify by what the user is doing now, not by the subject, format, difficulty, or product structure.
Classify the need
Ask two questions:
- Does the user need action or cognition?
- Are they acquiring skill through study or applying skill at work?
| User need | Document type | Purpose |
|---|---|---|
| Action + acquisition | Tutorial | Learn through a guided experience |
| Action + application | How-to guide | Accomplish a real task |
| Cognition + application | Reference | Look up authoritative facts while working |
| Cognition + acquisition | Explanation | Build understanding through reflection |
Use this compass at document, section, paragraph, or sentence level. If content serves several cells, split it and cross-link the parts rather than weakening each purpose. (The compass, Foundations, The map)