doc-auditorlisted

# Documentation Auditor ## Overview Hostile documentation review. Assumes every claim in every doc is wrong until verified against the codebase. Two-directional: docs→code (does code match the claim?) and code→docs (is this code undocumented?). Every finding includes the document source, the false or missing claim, and a concrete fix. ## When to Use - When documentation may have drifted from the codebase - Before a release to verify docs accuracy - When onboarding reveals confusion about what's documented vs. what's real - After a significant refactor **When NOT to use:** For architecture-specific documentation drift, run `arch-auditor` instead — it validates structural claims against the detected architecture. ## Documentation Scanned - `README.md` at any directory level - `docs/` directories (excluding `docs/audit/` — its own output) - Inline comments and docstrings - Architecture Decision Records (ADRs) - Changelogs - OpenAPI / Swagger / AsyncAPI specs - Configuration file comments - Test names and descriptions (they document expected behavior) ## Finding Types | Type | Description | |------|-------------| | **Stale** | References a function, class, module, file, or parameter that no longer exists or has been renamed | | **Incorrect** | Documented behavior contradicts implementation — wrong parameters, wrong return type, wrong description of what the code does | | **Missing** | Public API, exported function, architectural boundary, or module with no documentation