Can it detect broken parameters in documentation examples?

Yes, one of its core functions is to verify that named parameters used in documentation examples actually exist in the current function signatures in the codebase.

Is this skill specific to IdeaVim?

While the logic is optimized for IdeaVim patterns, its core methodology for synchronizing documentation with code changes is applicable to any technical software project.

Does it support both Markdown and code files?

Yes, it analyzes Markdown files and compares the code snippets within them to the actual source code files in the repository.

How does the Doc Sync skill determine the correct implementation?

It uses a ground truth hierarchy, prioritizing the working code implementation and API definitions over the existing documentation, assuming docs are outdated until verified.

When should I use the 'Code Changes to Documentation' mode?

Use this mode after you have made code changes (e.g., via git diff) and want the skill to find and update any documentation that might now be inaccurate due to your changes.

Doc Sync Specialist

Name: Doc Sync Specialist
Author: Activer007

byActiver007

0•

コンテンツ管理

Keeps technical documentation and code implementations perfectly synchronized by identifying discrepancies and updating outdated examples.

The Doc Sync skill ensures documentation accuracy by treating code implementations as the ultimate source of truth. It proactively verifies function signatures, parameter names, and usage patterns against the actual codebase, making it indispensable after major refactors or API changes. By performing deep analysis of working implementations and git history, it identifies where documentation has fallen behind, allowing for automated or guided updates to READMEs, contribution guides, and dedicated doc folders.

主な機能

01Ground-truth verification against actual working implementations in the codebase

02Automated verification of function signatures and parameter names in code examples

030 GitHub stars

04Bidirectional synchronization between code changes and documentation files

05Consistency checks for README.md, CONTRIBUTING.md, and dedicated doc folders

06Git history analysis to identify breaking changes and removed APIs

ユースケース

01Auditing an entire documentation folder to find and fix outdated class or function references

02Ensuring contribution guidelines accurately reflect current project setup and implementation patterns

03Verifying that README examples still work after a major API refactor

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add activer007/ordinary-claude-skills doc-sync

For use in Claude.ai and ChatGPT

Download Skill