agentleFS
modeled-information-formatmodeled-information-format/mif-docs-plugin/skills/diataxis-tutorial/SKILL.md

diataxis-tutorial

Skill1 starsChanged 34 days agoMITView on GitHub

Write a Diataxis tutorial — a learning-oriented, hands-on lesson that takes a beginner through a single concrete success by doing, not explaining. Use when the user needs onboarding/getting-started content where the goal is the learner's confidence, not task completion or reference lookup. Anti-trigger; for accomplishing a known task use diataxis-how-to, for facts use diataxis-reference.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the imperative ("Run…", "Open…"), present the result every time.

    line 32

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

diataxis-tutorial

Produces a tutorial in the Diataxis sense: learning-oriented. The reader is a beginner; success is that they finish having done something real and feel capable. A tutorial is not a how-to (task-oriented) and not an explanation (understanding-oriented) — keep those modes out.

Pattern (industry: Diataxis, diataxis.fr)

  1. Promise — one sentence: what the learner will have built/done by the end.
  2. Prerequisites — the minimum concrete setup, already working.
  3. Numbered steps — each step is an action with a visible result the learner can check. Small, ordered, no branching.
  4. Checkpoints — after key steps, "you should now see…" so they self-verify.
  5. Conclusion — name what they accomplished; point to how-to/reference next.

Rules that keep it a tutorial

  • Teach by doing; defer the "why". If background reasoning would help, point to a named Diataxis explanation document — not a reference or how-to — rather than silently deleting the content with no forward pointer.
  • One happy path. No options, no alternatives, no decision trees for things that might go wrong mid-lesson.
  • Everything must work if followed verbatim: no unfilled placeholders, no deferred setup ("configure as needed").
  • Use the imperative ("Run…", "Open…"), present the result every time.

MIF frontmatter

type: procedural (learning by doing). Climb to L2 with namespace, tags, title when known. Gate every output with mif-validate --level 1.

See templates/good.md (a conformant tutorial) and templates/bad.md (a tutorial that has drifted into how-to/reference mixing — the most common error).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.