Doc-Sync: Code & Documentation Alignment FAQs

Question 1

Does it check parameter names or just function names?

Accepted Answer

It performs a deep check of every parameter name and type within a code block to ensure they exist in the current API, identifying critical bugs that manual reviews often miss.

Question 2

How does Doc-Sync determine if documentation is incorrect?

Accepted Answer

It follows a specific 'Trust Hierarchy' where the working implementation in the codebase is the highest truth. It assumes documentation is 'guilty until proven innocent' and verifies it against the actual API definitions.

Question 3

Does it automatically overwrite my documentation?

Accepted Answer

Doc-Sync is designed to be aggressive in finding issues but conservative in making fixes. It only updates documentation when a real functional discrepancy is found, while preserving the existing writing style.

Question 4

What documentation locations does it support?

Accepted Answer

While optimized for projects like IdeaVim, it is configured to check README.md, CONTRIBUTING.md, and any files within the 'doc/' folder of a repository.

Question 5

Can this skill detect breaking changes?

Accepted Answer

Yes, it specifically analyzes git logs for keywords like 'remove', 'deprecate', or 'incorrect' to identify recent deletions that might have broken existing documentation examples.

Doc-Sync: Code & Documentation Alignment

主要功能

使用场景

Doc-Sync: Code & Documentation Alignment

主要功能

使用场景