docs-auditor

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.