Does it support projects other than IdeaVim?

While the skill includes specific patterns for IdeaVim, its core logic of extracting signatures and verifying them against a local codebase is applicable to most software projects with markdown-based documentation.

Can it update documentation files automatically?

Yes, it can identify discrepancies in files like README.md and CONTRIBUTING.md and apply precise edits to ensure code examples match the current codebase state.

What is the benefit of Phase 0 Pre-Analysis?

Phase 0 allows the skill to establish a 'ground truth' by searching for real implementations and recent breaking changes in the git log before attempting to judge the accuracy of the documentation.

How does the Doc Sync skill ensure documentation accuracy?

The skill uses a 'code-first' approach, treating the working implementation as the ground truth and systematically verifying every documented signature, parameter, and usage pattern against the actual API.

Documentation Sync Specialist

Name: Documentation Sync Specialist
Author: Microck

byMicrock

•

학습 및 문서화

Maintains perfect alignment between technical documentation and codebase changes by identifying discrepancies and verifying API signatures.

소개

The Doc Sync skill serves as an automated auditor for project documentation, specifically optimized for repositories like IdeaVim. It adopts a 'guilty until proven innocent' mindset toward documentation, prioritizing the actual codebase implementation as the ultimate source of truth. By analyzing git history for recent deletions, extracting function signatures from markdown files, and cross-referencing them against the current API, this skill helps developers ensure that READMEs, contribution guides, and technical manuals never become obsolete. It can operate bidirectionally, either verifying existing docs against the code or updating documentation automatically following a significant code refactor.

주요 기능

Automated extraction and validation of function signatures and parameters
Bidirectional synchronization between source code and markdown documentation
81 GitHub stars
Git history analysis to identify breaking changes and removed code
Ground Truth verification to prioritize implementations over outdated text
Detailed discrepancy reporting with severity levels and suggested actions

사용 사례

Auditing large documentation folders for consistency during release cycles
Updating technical documentation immediately after a major API refactor
Validating that README code examples are still functional and accurate

소개

주요 기능

Automated extraction and validation of function signatures and parameters
Bidirectional synchronization between source code and markdown documentation
81 GitHub stars
Git history analysis to identify breaking changes and removed code
Ground Truth verification to prioritize implementations over outdated text
Detailed discrepancy reporting with severity levels and suggested actions

사용 사례

Auditing large documentation folders for consistency during release cycles
Updating technical documentation immediately after a major API refactor
Validating that README code examples are still functional and accurate