diataxis-docs

Installation
SKILL.md

Diataxis Documentation Skill

Turn a documentation request into the right document type, at the right level of detail, for the right reader. Classify before writing.

The Diataxis compass

Diataxis separates documentation by two questions — action or cognition, acquiring or applying skill — and yields four forms.

If the content… …and serves the user's… …then it must belong to…
informs action acquisition of skill a tutorial
informs action application of skill a how-to guide
informs cognition application of skill reference
informs cognition acquisition of skill explanation

To use the compass, ask two questions:

  • Is the content about action (practical steps, doing) or cognition (propositional knowledge, thinking)?
  • Is the user acquiring skill (study) or applying skill (work)?
Installs
1
GitHub Stars
1
First Seen
7 days ago
diataxis-docs — 88lin/diataxis-docs-skill