Doc-Sync: Code & Documentation Alignment

概要

Doc-Sync is a specialized skill designed to prevent documentation drift by ensuring that README files, contribution guides, and technical docs stay perfectly aligned with the actual codebase. It operates on a 'code-first' trust hierarchy, treating documentation as outdated until proven otherwise. By analyzing git history for breaking changes and cross-referencing documentation examples against live API signatures, this skill helps developers maintain high-quality, accurate technical resources without the manual overhead of constant verification.

主な機能

• 81 GitHub stars
• Automated validation of function signatures and parameters in documentation examples
• Git history analysis to detect recent breaking changes and removals
• Bidirectional verification between documentation and code implementation
• Pattern matching against 'ground truth' working implementations in the source code
• Detailed discrepancy reporting with severity assessments

ユースケース

• Updating technical documentation immediately following a major API refactor
• Verifying that code examples in a README or 'doc/' folder actually work
• Auditing project documentation for outdated parameter names and removed functions