Doc Sync for IdeaVim

概要

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.

主な機能

• 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.

ユースケース

• 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.