docs-audit

You can audit documentation completeness by checking coverage across all four Diataxis quadrants: tutorials, how-to guides, reference material, and explanation docs. This verifies that each documentation type is present and meaningfully covered.

Detecting stale API documentation involves comparing last-modified timestamps against recent code changes to identify mismatches. This flags outdated stack references and operational guidance that have drifted from the current implementation.

Checking release readiness involves assessing minimum README quality alongside operational documentation like deployment guides, runbooks, changelogs, and architecture decisions. This validates that essential guidance is present before deployment.

A documentation audit works for both project onboarding and ongoing maintenance by evaluating SDLC readiness. It identifies missing operational guidance and detects when existing docs have drifted from implementation due to code changes.

A documentation audit output includes a structured findings table detailing coverage gaps and staleness flags. Results are persisted to enable cross-run trend tracking, helping monitor documentation freshness across repeated audits.