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.
주요 기능
0181 GitHub stars
02Automated validation of function signatures and parameters in documentation examples
03Git history analysis to detect recent breaking changes and removals
04Bidirectional verification between documentation and code implementation
05Pattern matching against 'ground truth' working implementations in the source code
06Detailed discrepancy reporting with severity assessments
사용 사례
01Updating technical documentation immediately following a major API refactor
02Verifying that code examples in a README or 'doc/' folder actually work
03Auditing project documentation for outdated parameter names and removed functions