diataxis

Generates and audits documentation using the Diataxis four-quadrant framework.

Updated Jul 2, 2026
One-click install
npx skills add https://github.com/geekatron/jerry-claude-plugin --skill diataxis-geekatron
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: diataxis
Source: https://github.com/geekatron/jerry-claude-plugin/tree/main/skills/diataxis
Command: npx skills add https://github.com/geekatron/jerry-claude-plugin --skill diataxis-geekatron

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Documentation often mixes tutorials, how-to guides, reference material, and explanations into a single undifferentiated document, making it hard for readers to learn, accomplish tasks, or look up facts. This Skill separates content into the four Diataxis quadrants and enforces per-quadrant quality criteria. ## Core Features & Use Cases - Quadrant-Specific Writing: Four specialized writer agents produce tutorials, how-to guides, reference docs, and explanations, each following dedicated templates and quality criteria. - Documentation Classification: A classifier agent analyzes requests against the two Diataxis axes (practical/theoretical, acquisition/application) and returns a quadrant assignment with a deterministic confidence score. - Documentation Auditing: An auditor agent detects quadrant mixing, anti-patterns, and voice violations in existing docs, producing structured audit reports with severity-graded findings. - Use Case: Ask for a tutorial on setting up a project; the classifier routes the request, the tutorial writer produces a step-by-step guide with prerequisites and visible results per step, and the auditor verifies it contains no explanation digressions. ## Quick Start Ask the assistant to write a tutorial for setting up your first project, or to audit an existing documentation file for quadrant mixing.

Frequently Asked Questions about diataxis

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a tutorial using the Diataxis framework?▼

Invoke the diataxis-tutorial agent with a topic, prerequisites, and target outcome. It produces a numbered step-by-step guide where every step has a visible result, no alternatives are offered, and no explanation content appears between steps.

What is the difference between a tutorial and a how-to guide?▼

A tutorial is learning-oriented for beginners studying a skill, with one linear path and no choices. A how-to guide is goal-oriented for competent users at work, allowing conditional branches like 'If you need X, do Y' for real-world variations.

How does the documentation classifier decide which quadrant to use?▼

The classifier applies a two-axis test: practical versus theoretical, and acquisition versus application. It returns a quadrant with a deterministic confidence score of 1.00, 0.85, or 0.70, and escalates to the user when confidence falls below 0.70.

Can this skill audit existing documentation for quality issues?▼

Yes, the diataxis-auditor agent evaluates documents against per-quadrant quality criteria, detects quadrant mixing using seven heuristics, and produces a structured report with a PASS, NEEDS REVISION, or MAJOR REWORK verdict.

When should I not use the Diataxis documentation skill?▼

Do not use it for writing code, tests, requirements specifications, or adversarial review of non-documentation deliverables. It also should not be used when the user explicitly requests free-form writing without Diataxis structure.