audit-docs

Audit documentation coverage for CLI commands, web features, and configuration settings.

62|13|Updated Feb 8, 2026
One-click install
npx skills add https://github.com/driangle/taskmd --skill audit-docs-driangle
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/driangle/taskmd/tree/main/.agents/skills/audit-docs
Command: npx skills add https://github.com/driangle/taskmd --skill audit-docs-driangle

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill identifies discrepancies between the actual functionality of the CLI and web features and their corresponding documentation, ensuring accuracy and completeness.

Core Features & Use Cases

  • Comprehensive Auditing: Verifies CLI commands, flags, web pages, API endpoints, and configuration options against documentation.
  • Gap Identification: Pinpoints missing documentation, outdated information, and inaccuracies.
  • Automated Fixes: Optionally updates documentation files to align with the codebase.
  • Use Case: Before releasing a new version, run this Skill to guarantee that all new features are documented and that existing documentation accurately reflects the latest code.

Quick Start

Run the audit-docs skill to check for documentation gaps in the project.

Frequently Asked Questions about audit-docs

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

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

You can audit CLI documentation coverage against the codebase to identify gaps, outdated content, and inaccuracies. This process verifies CLI commands, flags, web pages, and configuration options to ensure your documentation matches reality.

What is the best way to find missing web feature documentation before a release?

The best way to find missing web feature documentation is running a comprehensive audit to pinpoint missing pages and API endpoints. It verifies web features and configuration settings against the codebase to ensure completeness before release.

Can I automatically fix outdated documentation files?

Yes, you can automatically fix outdated documentation files by using an optional --fix flag. This flag automatically updates your documentation to align with the latest codebase changes, resolving identified gaps and inaccuracies.

How do I run a targeted audit for only CLI commands or web features?

To run a targeted audit for only CLI commands or web features, use the --cli-only or --web-only flags respectively. These flags restrict the documentation validation scope to specific areas of your project.

Why does my documentation validation report configuration setting inaccuracies?

Documentation validation reports configuration setting inaccuracies because it audits configuration options against the codebase. It identifies discrepancies where documented settings no longer match the actual functionality, ensuring accuracy and completeness.