Actualizaciones automáticas de documentación
Mantén la documentación sincronizada con tu código usando el skill /update-jamdesk para Claude Code. Actualiza automáticamente los docs cuando implementas funcionalidades.
El skill /update-jamdesk para Claude Code observa los cambios en tu código y genera las actualizaciones de documentación correspondientes. Después de lanzar una funcionalidad orientada al usuario, ejecuta el skill y determinará qué páginas de documentación necesitan crearse o editarse.
¿Buscas consejos generales de escritura con IA? Esta página cubre el skill /update-jamdesk para actualizaciones automáticas de documentación. Para la configuración de herramientas, consulta Claude Code. Para una guía más amplia sobre el uso de herramientas de IA para escribir docs, consulta Escribir con IA.
Cuándo usarlo
Úsalo cuando: Has realizado cambios orientados al usuario en APIs, comandos CLI, interfaz de usuario, opciones de configuración o comportamiento de componentes.
Omítelo cuando: Refactorizaciones internas, cambios solo de pruebas, configuración de build/CI, o trabajo de rendimiento sin cambio de comportamiento — estos no necesitan documentación orientada al usuario.
Requisitos previos
- Claude Code instalado y configurado
- Un proyecto de documentación Jamdesk con
docs.json - Opcional: CLI de Jamdesk para verificación (
npm install -g jamdesk)
Inicio rápido
Crea un archivo .jamdesk-docs-path en tu repositorio de código apuntando a tus docs:
docs_path: ../my-docsLa ruta puede ser relativa (desde el archivo de configuración) o absoluta.
Después de implementar una funcionalidad, ejecuta:
/update-jamdeskClaude analizará tus cambios y hará preguntas de aclaración antes de escribir la documentación.
Revisa la documentación generada; luego Claude la verificará con jamdesk validate y jamdesk broken-links antes de confirmar los cambios.
Formato del archivo de configuración
El archivo .jamdesk-docs-path le indica a Claude dónde se encuentra tu documentación.
Formato simple - solo la ruta:
../my-docsFormato completo - con opciones:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainEl archivo de configuración se descubre recorriendo hacia arriba desde tu directorio actual hasta la raíz del repositorio git. Colócalo en la raíz de tu repositorio para obtener mejores resultados.
Cómo funciona
Cuando ejecutas /update-jamdesk, Claude:
- Localiza tus docs - Encuentra el archivo de configuración
.jamdesk-docs-path - Hace preguntas - Clarifica la estrategia de ramas, el alcance y el contenido
- Analiza los docs existentes - Busca contenido relacionado para actualizar o extender
- Escribe la documentación - Crea o actualiza páginas siguiendo los estándares de Jamdesk, con ejemplos simples primero
- Revisa el tono - Comprueba el resultado en busca de relleno generado por IA. Claude escribe mejor con un CLAUDE.md que establezca la voz (consulta Claude Code)
- Verifica - Ejecuta
jamdesk validateyjamdesk broken-links - Confirma - Prepara los cambios y ofrece confirmar/enviar/crear PR
¿No te gustan los cambios? Ejecuta git checkout . antes de confirmar para revertir todas las ediciones.
| Escenario | Acción |
|---|---|
| Nueva funcionalidad | Crear nueva página |
| Cambio de comportamiento | Actualizar página existente |
| Adición pequeña | Añadir sección a página existente |
| Capacidad mayor | Nueva página independiente |
| Deprecación/eliminación | Actualizar existente + añadir notas de migración |
Ejemplo de sesión
User: I just added a webhook feature. Can you document it?
Claude: I'm using the update-jamdesk skill to update your documentation.
Found .jamdesk-docs-path: ../customer-docs
How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch
User: 1
Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)
Any changes to this plan?
User: Looks good
Claude: [Creates documentation...]
✓ jamdesk validate passed
✓ jamdesk broken-links passed
Commit these changes?Modo preview
Ejecuta con --preview para ver qué cambiaría sin realizar ediciones:
/update-jamdesk --previewEl modo preview te permite:
- Comprobar qué documentación necesita actualizarse
- Revisar los cambios propuestos antes de confirmarlos
- Ver el análisis del skill sin efectos secundarios
Sugerencias proactivas
Después de confirmar cambios de código orientados al usuario, Claude puede sugerir:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.Esto aparece cuando:
- Tienes un archivo de configuración
.jamdesk-docs-path, Y - Tu confirmación incluye archivos que coinciden con patrones orientados al usuario (API, CLI, componentes)
Instalar el skill
Instala el skill /update-jamdesk usando el CLI de skills:
npx skills add jamdesk/skills --skill update-jamdeskEsto instala el skill en .claude/skills/update-jamdesk/ en tu proyecto.
Instala en el directorio de tu proyecto actual:
npx skills add jamdesk/skills --skill update-jamdeskEl skill está disponible cuando trabajas en este proyecto.
Ver los skills disponibles
Ver todos los skills de Jamdesk:
npx skills add jamdesk/skills --listActualizar
Vuelve a ejecutar el comando de instalación para obtener la última versión:
npx skills add jamdesk/skills --skill update-jamdeskDespués de instalar o actualizar, reinicia Claude Code o inicia una nueva sesión para que los cambios surtan efecto.
Solución de problemas
Asegúrate de que el archivo del skill esté en .claude/skills/update-jamdesk/SKILL.md y reinicia tu sesión de Claude Code.
Crea .jamdesk-docs-path en la raíz de tu repositorio con la ruta a tu directorio de docs. El skill busca desde tu directorio actual hasta la raíz del repositorio git.
Instala con npm install -g jamdesk. El skill funcionará sin él, pero no ejecutará la validación automática.