Skip to content

esond/docs

v0.30.0MIT

Eric's documentation skills: Diátaxis-guided writing and auditing of tutorials, how-to guides, reference, and explanation.

diataxis-tutorial

Write, expand, or audit a tutorial — learning-oriented documentation in the Diátaxis sense: a lesson that takes a beginner through a guided, hands-on experience to build skill and confidence, where the artifact produced along the way is not the point. Use whenever the user wants a "getting started" guide, onboarding walkthrough, "first steps with X", intro lesson, learning exercise, workshop material, or asks to "teach someone" a tool, API, or codebase by doing — even if they never say "tutorial". Also loaded by the diataxis router when the compass points to action + acquisition: the reader will *do* something in order to *learn*. If the reader is an already-competent practitioner trying to get a real job done, that's diataxis-how-to instead; when the type is in doubt or mixed, consult the diataxis skill first.

Read SKILL.md at the source

Pinned to revision a943fbd893c9, so it is the text this page describes rather than whatever the author pushed since.

Files

Every link opens the file at its source, pinned to the revision this page describes.