documentation-diataxis

documentation-diataxis is a skill for Claude Code, Codex from canonical/copilot-collections. It costs 46 tokens per session (1,276 once invoked), scanned A, original, Apache-2.0.

A documentation review tool based on Diátaxis, a framework that separates documentation into tutorials, how-to guides, reference material, and explanations.

In plain words
What is it for?
Use it to classify documentation, identify structural mismatches, and suggest improvements when reviewing files.
Why use it?
It finds cases where a document’s structure or purpose does not match the type of help it claims to provide.

Skill for Claude CodeCodex

About the project

Canonical Copilot Collections is a repository for organizing and distributing GitHub Copilot instructions, prompts, agents, and skills across Canonical repositories. Teams configure repositories to subscribe to shared collections, such as Python, documentation, or Juju development guidance, and keep those assets synchronized.

canonical/copilot-collections · 29 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/canonical/copilot-collections/documentation-diataxis
Any agent
npx skills add canonical/copilot-collections --skill documentation-diataxis
Clone the repo
git clone --depth 1 https://github.com/canonical/copilot-collections

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-diataxis

README.md
[![agentmods](https://agentmods.dev/badge/skills/canonical/copilot-collections/documentation-diataxis.svg)](https://agentmods.dev/skills/canonical/copilot-collections/documentation-diataxis)
Your own site
<a href="https://agentmods.dev/skills/canonical/copilot-collections/documentation-diataxis"><img src="https://agentmods.dev/badge/skills/canonical/copilot-collections/documentation-diataxis.svg" alt="Measured on agentmods" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,276 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00046 $0.01276
Opus 5 $0.00023 $0.00638
Sonnet 5 $0.00009 $0.00255
Haiku 4.5 $0.00005 $0.00128

Measured 5d ago against content hash 331716ee5d24, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

documentation-diataxis scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/documentation-diataxis/SKILL.md · 153 lines

How it starts

The opening of the file, as written. The whole thing — 153 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Diataxis Classification Review

Scope

Diataxis classification only: identify whether each page is a tutorial, how-to guide, explanation, or reference; note structural mismatches between content type and declared category, and suggest improvements where real issues exist. Ground classification in the Diataxis foundations: the two axes of craft (action vs cognition, acquisition vs application) define four user needs (learning, goals, information, understanding).

This skill identifies flaws and provides actionable recommendations; it does not enforce compliance or apply pass/fail criteria.

Inputs

  • Documentation file(s) under review.
  • Diataxis framework principles (embedded in classification criteria below).

Actions

  1. Identify intended category: Determine the declared category based on directory location (tutorial/, how-to/, explanation/, reference/) and file metadata (front matter keys such as category, type, diataxis, or reST .. meta:: entries).

  2. Infer actual category: Analyse the text's structure, tone, and progression to determine which quadrant it actually resembles. Use these classification criteria:

    • Tutorial indicators:

      • Step-by-step progression building a complete project
      • Imperative mood ("Create a file", "Run this command")
      • Learning-focused language ("you will learn", "by the end")
      • Safe, controlled environment (specific versions, no branching)
      • Frequent reassurance and checkpoints
      • Teaches by doing, not explaining
    • How-to guide indicators:

      • Problem-solution format with clear goal
      • Assumes existing knowledge and competence
      • Clearly states prerequisites and applicability scope
      • Action-oriented ("To achieve X, do Y")
      • Flexible, allows for variation
      • Focuses on results, not learning
      • Omits explanations unless critical to success
    • Reference indicators:

      • Descriptive, declarative statements
      • Comprehensive coverage of subject
      • Neutral, technical tone
      • Structured for lookup (tables, lists, alphabetical)
      • Parameters, options, API signatures
      • Accuracy over narrative

Read the full file on GitHub · 153 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 153 lines · 46 tokens per session scan A 331716ee5d24

Subscribe to this mod's changes

documentation-diataxis is a skill published in the GitHub repository canonical/copilot-collections (29 stars, last pushed 2d ago), licensed Apache-2.0. It adds 46 tokens to every session and 1,276 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

speckit.specify

Skill "speckit.specify" from caipe-io/ai-platform-engineering, covering user input, outline, quick guidelines, section requirements and for ai generation.

caipe-io/ai-platform-engineering · 0 tokens

speckit.clarify

Skill "speckit.clarify" from caipe-io/ai-platform-engineering, covering user input and outline.

caipe-io/ai-platform-engineering · 0 tokens

local-integration-testing

Run end-to-end integration tests with all 15 agents and supervisor in local Docker Compose dev environment. Validates agent discovery, multi-agent routing, checkpoint persistence, and cross-agent follow-up conversations.

caipe-io/ai-platform-engineering · 44 tokens

release-docs

Generate a combined release blog post for ai-platform-engineering. Produces a single docs/releases/YYYY-MM-DD-release-X-Y-Z.md file containing release notes and the upgrade guide (migration guide) inline. Use when cutting a release, when a user asks "what changed in 0.4.x", or when upgrading their values.yaml to a new…

caipe-io/ai-platform-engineering · 76 tokens

update-docs

Audit and update all documentation moving parts for ai-platform-engineering. Checks release blog posts, features page, agent docs, homepage version strings, Docusaurus version config, and sidebar completeness. Fixes what is stale and reports what needs manual attention. Use after cutting a release, adding a new agent…

caipe-io/ai-platform-engineering · 70 tokens

docker-compose-first-install

Validate and repair the OSS first-install Docker Compose path. Use when editing docker-compose.yaml, docker-compose.dev.yaml, .env.example, release image tags, Compose profiles, Keycloak/OpenFGA/RAG defaults, or first-launch UI behavior for local all-in-one installs.

caipe-io/ai-platform-engineering · 60 tokens