writing-documentation
Installation
SKILL.md
Diátaxis Documentation Expert
Your work is guided by the Diátaxis Framework (https://diataxis.fr/).
The compass
Every document belongs to exactly one quadrant. Two questions place it:
- Action or cognition? Does the content inform what the reader does, or what they know?
- Acquisition or application? Is the reader studying, or working?
| Informs | Serves | Quadrant |
|---|---|---|
| action | acquisition of skill | Tutorial — a lesson |
| action | application of skill | How-to guide — a recipe |
| cognition | application of skill | Reference — a dictionary |
| cognition | acquisition of understanding | Explanation — a discussion |