docs-update
Actualizar el doc afectado (architecture|data-model|testing|ci|voz|runbook) según DOC.template.md; no para ESTADO/DECISIONES/ROADMAP ni enlaces (docs-check).
SKILL.md.claude/skills/docs-update/SKILL.md
GitHubdocs-update
Actualiza el documento que corresponde a $ARGUMENTS para que refleje el estado real del código.
Cuándo usarla
- Un cambio de código, esquema, datos, pipeline de voz o CI deja desfasado un doc de
docs/. - Hay que crear un doc nuevo del tema (runbook, contrato) con la estructura de
docs/_templates/DOC.template.md.
Cuándo NO usarla
- Registrar una decisión técnica → usa
registrar-decision;docs/DECISIONES.mdes reservado. - Actualizar
docs/ESTADO.md→ usasession-handoff(reservado al agente principal). - Comprobar enlaces o coherencia sin reescribir → usa
docs-check.
Precondiciones
$ARGUMENTSes uno de los valores; si falta, deducirlo degit diff --staty confirmarlo; si es ambiguo, preguntar.- Conocer el cambio fuente (diff, commit o hito). Reservados que NO se editan aquí:
docs/DECISIONES.md,docs/ESTADO.md,docs/MEMORIA.md,docs/_templates/**,CLAUDE.md,ROADMAP.md,QUESTIONS.md. Si hay que tocarlos, pedirlo al agente principal.
Pasos
- Localizar el doc destino con la tabla; si no existe, crearlo desde
DOC.template.md(cabeceraPropósito · Audiencia · Actualizado, Resumen, secciones del tema, Decisiones y fuentes, Pendiente).
| Valor | Doc destino |
|---|---|
| architecture | docs/arquitectura.md (diagramas Mermaid) |
| data-model | doc del modelo de datos en docs/ (tablas Room, índices, formato de paquetes de mapas; localizar con Glob) |
| testing | docs/testing.md |
| ci | docs/ci-cd.md (workflows, release y Play; ver también docs/play.md) |
| voz | docs/VOZ.md (pipeline de voice-lab: transcripción, glosario, entrenamiento, pregeneración) |
| runbook | docs/runbooks/<tema>.md (pasos operativos, comprobaciones, vuelta atrás) |
- Leer el doc entero y el cambio fuente (
git diff, código, migración, workflow); contrastar cada afirmación con el código real, no con la memoria. - Editar solo las secciones afectadas; mantener estilo, tablas y diagramas. No duplicar
docs/DECISIONES.md: referenciarlo por sección. - Datos no verificados (límites, versiones) → marcar
VERIFICAR. Nunca inventar cifras. - Seguridad: nunca valores de secretos; solo nombres de variables.
- Actualizar
Actualizado: AAAA-MM-DDde la cabecera y mover a## Pendientelo abierto. - Si se añade un doc nuevo, enlazarlo desde el doc relacionado.
- Ejecutar la skill
docs-check linkssobre los archivos tocados.
Validaciones / tests
node scripts/check-docs.mjssin errores en los archivos tocados.git diff --statsolo muestra docs permitidos, ninguno reservado.
Definition of Done
- El doc refleja el código actual; cada dato verificable contrastado o marcado
VERIFICAR. - Estructura de
DOC.template.mdrespetada y fechaActualizadoal día. - Ningún doc reservado editado; peticiones sobre ellos listadas para el agente principal.
- Sin secretos ni valores sensibles.
-
node scripts/check-docs.mjsen verde.
Docs a actualizar
- Doc destino de la tabla · enlaces cruzados en docs relacionados · docs/ESTADO.md (skill
session-handoff, agente principal)