New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Documentation Verify

by canonical in canonical/workshop

Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.

GPL-3.0Auto-check passedDevelopment

Install Documentation Verify

skills CLI
$ npx skills add canonical/workshop --skill documentation-verify -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install canonical/workshop documentation-verify --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/canonical/workshop.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.github/skills/documentation-verify .claude/skills/documentation-verify && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-verify
GitHub stars
114
Token cost
~932 tokens
SKILL.md length
421 words
Files
3 (incl. references)
Skills in repo
6
Repo updated
First seen
Licence
GPL-3.0

At a glance

Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.

  • Works in 3 steps: Discovery Scan → Verification Pass → Report Generation
  • Validating documentation correctness
  • SKILL.md covers Scope, Inputs, Workflow and Constraints, plus 1 more section
  • Calls git

What it does

Documentation Verify is an agent skill from canonical/workshop. Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code. Use when validating documentation correctness or checking code-docs consistency. Flags unsupported or outdated claims.

Its SKILL.md is about 930 tokens, which your agent loads only when the skill is triggered. The skill folder holds 3 other files, including reference files (for example `references/report_format.md` and `references/verification_procedures.md`).

It sits in Development. It works with Git. The repository describes itself as: Workshops are secure, fast, and composable development environments that come agent-ready. The licence is GPL-3.0.

When your agent uses it

  • Validating documentation correctness
  • Checking code-docs consistency

Example prompts

  • “Use the documentation-verify skill to verify documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration…”
  • “/documentation-verify”

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Discovery Scan
  2. Verification Pass
  3. Report Generation

What it can do on your machine

