Doc Accuracy Review

To check if API documentation matches source code, you verify checkable claims like API signatures, default values, and import paths against the actual implementation. This process flags incorrect, outdated, or unverifiable statements with evidence-backed findings and suggested fixes.

You verify CLI flag documentation by inspecting the corresponding code paths in your repository and validating checkable statements like flag names, default values, and behaviors. The review produces structured findings with severity levels and suggested fixes for any mismatched claims.

Yes, you can review an entire configuration guide section against the source code at once. The page-by-page verification process applies to API references, CLI pages, configuration guides, and cross-cutting docs to identify statements that have drifted after code changes.

The best way to find outdated documentation claims before a release is to run a source-code inspection that validates checkable statements like behaviors, exceptions, and config keys. It generates structured findings with exact doc quotes, code citations, and severity levels for any mismatches.

Documentation claims that can be verified against source code include API signatures, default values, behaviors, exceptions, config keys, CLI flags, import paths, version requirements, and file paths. The verification process checks these checkable statements and flags any that are unverifiable or outdated.