doc-sync
Verificar que la documentación de IdeaVim coincida con los cambios de código
La documentación frecuentemente se desactualiza después de actualizaciones de código y crea ejemplos rotos para los usuarios. Esta habilidad proporciona un flujo de trabajo estructurado para comparar la documentación contra código funcional e identificar discrepancias.
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
Auditoría post-lanzamiento
Confirmar que la documentación refleja los cambios recientes de API después de completar un ciclo de lanzamiento.
Revisión de docs antes de PR
Validar ejemplos y nombres de parámetros antes de enviar cambios de actualización de documentación.
Triaje de regresión
Verificar si los problemas de documentación reportados corresponden a cambios reales de API en el código.
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
- Comenzar con una implementación funcional para establecer una verdad base antes de comparar docs
- Priorizar elementos de API eliminados o renombrados al verificar el desfase de documentación
- Mantener las actualizaciones mínimas y alineadas con el estilo y terminología existentes de la documentación
Evitar
- Actualizar la redacción cuando el comportamiento subyacente aún es preciso
- Omitir la verificación de parámetros con nombre en ejemplos de código
- Asumir que la documentación es correcta sin verificar la implementación funcional