Read from SKILL.md and the folder at commit 0b41ee9. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Verify loads about 932 tokens when it runs, and up to ~3.8k if it reads all its reference files. Until then it costs about 67 tokens; SKILL.md has 421 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~67
When it runs · the whole SKILL.md, loaded when a task matches
~932
With references · SKILL.md plus every file in references/, read only if the agent opens them
~3.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from canonical/workshop at commit 0b41ee9, republished under its GPL-3.0 licence (© canonical). 421 words, ~932 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-verify/SKILL.md (or your agent's skills folder). This skill also uses 2 other files; get the full folder from GitHub.
name
documentation-verify
description
Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code. Use when validating documentation correctness or checking code-docs consistency. Flags unsupported or outdated claims.

Documentation Accuracy Verification

Scope

Accuracy verification only: cross-reference documentation claims, commands, API names, and configuration keys against source code in the same repository. Flag anything that cannot be verified.

Inputs

  • Changed documentation files (from git diff). If git diff is unavailable or empty, use files explicitly provided for review; otherwise, treat all documentation files under docs/ as changed.
  • Full codebase.
  • Test files, configuration schemas.
  • Documentation structure.

Workflow

Follow this three-stage process to verify documentation accuracy:

Stage 1: Discovery Scan

Objective: Identify documentation claims and form initial hypotheses.

  1. Run git diff to list changed documentation files.
  2. Categorize changes into claim types (behaviour, CLI, API, config, examples, error messages, etc.).
  3. Form initial hypotheses: Supported, Unsupported, Speculative, Ambiguous, or Outdated.

For detailed categorization and hypothesis formation procedures, see references/verification_procedures.md → Discovery Scan.

Stage 2: Verification Pass

Objective: Verify every hypothesis with code evidence. Code is the source of truth.

CRITICAL: Complete verification before reporting any claims.

  1. Use at least two search strategies per claim (direct search, entrypoint tracing, test evidence, schema/validation search).
  2. Apply claim-type-specific verification checklists (behaviour, CLI, API, config, examples, errors, terminology).
  3. Document evidence for each finding (file paths, line numbers, search commands).
  4. Reclassify hypotheses based on verification results.
  5. Apply false-positive prevention rules.
  6. Cross-check documentation coverage.

For comprehensive verification checklists and classification rules, see references/verification_procedures.md → Verification Pass.

Show full SKILL.md (198 more words)Show less
Stage 3: Report Generation

Objective: Present verified findings with evidence and conservative recommendations.

  1. Group findings by final classification (unsupported, outdated, incorrect, imprecise, speculative, inconclusive, no issues).
  2. Format each finding using the standard template (doc claim, verification checklist, code evidence, assessment, recommended action).
  3. Provide conservative change suggestions aligned with code reality.
  4. Link to specific code artifacts (files, functions, structs, line numbers).
  5. Integrate with other analysis findings (e.g., Diataxis compliance).

For report formatting template and change suggestion guidelines, see references/report_format.md.

Constraints

  • Complete the verification pass (Stage 2) before reporting any claims.
  • Provide code evidence for all documentation consistency claims.
  • Code is the source of truth: flag documentation that contradicts code behaviour, not vice versa.
  • Do not claim documentation is "unsupported by code" without verification evidence (at least two search strategies with explicit code search and no-match confirmation).
  • Do not report false positives.
  • Do not prefer "unsupported" when docs are vague or imprecise; use accurate classifications.
  • Do not recommend changing code to match docs as the primary action; only documentation should be adjusted to match code reality.

Output

Only verified findings with evidence make it to the final report. Do not include intermediate hypotheses or reasoning.

© canonical, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 2 other files (references) in .github/skills/documentation-verify of canonical/workshop.

  • SKILL.md
  • references/report_format.md
  • references/verification_procedures.md

Open the folder on GitHubat commit 0b41ee9

Compare with similar skills

Documentation Verify next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Verify compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Verify this skillcanonical/workshop114—~932Automated safety check: PassGPL-3.0
Finishing a Development Branchobra/superpowers296k5 repos~1.9kAutomated safety check: PassMIT
Code Review ChecklistshareAI-lab/learn-claude-code78k5 repos~1.1kAutomated safety check: PassMIT
Codebase Knowledge Graph Q&AEgonex-AI/Understand-Anything86k1 repos~1.2kAutomated safety check: PassMIT
Code Design Rationale Investigatorcursor/plugins10k9 repos~2.6kAutomated safety check: PassNone
Understand Diff AnalysisEgonex-AI/Understand-Anything86k1 repos~1.4kAutomated safety check: PassMIT

Similar skills

  • Finishing a Development Branch

    obra/superpowers

    Walks the last step of a branch: confirm tests pass, detect the git environment, ask how to integrate, carry out your choice and clean up the worktree.

    296k GitHub starsUsed in 5 repos~1.9k tokens
    DevelopmentAuto-check passed

  • Code Review Checklist

    shareAI-lab/learn-claude-code

    Reviews code against a five-part checklist covering security, correctness, performance, maintainability and testing, and reports findings in a fixed format.

    78k GitHub starsUsed in 5 repos~1.1k tokens
    DevelopmentAuto-check passed

  • Codebase Knowledge Graph Q&A

    Egonex-AI/Understand-Anything

    Answers questions about a codebase by searching a prebuilt knowledge graph of its files, functions, classes and dependencies, not by rereading every source file.

    86k GitHub starsUsed in 1 repo~1.2k tokens
    DevelopmentAuto-check passed

  • Code Design Rationale Investigator

    cursor/plugins

    Official

    Digs into why code is shaped the way it is by checking git history, pull requests and connected tools in parallel, then reporting a cited read on the tradeoffs.

    10k GitHub starsUsed in 9 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Understand Diff Analysis

    Egonex-AI/Understand-Anything

    Reads your git changes or a pull request against a prebuilt knowledge graph of the project to explain what changed, which components are affected and what is risky.

    86k GitHub starsUsed in 1 repo~1.4k tokens
    DevelopmentAuto-check passed

  • Understand Explain

    Egonex-AI/Understand-Anything

    Gives an in-depth explanation of one file, function or module by reading the project's knowledge graph and checking that the graph is still fresh.

    86k GitHub starsUsed in 1 repo~1.3k tokens
    DevelopmentAuto-check passed

More from canonical/workshop

  • Documentation Build

    canonical/workshop

    Validates documentation builds successfully. An agent skill from canonical/workshop.

    114 GitHub stars~762 tokensUpdated today
    Auto-check passed

  • Documentation Review

    canonical/workshop

    Performs comprehensive documentation review including build validation, Diataxis analysis, structure audit, accuracy verification, and style compliance.

    114 GitHub stars~1.9k tokensUpdated today
    Auto-check passed

  • Documentation Style

    canonical/workshop

    Enforces project documentation style guide compliance for tone, voice, terminology, punctuation, and formatting.

    114 GitHub stars~714 tokensUpdated today
    Auto-check passed

  • Documentation Diataxis

    canonical/workshop

    Analyzes documentation against Diataxis framework (Tutorial, How-to, Reference, Explanation).

    114 GitHub stars~1.6k tokensUpdated today
    Auto-check passed

  • Documentation Structure

    canonical/workshop

    Validates documentation structural integrity including heading hierarchy, metadata, file naming, navigation, and cross-references.

    114 GitHub stars~704 tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Documentation Verify

What does Documentation Verify do?

Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code. Documentation Verify is an agent skill from canonical/workshop. Verifies documentation accuracy by cross-referencing claims, CLI commands, API signatures, and configuration against source code.

When should I use Documentation Verify?

Documentation Verify fits situations like: validating documentation correctness; checking code-docs consistency.

How do I install Documentation Verify in Claude Code?

Run `npx skills add canonical/workshop --skill documentation-verify -a claude-code`. Or copy the skill folder (.github/skills/documentation-verify in canonical/workshop) into .claude/skills/documentation-verify in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Verify in Codex?

Run `npx skills add canonical/workshop --skill documentation-verify -a codex`. Or copy the skill folder (.github/skills/documentation-verify in canonical/workshop) into .agents/skills/documentation-verify in your project. Codex loads it when a task matches its description.

Can I use Documentation Verify in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add canonical/workshop --skill documentation-verify -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-verify, .gemini/skills/documentation-verify, .github/skills/documentation-verify and .opencode/skills/documentation-verify in your project.

What does Documentation Verify need to run?

Going by SKILL.md and its folder, Documentation Verify needs the command-line tools its instructions call (git).

Does Documentation Verify access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Documentation Verify safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Verify use?

Documentation Verify is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Verify use?

About 932 tokens (SKILL.md is roughly 3.7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.9k tokens, read only when the agent opens those files.

What are the alternatives to Documentation Verify?

Skills that share tags, products or a category with Documentation Verify: Finishing a Development Branch (obra/superpowers, 296k stars), Code Review Checklist (shareAI-lab/learn-claude-code, 78k stars), Codebase Knowledge Graph Q&A (Egonex-AI/Understand-Anything, 86k stars) and Code Design Rationale Investigator (cursor/plugins, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Verify?

canonical (a GitHub organization) maintains it in canonical/workshop, which has 114 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 8, 2026.

Source: canonical/workshop on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.