Does it overwrite my entire documentation file?

No, Doc Sync is designed to be conservative with fixes. it makes precise, targeted updates to incorrect signatures or examples while preserving the original writing style and context.

Does it assume the documentation is always correct?

Quite the opposite; it operates on a 'guilty until proven innocent' mindset, assuming documentation is outdated until it is successfully verified against the actual working code.

Which documentation files does it typically monitor?

It is configured to look at the doc/ folder, README.md, and CONTRIBUTING.md, though it can be pointed to any markdown-based technical documentation in a repository.

Can this skill handle breaking changes in the code?

Yes, it specifically analyzes git logs for keywords like 'remove' or 'deprecate' and checks recent commits to identify what was deleted, ensuring documentation doesn't reference obsolete code.

How does Doc Sync verify code examples in documentation?

The skill extracts function signatures and parameters from documentation files and compares them against the current live API and existing working implementations within the codebase to identify mismatches.

Doc Sync Specialist

Name: Doc Sync Specialist
Author: Activer007

byActiver007

学习与文档

Keeps technical documentation in sync with codebase changes by identifying discrepancies and updating code examples.

关于

Doc Sync is a specialized Claude Code skill designed to bridge the gap between source code and technical documentation. It ensures that READMEs, contribution guides, and API documentation remain accurate by treating documentation as "guilty until proven innocent" after code changes. The skill performs bidirectional verification, extracting code examples from markdown files and validating them against the live API, while also checking git history for breaking changes or removals that might render existing documentation obsolete. It is particularly optimized for projects with complex mappings and API signatures, ensuring that every snippet provided to users actually works.

主要功能

Bidirectional synchronization between code changes and documentation updates
0 GitHub stars
Deep git history analysis to identify breaking changes and removed code patterns
Pattern-matching validation against real-world working implementations in the codebase
Automated extraction and verification of function signatures and parameters in markdown files
Targeted updates that maintain existing documentation style and contextual relevance

使用场景

Automating documentation updates following the removal or deprecation of function parameters
Verifying that README code examples are still valid after a major API refactor
Auditing legacy documentation folders to ensure they match the current ground truth of the implementation

关于

主要功能

Bidirectional synchronization between code changes and documentation updates
0 GitHub stars
Deep git history analysis to identify breaking changes and removed code patterns
Pattern-matching validation against real-world working implementations in the codebase
Automated extraction and verification of function signatures and parameters in markdown files
Targeted updates that maintain existing documentation style and contextual relevance

使用场景

Automating documentation updates following the removal or deprecation of function parameters
Verifying that README code examples are still valid after a major API refactor
Auditing legacy documentation folders to ensure they match the current ground truth of the implementation