diataxis

Organize and evaluate documentation into Diátaxis framework categories.

5|Updated Dec 9, 2025
One-click install
npx skills add https://github.com/arisng/github-copilot-fc --skill diataxis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diataxis
Source: https://github.com/arisng/github-copilot-fc/tree/main/skills/diataxis
Command: npx skills add https://github.com/arisng/github-copilot-fc --skill diataxis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Create and evaluate documentation using the Diátaxis framework to ensure each piece serves a single user need. It helps writers diagnose documentation problems, separate mixed content, and align content with four distinct user needs (Tutorials, How-to Guides, Reference, Explanation).

Core Features & Use Cases

  • Structured documentation: Organize content into Tutorials, How-to Guides, Reference, and Explanation to serve specific user intents.
  • Auditing and cleanup: Identify category pollution and suggest extractions or links to separate content.
  • Template-driven authoring: Use category-specific templates to ensure consistent tone and structure across documentation.

Quick Start

Use the diataxis skill to categorize a messy product doc into Tutorials, How-to Guides, Reference, and Explanation, then generate an index that links to each piece.

Frequently Asked Questions about diataxis

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

FAQPage Schema
How do I organize messy product documentation into distinct categories?

Audit documentation content by evaluating it against the Diátaxis framework to identify category pollution and separate mixed content. The skill diagnoses documentation problems and suggests extractions or links to isolate overlapping user intents within your knowledge base.

What is the Diátaxis framework for structuring technical content?

The Diátaxis framework is a documentation structure that separates content into Tutorials, How-to Guides, Reference, and Explanation. It aligns technical content with four distinct user needs, ensuring writers produce focused material rather than mixing learning and reference tasks together.

How do I generate an index for documentation split into tutorials and reference guides?

Generate an index for split documentation by using the skill's automatically generated index feature after categorizing content into the four Diátaxis areas. This index links to each piece, requiring frontmatter-driven metadata and category-specific templates to function correctly.

Does this documentation audit approach work for knowledge bases and software docs?

Yes, this documentation audit approach works for software documentation, product docs, and knowledge bases. The Diátaxis framework evaluates content universally by diagnosing documentation problems and separating mixed content regardless of the specific technical subject matter.