docs-auditor

Audit documentation against the codebase and generate a structured health report.

2|Updated Jan 12, 2026

Search Tags:#documentation #verification #audit #reporting #code-quality #health

Ready to run

npx skills add https://github.com/NimbleBrainInc/skills --skill docs-auditor

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-auditor
Source: https://github.com/NimbleBrainInc/skills/tree/main/docs-auditor
Command: npx skills add https://github.com/NimbleBrainInc/skills --skill docs-auditor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Systematically audit documentation against the actual codebase to determine accuracy, staleness, and relevance, enabling teams to maintain trustworthy docs.

Core Features & Use Cases

Automated cross-checking of docs vs code to identify inaccuracies, staleness, and mismatches.
Generates a structured health report with actionable remediation steps.
Useful after refactors or documentation rewrites to ensure alignment.

Quick Start

Run docs-auditor against your codebase to generate a health report:

Command: docs-auditor scan /path/to/project --output docs-health.md
Optional: Include a sample repository to test.

Frequently Asked Questions about docs-auditor

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

FAQPage Schema

How do I audit documentation against my codebase to verify accuracy?▼

A documentation health audit cross-checks your docs against the actual codebase to identify inaccuracies, staleness, and mismatches. It generates a structured health report with actionable remediation steps to maintain trustworthy docs.

What is the best way to check documentation health after a code refactor?▼

The best way to check documentation health after a code refactor is running an automated cross-checking scan. It verifies that documentation matches the updated code and produces a structured health report to guide remediation.

How do I generate a structured report for documentation remediation?▼

Generating a structured report for documentation remediation involves scanning the project directory and outputting a health report file. This report enforces verifiable claims and provides actionable steps to correct staleness and mismatches.

Can I use a documentation audit tool for software projects of any size?▼

Yes, you can use a documentation audit tool for software projects of any size. It is applicable for both post-refactor cleanups and general health checks, ensuring documentation must match code regardless of project scale.

What does a documentation health check include for code quality reporting?▼

A documentation health check for code quality reporting includes automated cross-checking of docs versus code, structured scoring, and a formal audit report. It enforces verifiable claims to determine accuracy, staleness, and relevance.