doc-sync

Name: doc-sync
Author: JetBrains

Keeps IdeaVim documentation in sync with code changes. Use this skill when you need to verify documentation accuracy after code changes, or when checking if documentation (in doc/, README.md, CONTRIBUTING.md) matches the current codebase. The skill can work bidirectionally - from docs to code verification, or from code changes to documentation updates.

TL;DR

Keeps IdeaVim docs in sync with code changes. Docs are guilty until proven innocent.

What Is It

Synchronizes docs with code changes
Verifies documentation accuracy after code updates
Works bidirectionally: docs to code, code to docs
Assumes docs are outdated until verified

Key Features

CRITICAL: Docs are guilty until proven innocent
Be aggressive finding issues, conservative making fixes
Trust codebase over documentation
Verify every function signature and parameter
Check working implementations as ground truth
Update only when API or behavior has changed
Preserve style and context in updates

How to Use

1.Step 0: Find working implementations and check git history
2.Step 1: Determine mode (doc→code or code→doc)
3.Step 2: Run quick pattern searches to find red flags
4.Step 3: Verify each code block against working implementation
5.Step 4: Update docs only if discrepancies are found

Guardrails & Gotchas

CRITICAL: After code changes, documentation is GUILTY until proven innocent
DON'T update for internal implementation changes
DON'T update for minor formatting or wording issues
DON'T update for test file changes
ONLY update when API, behavior, or file paths have changed

GitHub Stats

Author

@JetBrains

Repository

JetBrains/ideavim

Stars

10,228

Explore More Skills

revenuecat

@rawveg

Comprehensive assistance with RevenueCat in-app subscriptions and purchases

687

7mo ago

doc-sync

Explore More Skills

revenuecat

api-design-principles

solana-security