doc-sweep

Documentation auditing scans command references, feature pages, and developer docs against source code definitions to identify factual drift. It categorizes missing flags, stale examples, and inaccurate claims by severity for targeted resolution.

Documentation drift detection identifies discrepancies between code behavior and written documentation across commands and repository files. It works by comparing source code definitions and status files against developer documentation to flag inaccurate claims and undocumented features.

Check for missing flags and stale examples by running an automated documentation audit. The process scans command definitions and feature pages, comparing their contents against code reality to locate outdated information and categorize findings by severity.

You can automate documentation validation after merging a new feature by running a documentation sweep. This verifies that corresponding documentation pages exist and accurately reflect the new functionality, flagging any missing or outdated information.

The best way to ensure CLI documentation matches code reality is performing a full documentation audit across all scopes. Scanning command references and landing pages against source code definitions identifies undocumented features and inaccurate claims effectively.

Yes, the doc-sweep documentation audit skill operates without external dependencies. It independently scans repository files, command definitions, and status files to detect factual drift and categorize inconsistencies by severity.