documentation-diataxis
OfficialReview docs against Diataxis framework.
Content & Communication#documentation#content review#technical writing#classification#quality assessment#diataxis
Authorcanonical
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documentation-diataxis Download link: https://github.com/canonical/copilot-collections/archive/main.zip#documentation-diataxis Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.