Changelog

What It Catches

Install & Setup

• Package names that don't exist in manifest files
• Install commands with wrong syntax or nonexistent packages
• Referenced scripts/binaries that don't exist
• Setup steps that would fail or are in wrong order

API & Usage

• Function signatures that don't match source code
• CLI flags that don't exist in the argument parser
• Code examples using APIs that were renamed or removed
• Documented defaults that differ from actual defaults

Configuration

• Config keys the code doesn't actually read
• Environment variables with wrong names
• Example configs that don't match the schema

Architecture & Structure

• File paths that don't exist
• Component descriptions that don't match the code
• Outdated dependency relationships

Change Coverage

• Code changes without corresponding doc updates
• Docs referencing removed or changed features
• New features without any documentation

Output

All output goes to .changelog/{timestamp}/:

• report.md — unified report with health score
• CHANGELOG.md — generated changelog
• audit-*.md — per-category audit details
• cross-reference.md — changes-to-docs mapping
• fixes-applied.md — auto-fix log (if --fix)
• report.json — machine-readable report (if --format json)

Documentation Health Score

Scores documentation on a 0-100 scale:

• 80-100 HEALTHY — docs are in good shape
• 50-79 NEEDS ATTENTION — some inconsistencies to address
• 0-49 CRITICAL — docs are actively misleading users

Magic Keywords

• "changelog", "doc check", "doc audit", "documentation check", "doc drift", "doc consistency"