diataxis

Classify documentation into Diátaxis quadrants and generate gap analysis reports.

3|1|Updated Jan 17, 2026

Search Tags:#documentation #classification #diataxis #cross-references #gap-analysis #quadrants

Ready to run

npx skills add https://github.com/zircote/documentation-review --skill diataxis-zircote

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: diataxis
Source: https://github.com/zircote/documentation-review/tree/main/skills/diataxis
Command: npx skills add https://github.com/zircote/documentation-review --skill diataxis-zircote

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Diátaxis provides a principled method to classify, organize, and audit documentation based on the four quadrants (Tutorial, How-to, Reference, Explanation), enabling teams to identify gaps, enforce consistent frontmatter, and reduce mode-mixing across a documentation corpus.

Core Features & Use Cases

Classify documents into the four Diátaxis quadrants based on intent and content.
Perform gap analyses to identify missing quadrants for features or components.
Detect and remedy mode mixing (e.g., tutorials drifting into reference content) and suggest split points.
Audit cross-references and organize docs by quadrant directories if configured.
Enforce consistent diataxis frontmatter (diataxis_type) and provide templates for new/docs.

Quick Start

Classify your docs into Diátaxis quadrants and generate a gap analysis report across the repository.

Frequently Asked Questions about diataxis

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

FAQPage Schema

How do I classify documentation to identify gaps across my repository?▼

Documentation classification assigns docs to Diátaxis quadrants to reveal missing coverage for features. This approach audits your repository to find quadrant gaps and enforce consistent frontmatter across tutorials, how-tos, references, and explanations.

What is mode mixing in documentation and how do I fix it?▼

Mode mixing occurs when content drifts between types, like tutorials turning into reference material. Diátaxis classification detects this drift and suggests split points to separate the mixed documentation into distinct, properly aligned quadrants.

How do I organize a large documentation corpus by intent?▼

Organizing a large documentation corpus by intent requires classifying each file into one of four Diátaxis quadrants. This process enables quadrant-based directory organization and cross-reference audits to maintain consistent structure across your docs.

Do I need specific frontmatter to enforce documentation structure?▼

Yes, enforcing consistent structure requires diataxis frontmatter in your files. This metadata assigns a diataxis_type to each document, which quadrant-specific templates then use to maintain alignment and standardize your documentation.

What's the best way to audit cross-references in a documentation repository?▼

Auditing cross-references is best handled by classifying docs into Diátaxis quadrants to map relationships. This classification identifies broken links and mode drift across tutorials, how-tos, references, and explanations while enforcing consistent frontmatter.