doc-alignment

What problem does it solve?

Stale or incorrect documentation creates friction for developers, contributors, and users, leading to wasted time, incorrect implementation, and avoidable support requests when docs no longer reflect the actual codebase.

Core Features & Use Cases

• Automated Doc Discovery: Scans the repository for all relevant markdown documentation, including root-level READMEs, CONTRIBUTING files, and docs in standard directories like docs/ and .claude/.
• Claim Validation: Extracts concrete, testable claims from documentation and verifies them against source code, build configs, and runtime manifests.
• Risk-Ranked Reporting: Classifies mismatches by severity (high, medium, low) and provides actionable patch guidance for documentation updates.
• Use Case: Before a public release, run this audit to ensure your README's setup steps, feature lists, and API references match the current codebase, so contributors do not follow outdated instructions.

Quick Start

Use the doc-alignment skill to audit all markdown documentation in the current repository and generate a prioritized mismatch report at the repo root.