Sincronizar documentación

Úsalo cuando una fase de PR o una característica esté terminada y antes de que se abra su PR; cuando se hayan añadido, renombrado, movido o eliminado archivos, paquetes, rutas, comandos, variables de entorno, APIs o convenciones; o cuando se te pida 'actualizar docs', 'sincronizar docs', 'refrescar el README/AGENTS.md', o te digan 'los docs están desactualizados'. Audita cada documento contra el código, corrige la desviación, regenera los documentos generados y confirma el resultado en la rama actual.

¿Qué es Sincronizar documentación?

Esta habilidad para agentes de IA (como Claude Code, Cursor, Codex) aborda el problema común de que la documentación de software se desactualice con el tiempo. Su objetivo es sincronizar automáticamente cada documento del proyecto con el código real, corrigiendo discrepancias como archivos movidos, comandos renombrados o variables de entorno que ya no existen. Es útil porque elimina la necesidad de revisiones manuales exhaustivas, evitando que la documentación se convierta en una fuente de errores. Funciona auditando el código modificado, verificando cada afirmación en la documentación, editando las desviaciones, regenerando documentos automáticos y confirmando los cambios directamente en la rama de trabajo actual, nunca en `main`. Soporta el mantenimiento de un inventario de documentos en `docs/DOCS.md` y respeta reglas como no editar documentos congelados o planes pasados.

Compatible con✓Claude Code~Codex CLI~Cursor✓Gemini CLI
npx skills add https://github.com/chukaofili/agent-plugins/tree/HEAD/plugins/coding-protocol/skills/sync-docs

Installed? Explore more Productividad y colaboración skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

¿Qué hace Sincronizar documentación?

La documentación se desvía silenciosamente. Nada falla cuando un README nombra un archivo que se movió. Ejecuta esto después de cada fase de PR apilada o característica completada, antes de que se abra el PR.

El contrato de esta habilidad incluye confirmar cambios. Puede confirmar sin preguntar, siempre en la rama actual, nunca main.

Cuándo saltar

  • Nada de lo que un documento referencia ha cambiado (lógica interna pura). Aun así, escribe "documentación revisada, sin desviación" en la sección de Pruebas del PR, para que el revisor sepa que se ejecutó.
  • El usuario explícitamente no quiere una confirmación de documentación todavía.

El inventario: docs/DOCS.md

La lista de documentos dentro del ámbito vive en docs/DOCS.md, no en AGENTS.md, para que el contexto siempre activo no crezca con cada sincronización.

# Inventario de documentación

| Ruta | Propósito | Generado por |
|---|---|---|
| README.md | Propuesta, configuración, variables de entorno, diseño | |
| AGENTS.md | Reglas del agente + compuertas del proyecto | |
| packages/api/README.md | Endpoints, scripts, variables de entorno | |
| docs/api/openapi.json | Referencia de API | `pnpm generate:openapi` |

## Congelado (nunca editado por una sincronización)
- docs/plans/

## Verificaciones de desviación
<!-- un grep por cada error que realmente haya ocurrido, con un comentario explicando por qué -->

Primera ejecución: constrúyelo. Busca README.md / AGENTS.md / CLAUDE.md raíz y por paquete, documentos de colaboradores, documentación de API (descripciones OpenAPI, llms.txt), directorios de habilidades y reglas, y referencias a variables de entorno (.env.example, esquemas de configuración). Anota qué posee cada uno.

Cada ejecución: un documento que encuentres y que no esté listado se añade, en la misma confirmación.

Procedimiento

  1. Auditar. Compara la rama con su base (git diff <base>...HEAD --stat), y enumera lo que cambió que un documento podría mencionar: rutas, nombres de paquetes, rutas de API, comandos y scripts, variables de entorno, APIs exportadas, comportamiento, convenciones.
  2. Verificar. Para cada documento en el inventario, comprueba cada afirmación concreta contra el código: cada archivo nombrado existe en esa ruta, cada comando existe en el manifiesto, cada variable de entorno se lee realmente, cada ruta y exportación existe como se describe. Lee el código; no confíes en la prosa, incluida la prosa que escribiste antes.
  3. Editar. Corrige la desviación. Describe lo que hace el código y nunca inventes comportamiento para que un documento se lea mejor. Si el código y el documento discrepan y no puedes determinar cuál está mal, márcalo en lugar de adivinar.
  4. Regenerar. Ejecuta cada comando de generación listado en el inventario. Nunca edites manualmente un documento generado.
  5. Ejecutar las verificaciones de desviación listadas en docs/DOCS.md. Cuando una sincronización encuentre un error que probablemente se repita (una ruta antigua, un comando renombrado), añade un grep para él con un comentario explicando por qué.
  6. Confirmar. Prepara los archivos por ruta, nunca git add -A. Haz una confirmación atómica, docs(<ámbito>): sincronizar <qué> con <cambio>, en la rama actual.
  7. Subir si la rama ya tiene un remoto (git pull --rebase primero). Nunca subas a main.

Reglas

  • Historial congelado: los diseños, planes y traspasos en docs/plans/ son instantáneas de lo que se decidió en ese momento. Aparecerán en los greps; eso es esperado, no es desviación. Nunca los edites en una sincronización.
  • Los spikes y prototipos se eliminan una vez que su dirección se envía o se descarta, no se mantienen como referencia. Las conclusiones de un spike son el texto menos fiable del repositorio una vez que la producción sabe más. Cualquier cosa que aún valga la pena saber se mueve a la documentación del código enviado.
  • Presupuesto de tamaño: las líneas de documentación cuentan para el presupuesto del PR. Si la sincronización empuja una fase más allá de las 500 líneas, entrégala como una fase solo de documentación encima de la pila (consulta stacked-prs).
  • Los archivos puntero se mantienen pequeños. Un CLAUDE.md o GEMINI.md que solo apunta a AGENTS.md debe mantenerse así. No copies contenido en él.

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

chukaofili/agent-plugins

Use when starting a feature, refactor or bug fix; when asked to plan, spec, design or debug something; when writing a plan or handoff document; when choosing, adopting or upgrading a dependency, framework or external API; or when starting work that will become its own branch. Covers propose-before-building, scoping work to the PR size budget, debugging discipline, reading current docs instead of trusting memory, and when and how to use a git worktree.

chukaofili/agent-plugins

Use when a change is likely to exceed ~300 changed lines, when work spans several commits or stages, when opening a pull request, when receiving or responding to review feedback on any pull request, or when rebasing or landing a stack of dependent PRs. Covers the PR size budget and what counts toward it, how to split and stack PRs, sequential stage-by-stage review, and how to handle review findings by verifying each one, then fixing it or pushing back.

chukaofili/agent-plugins

Use when executing an approved plan end to end without a human watching. Typical cues are "here's the plan, go", "work on this overnight", "run autonomously", "I'll be back in a few hours", or a long session started before a meeting. Covers what the agent may decide alone, the four checkpoints it must never pass, keeping work durable (commit and push often), delegating to subagents, and how to leave blockers so the work is reviewable when the human returns.

chukaofili/agent-plugins

Use when a change touches anything a user sees, such as components, pages, views, screens, styles, templates, dialogs, forms or copy, and before opening a PR for it. Covers driving the change in a real browser through every state, running a review sweep against the repo's design and framework guidelines, and capturing screenshots for the PR, including what to do when no browser is available.

Skills relacionados