documentation-verify

Cross-reference documentation claims, CLI commands, and API signatures against source code.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automatically checks if your documentation accurately reflects the current state of your codebase, preventing outdated or incorrect information from misleading users.

Core Features & Use Cases

  • Accuracy Cross-referencing: Verifies claims in documentation against source code.
  • Claim Categorization: Identifies documentation issues like unsupported features, outdated information, or incorrect statements.
  • Use Case: After updating a CLI command's arguments, run this Skill to ensure the help text and usage examples in your documentation are updated accordingly.

Quick Start

Use the documentation-verify skill to check the accuracy of changed documentation files against the codebase.

Frequently Asked Questions about documentation-verify

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

FAQPage Schema
How do I check if my documentation matches the current codebase?

To verify documentation accuracy, cross-reference claims, CLI commands, and API signatures against source code. This process flags unsupported or outdated claims to prevent incorrect information from misleading users.

What is the best way to verify API signatures in technical writing against source code?

Verifying API signatures involves cross-referencing documented claims with actual source code to identify incorrect statements. It categorizes documentation issues like unsupported features or outdated information to ensure technical writing accuracy.

Do I need git diff and full codebase access for documentation verification?

Yes, documentation verification requires git diff for changed files and full codebase access to validate code-docs consistency. This access allows the process to accurately cross-reference claims against actual source code.

How do I validate updated CLI command arguments in my documentation?

To validate updated CLI commands, run a verification check against the codebase to ensure help text and usage examples are updated accordingly. This flags any outdated arguments or incorrect statements in technical writing.

Why does my documentation show unsupported features after a code review?

Documentation shows unsupported features when technical writing is not updated after code changes. Cross-referencing documentation claims against source code during code review identifies and flags these outdated or incorrect statements for correction.