How does Doc Sync verify documentation accuracy?

It extracts code blocks and function signatures from your documentation and compares them against the actual working implementation in your codebase to identify mismatches.

Can it handle breaking changes in the code?

Yes, Doc Sync specifically analyzes git history and recent commits to identify removals and renames that might have broken existing documentation examples.

What is the 'Trust Hierarchy' used by this skill?

The skill treats the working implementation in the codebase as the highest truth, followed by the API definition, and finally the documentation, which is assumed outdated until proven otherwise.

Does it automatically overwrite my documentation?

Doc Sync follows a 'conservative fix' strategy. It is aggressive in finding issues but only proposes or makes changes when a clear discrepancy with the code is found.

Which documentation files does this skill support?

It is optimized for files in the doc/ folder, README.md, and CONTRIBUTING.md, primarily focusing on Markdown formats.

Doc Sync

Name: Doc Sync
Author: Activer007

byActiver007

콘텐츠 관리

Keeps project documentation perfectly aligned with codebase changes by identifying discrepancies and verifying API signatures.

소개

Doc Sync is a specialized skill designed to bridge the gap between evolving codebases and their documentation. It treats documentation as 'guilty until proven innocent,' proactively searching for outdated function signatures, renamed parameters, and broken code examples. By establishing a ground truth from working implementations and git history, it ensures that READMEs, contribution guides, and technical docs stay accurate and functional, preventing developer friction caused by stale information.

주요 기능

Automated extraction and validation of code examples and function signatures
Targeted documentation updates that preserve existing style and context
Pattern matching against working implementations to ensure usage accuracy
Deep git history analysis to track breaking changes and code removals
Bidirectional verification between source code and markdown documentation
0 GitHub stars

사용 사례

Verifying documentation accuracy after a major API refactor or breaking change
Syncing README and CONTRIBUTING files during rapid development cycles
Auditing existing tutorials to ensure code examples still compile and run

소개

주요 기능

Automated extraction and validation of code examples and function signatures
Targeted documentation updates that preserve existing style and context
Pattern matching against working implementations to ensure usage accuracy
Deep git history analysis to track breaking changes and code removals
Bidirectional verification between source code and markdown documentation
0 GitHub stars

사용 사례

Verifying documentation accuracy after a major API refactor or breaking change
Syncing README and CONTRIBUTING files during rapid development cycles
Auditing existing tutorials to ensure code examples still compile and run