doc-sync
Verify IdeaVim docs match code changes
Documentation often drifts after code updates and creates broken examples for users. This skill provides a structured workflow to compare docs against working code and identify discrepancies.
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "doc-sync". Check README.md for outdated mappings examples
Resultado esperado:
- Found two examples with removed parameters in the mappings section
- README.md should reference the new MappingScope name instead of old name
- No other issues detected in the README file
Usando "doc-sync". Verify doc/ideavim-api.md after the 2.0 release
Resultado esperado:
- Identified 5 API signatures that changed in release 2.0
- 3 parameter names in examples need updating to match new signatures
- 1 code block uses a deprecated method that was removed
Usando "doc-sync". Check if CONTRIBUTING.md matches current git workflow
Resultado esperado:
- All git commands in CONTRIBUTING.md match current branch workflow
- No discrepancies found between documented steps and actual git behavior
Auditoría de seguridad
SeguroAll 35 static findings are FALSE POSITIVES. The static analyzer misidentified markdown documentation text as security threats. SKILL.md is pure documentation containing workflow instructions and example bash commands shown as documentation - no executable code exists. The skill-report.json already correctly assessed this as safe with no risk factors.
Factores de riesgo
🌐 Acceso a red (1)
📁 Acceso al sistema de archivos (1)
⚙️ Comandos externos (18)
Puntuación de calidad
Lo que puedes crear
Post-release audit
Confirm documentation reflects recent API changes after a release cycle completes.
Doc review before PR
Validate examples and parameter names before submitting documentation update changes.
Regression triage
Check whether reported documentation issues correspond to real API changes in code.
Prueba estos prompts
Check doc/ideavim-mappings.md against current code and list any mismatches found.
I changed MappingScope.kt. Identify affected documentation and propose specific updates.
Audit all files in doc/ for outdated examples and summarize findings in a report.
Validate all examples using map(), nmap(), and vmap() against current API signatures in code.
Mejores prácticas
- Start with a working implementation to establish ground truth before comparing docs
- Prioritize removed or renamed API elements when checking for documentation drift
- Keep updates minimal and aligned with existing documentation style and terminology
Evitar
- Updating wording when the underlying behavior is still accurate
- Skipping verification of named parameters in code examples
- Assuming documentation is correct without checking working implementation