✍️ Technical Writing · Documentation Systems
Sort docs into types readers recognize
Tutorials vs how-tos vs reference vs explanation — separating modes ends most doc confusion.
foundation~30 minTechnical WritersDeveloper AdvocatesEngineers Who Document
Steps
- 1Label every existing page: learning-journey, task-recipe, information-lookup, or theory
- 2Flag pages mixing modes; split at natural seams
- 3Write one flagship tutorial covering the happy path end-to-end
- 4Move edge-case handling into linked how-to recipes
- 5Generate reference mechanically from source where possible
- 6Add 'which page do I need?' router for newcomers
Common Pitfalls
- ▲Tutorials stuffed with tangents breaking flow
- ▲Reference prose explaining philosophy nobody asked
Commands
Install with skills CLI
$ npx skills add aniruddhaadak80/skills --skill docs-systems-diataxis-auditInstall globally
$ npx skills add aniruddhaadak80/skills --skill docs-systems-diataxis-audit -gTags
#diataxis#information-architecture#technical-writing#docs-systems