audit-docs

Cross-reference features, docs, and Claude skills to generate a Markdown gaps report.

1|Updated Sep 20, 2025
One-click install
npx skills add https://github.com/Alex1980Alex/1C-Enterprise_Framework --skill audit-docs-alex1980alex
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/Alex1980Alex/1C-Enterprise_Framework/tree/main/.claude/skills/audit-docs
Command: npx skills add https://github.com/Alex1980Alex/1C-Enterprise_Framework --skill audit-docs-alex1980alex

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Audit codebase coverage against documentation and Claude skills, surfacing gaps and inconsistencies, and enabling automated updates where possible.

Core Features & Use Cases

  • Scan 6 feature categories across the codebase and compare them with user-facing docs and skill definitions.
  • Generate a Markdown gaps report and optionally auto-update target files with missing entries.
  • Export structured results in JSON for integrations and dashboards, and support targeted updates via flags like --update and --json.

Quick Start

Run /audit-docs to generate a Markdown gaps report; add --update to auto-fix gaps or --json for a JSON output.

Frequently Asked Questions about audit-docs

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

FAQPage Schema
How do I audit my codebase against documentation and skills?

To audit your codebase against documentation and skills, run the audit command to scan 6 feature categories and cross-reference them with user-facing docs and skill definitions, producing a Markdown gaps report.

Can I automatically fix documentation gaps found during an audit?

Yes, you can automatically fix documentation gaps by running the audit with the --update flag, which auto-updates target files with missing entries discovered during the cross-reference scan.

How do I export documentation audit results in JSON format?

You can export documentation audit results in JSON format by running the audit command with the --json flag, providing structured output suitable for integrations and dashboards.

What is the best way to find inconsistencies between code and documentation?

The best way to find inconsistencies between code and documentation is scanning 6 feature categories across the repository and comparing them against user-facing docs and skill definitions to surface gaps.

Does the documentation audit tool support automated updates for CI/CD pipelines?

Yes, the documentation audit tool supports automated updates for pipelines by utilizing the --update flag to auto-fix gaps and the --json flag to output structured results for downstream integrations.

What limitations exist when auto-updating documentation from a codebase audit?

A limitation of auto-updating documentation from a codebase audit is that the scan targets only 6 feature categories, meaning gaps outside these cross-referenced categories will not be auto-fixed or included in the report.