documentation-diataxis

Analyze documentation structure and content against the Diataxis framework.

29|22|Updated Nov 25, 2025
One-click install
npx skills add https://github.com/canonical/copilot-collections --skill documentation-diataxis
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-diataxis
Source: https://github.com/canonical/copilot-collections/tree/main/assets/skills/documentation-diataxis
Command: npx skills add https://github.com/canonical/copilot-collections --skill documentation-diataxis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps ensure documentation adheres to the Diataxis framework by analyzing its structure, content, and alignment with user needs, identifying and suggesting improvements for clarity and correctness.

Core Features & Use Cases

  • Diataxis Classification: Analyzes documentation to determine if it fits the Tutorial, How-to, Reference, or Explanation categories.
  • Content Analysis: Evaluates functional and deep quality of the documentation, checking for accuracy, completeness, flow, and cognitive load.
  • Use Case: When reviewing a new set of user guides, use this Skill to classify each document according to Diataxis principles and identify any structural mismatches or quality issues before publication.

Quick Start

Analyze the documentation file 'guide.md' against the Diataxis framework.

Frequently Asked Questions about documentation-diataxis

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

FAQPage Schema
How do I classify technical writing against the Diataxis framework?

To classify technical writing against the Diataxis framework, analyze the documentation to determine if it fits the Tutorial, How-to, Reference, or Explanation categories and identify structural mismatches. This Skill evaluates alignment between declared and inferred categories.

What is the best way to review documentation quality before publication?

The best way to review documentation quality is to evaluate functional and deep quality by checking accuracy, completeness, flow, and cognitive load. This Skill provides actionable recommendations to resolve structural mismatches before publication.

Can I use Diataxis classification for user guides and content strategy?

Yes, you can use Diataxis classification for user guides and content strategy. When reviewing a new set of user guides, this Skill applies Diataxis principles to classify each document and identify structural mismatches or quality issues.

How does documentation classification identify misaligned content?

Documentation classification identifies misaligned content by analyzing the structure and substance of the text, then comparing inferred categories against declared categories. It highlights discrepancies between what the document claims to be and its actual functional purpose.

What should I check for when evaluating cognitive load in technical documentation?

When evaluating cognitive load in technical documentation, check the functional and deep quality for accuracy, completeness, and flow. This Skill assesses these dimensions to ensure the content aligns with user needs and provides actionable improvements.

Do I need any specific tools to analyze markdown documentation with Diataxis?

No specific external tools are required to analyze markdown documentation with Diataxis. You provide the documentation file, such as a markdown guide, and this Skill analyzes its structure and content directly against the framework.