Documentation Auditor

•
18
•

Audits and synchronizes documentation across CLI commands, web features, and configuration settings to ensure accuracy and coverage.

The Documentation Auditor skill automates the tedious process of keeping technical documentation in sync with evolving codebases. It builds the project's CLI to discover new commands and flags, scans web source code for updated routes, and identifies configuration keys, then cross-references these findings against existing Markdown documentation. By identifying gaps, outdated defaults, and missing sections, it provides a comprehensive report and can even automatically update documentation files to fill identified voids, ensuring that developers and users always have access to accurate information.

主な機能

01Web feature and API endpoint extraction from source code
02Automated CLI command and flag discovery via binary inspection
03Cross-referencing against VitePress and standalone Markdown guides
0418 GitHub stars
05Detection of stale documentation and mismatched configuration keys
06Optional automatic fixing mode to update documentation files directly

ユースケース

01Identifying undocumented CLI flags added during rapid development cycles
02Ensuring the technical specification matches the actual implementation
03Verifying documentation coverage before a major software release