Automated Documentation Auditor
Analyzes source code changes to identify and fix stale, inaccurate, or missing documentation in sync with your development workflow.
The Document Changes skill automates the critical task of keeping technical documentation synchronized with evolving codebases. By analyzing git diffs, it detects changes to public API surfaces, CLI commands, and configuration settings, then maps these modifications to existing documentation pages. It operates in two modes: a report mode for local developers to review documentation debt before submitting PRs, and an edit mode for CI environments to automatically patch outdated content. This ensures that your how-to guides, concept pages, and code examples remain accurate without manual auditing.
주요 기능
01Dual-mode execution for interactive local reporting or automated CI/CD patching.
02Ensures documentation quality by enforcing specific tone, style, and component conventions.
03Identifies stale content, broken code examples, and missing documentation coverage.
0418 GitHub stars
05Analyzes git diffs to detect changes in public APIs, CLI commands, and configuration settings.
06Smart filtering to skip internal symbols, test files, and auto-generated reference docs.
사용 사례
01CI/CD Documentation Patching: Automatically fixing minor documentation inaccuracies during the merge process.
02Legacy Code Auditing: Scanning existing repositories to find documentation that no longer matches current code behavior.
03Pre-PR Documentation Audit: Automatically identifying which doc pages need updates based on feature changes.