diataxis-docs

Enforce Diátaxis four-category documentation layouts in Datarim-managed repositories.

11|1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/Arcanada-one/datarim --skill diataxis-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diataxis-docs
Source: https://github.com/Arcanada-one/datarim/tree/main/skills/diataxis-docs
Command: npx skills add https://github.com/Arcanada-one/datarim --skill diataxis-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents inconsistent, hard-to-navigate documentation by enforcing a strict Diátaxis taxonomy and file layout across tutorials, how-to guides, reference docs, and explanations.

Core Features & Use Cases

  • Standardized docs structure: Creates and audits a docs/ layout with the four Diátaxis categories and required category README.md stubs.
  • Type-to-category mapping contract: Ensures every documentation type maps to exactly one of the four orthogonal categories, avoiding “FAQ as a category” and “examples as a fifth bucket” anti-patterns.
  • Soft drift detection & surface verification: Helps operators identify repos or sites missing the mandated layout and validates that public pages conform during archival verification.

Quick Start

Ask the AI to run the Diátaxis docs mandate for your project and report any missing or miscategorized documentation files.

Frequently Asked Questions about diataxis-docs

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

FAQPage Schema
How do I enforce a consistent documentation taxonomy across multiple repositories?

The Diátaxis taxonomy solves inconsistent documentation by enforcing a strict four-category layout: tutorials, how-to guides, reference docs, and explanations. It eliminates anti-patterns like FAQ pages or examples folders by requiring every document to map to exactly one orthogonal category.

How do I audit a docs site for Diátaxis taxonomy compliance?

Auditing a docs site for Diátaxis compliance involves running a surface verification process that scans your filesystem for missing or miscategorized files. It checks for the mandated four-category layout and required README stubs, identifying structural drift during optimization or archival workflows.

Does the Diátaxis docs mandate work with any static site generator or CMS?

Yes, the Diátaxis docs mandate is stack-agnostic and works with any static site generator or CMS. It enforces a taxonomy layout without tying the mandate to any specific platform, ensuring documentation structure remains consistent regardless of your underlying technology.

Why should I avoid using FAQ pages or examples as separate documentation categories?

You should avoid FAQ pages or examples as separate categories because they create structural drift and break taxonomy orthogonality. The Diátaxis framework treats these as anti-patterns, requiring every document to map to exactly one of the four core categories instead of creating additional buckets.

What is the best way to prevent documentation drift during project scaffolding?

The best way to prevent documentation drift during project scaffolding is to enforce the Diátaxis taxonomy layout from the start. This creates a standardized docs structure with required category README stubs, ensuring every file maps to one of the four orthogonal categories before content is added.

Can I use Diátaxis taxonomy for archive-time surface verification of public pages?

Yes, you can use the Diátaxis taxonomy for archive-time surface verification. The process validates that public pages conform to the mandated four-category layout, helping operators identify and correct any repos or sites missing the required documentation structure before archiving.