How does Doc Sync determine if documentation is wrong?

The skill treats the working implementation in the codebase as the 'ground truth' and assumes documentation is outdated until every signature and parameter is verified against the live API.

Can I use this for projects other than IdeaVim?

While specifically optimized for IdeaVim's structure (Kotlin, doc/ folder), its logic of pattern matching and git analysis can be applied to verify technical documentation in any repository.

Will it mess up my documentation's formatting?

No, the skill is designed to be conservative with fixes, preserving the existing style and only changing what is technically inaccurate.

Does it work with recent git changes?

Yes, it can analyze git logs and diffs to identify specifically what was removed or renamed, then target those areas in the documentation for updates.

Doc Sync for IdeaVim

Name: Doc Sync for IdeaVim
Author: Microck

byMicrock

•

Aprendizaje y Documentación

Synchronizes project documentation with the actual codebase by identifying discrepancies and updating examples to match the current API.

Acerca de

Doc Sync for IdeaVim is a specialized Claude Code skill designed to maintain the integrity of project documentation, including READMEs, contribution guides, and detailed manuals. It operates on a 'guilty until proven innocent' principle, aggressively auditing code examples against current API implementations and git history to ensure documentation never lags behind code changes. Whether verifying existing docs or updating them after breaking changes, this skill ensures that every function signature, parameter, and usage pattern remains accurate and functional based on the working implementation.

Características Principales

81 GitHub stars
Context-aware updates: refines documentation while preserving the original style and surrounding context.
Aggressive pattern matching: extracts function signatures and parameters from markdown to compare against the live API.
Automated discrepancy reporting: generates detailed summaries of inconsistencies found between implementations and descriptions.
Bi-directional verification: validate docs against code or update docs based on recent code changes.
Git history analysis: monitors recent commits for deletions or breaking changes that invalidate existing documentation.

Casos de Uso

Automatically updating README and CONTRIBUTING files following code deletions or renames.
Auditing existing markdown files to ensure all code examples are currently valid and runnable.
Verifying documentation accuracy after a major API refactor or breaking change.

Acerca de

Características Principales

81 GitHub stars
Context-aware updates: refines documentation while preserving the original style and surrounding context.
Aggressive pattern matching: extracts function signatures and parameters from markdown to compare against the live API.
Automated discrepancy reporting: generates detailed summaries of inconsistencies found between implementations and descriptions.
Bi-directional verification: validate docs against code or update docs based on recent code changes.
Git history analysis: monitors recent commits for deletions or breaking changes that invalidate existing documentation.

Casos de Uso

Automatically updating README and CONTRIBUTING files following code deletions or renames.
Auditing existing markdown files to ensure all code examples are currently valid and runnable.
Verifying documentation accuracy after a major API refactor or breaking change.