How does this skill help with documentation debt?

It can review your current files, classify them according to the framework, and identify 'mode violations' where different types of information are improperly mixed, making them harder to maintain.

What is the Diátaxis framework?

Diátaxis is a systematic approach to technical documentation that divides content into four categories—Tutorials, How-to guides, Reference, and Explanation—each serving a specific user need.

Why shouldn't I mix modes within a single document?

Mixing modes confuses the reader's intent. A user following a goal-oriented How-to guide shouldn't be interrupted by the theoretical 'Why' found in an Explanation or the step-by-step hand-holding of a Tutorial.

Can I use this for non-technical documentation?

While designed for software documentation, the principles of separating learning, tasks, information, and understanding apply to almost any instructional writing.

Diátaxis Documentation Framework

Name: Diátaxis Documentation Framework
Author: oxidecomputer

byoxidecomputer

•

Learning & Documentation

Writes, reviews, and organizes technical documentation using the Diátaxis framework's four distinct content modes.

The Diátaxis skill empowers Claude to apply the industry-standard documentation framework developed by Daniele Procida to your software projects. By strictly categorizing content into Tutorials, How-to guides, Reference material, and Explanations, this skill eliminates common documentation pitfalls like 'mode mixing' that lead to user confusion. Whether you are building a new manual from scratch or refactoring a complex legacy documentation set, this skill provides the systematic rigor needed to ensure every piece of content serves a specific user need and remains architecturally consistent.

Key Features

01Automated documentation reviews and structural quality audits

02Direct integration with canonical Diátaxis best practices and source material

032 GitHub stars

04Strict mode enforcement to prevent mixing instructions with theory

05Guidance for organizing complex documentation hierarchies and navigation

06Automatic classification of documentation into one of four Diátaxis modes

Use Cases

01Restructuring a chaotic README or wiki into a professional documentation set

02Auditing existing docs to identify where tutorials and how-to guides are conflated

03Drafting neutral, information-dense reference material for APIs or technical specifications

Key Features

01Automated documentation reviews and structural quality audits

02Direct integration with canonical Diátaxis best practices and source material

032 GitHub stars

04Strict mode enforcement to prevent mixing instructions with theory

05Guidance for organizing complex documentation hierarchies and navigation

06Automatic classification of documentation into one of four Diátaxis modes

Use Cases

01Restructuring a chaotic README or wiki into a professional documentation set

02Auditing existing docs to identify where tutorials and how-to guides are conflated

03Drafting neutral, information-dense reference material for APIs or technical specifications