CommunityRedacción y edicióngithub.com

NOC Living Docs

Protocolo de documentación viva y skill para Codex que mantiene sincronizados los cambios de código asistidos por IA con requisitos, estado, salvaguardas, pruebas y registros de cambios.

¿Qué es NOC Living Docs?

Este skill implementa el protocolo NOC Living Docs, que convierte la documentación del proyecto en una memoria ejecutable para asistentes de IA como Claude Code, Cursor y Codex. Su propósito es mantener sincronizados los cambios de código con los requisitos acordados, el estado actual, las salvaguardas, los registros de pruebas y el historial de cambios. El skill detecta automáticamente qué módulos o funcionalidades se ven afectados mediante un mapa de características (feature-map.json), guía al agente para leer solo los documentos relevantes de la carpeta `noc_docs/`, y verifica la consistencia entre código y documentación antes de cada commit usando scripts CLI como `noc.py check`. Está diseñado para flujos de trabajo donde la IA colabora con desarrolladores humanos, asegurando que la documentación refleje fielmente el comportamiento real del código y que los cambios no introduzcan conflictos no resueltos o requisitos ambiguos.

Compatible con~Claude Code✓Codex CLI~Cursor
npx skills add SmallNoc/noc-living-docs

Installed? Explore more Redacción y edición skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

Preguntar en tu IA favorita

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

Documentación

Documentación Viva del Proyecto

Usa NOC Living Docs como memoria ejecutable del proyecto. Enruta a través de noc_docs/, lee solo los documentos afectados, actualiza la documentación viva cuando el código o la intención cambien, y luego verifica con la CLI.

Disparador

Usa este skill para:

  • inicializar o migrar noc_docs/
  • discutir un requisito y luego cambiar código
  • nuevas funcionalidades, correcciones de errores, refactorizaciones, cambios de API/datos/seguridad/despliegue
  • comprobar si los cambios de código necesitan actualizaciones de documentación
  • consultar o auditar la documentación viva del proyecto

No lo uses para preguntas generales que no involucren memoria del proyecto, comportamiento del código, requisitos, salvaguardas, pruebas o documentación NOC.

Ejecución

  1. Identifica la funcionalidad/dominio afectado a partir de la solicitud, las rutas modificadas y noc_docs/.living-docs/feature-map.json.
  2. Ejecuta un plan de trabajo cuando el código pueda cambiar:
python scripts/noc.py work /path/to/project --feature <feature> --intent "<requisito acordado>"

Usa --path <code/path> cuando las rutas sean más claras que los nombres de funcionalidades.

  1. Lee los documentos relevantes más pequeños: agent-guide.md, requirements.md, status.md, guardrails.md, test-record.md, más las salvaguardas de dominio si están presentes.
  2. Escribe la intención nueva/cambiada confirmada en requirements.md; coloca discusiones inciertas en notes.md.
  3. Cambia el código.
  4. Actualiza status.md, test-record.md, change-record.md y guardrails.md cuando el comportamiento, la verificación, los cambios importantes o las restricciones hayan cambiado.
  5. Ejecuta python scripts/noc.py index <project> después de cambios en documentos, funcionalidades o asignaciones.
  6. Ejecuta python scripts/noc.py check <project> --staged --warn-only antes del commit cuando Git esté disponible.

Para reglas detalladas del flujo de trabajo, lee references/workflow.md.

No Continuar

Detente y pregunta al usuario antes de editar código cuando:

  • la solicitud entre en conflicto con guardrails.md o las salvaguardas de dominio
  • la intención del producto entre en conflicto con requirements.md y la dirección deseada no está clara
  • no se puede identificar la funcionalidad/dominio afectado y el cambio no es obviamente global
  • faltan documentos requeridos y la tarea depende de requisitos o restricciones desconocidas
  • el usuario pide reescribir silenciosamente los requisitos para que coincidan con el código actual
  • el cambio afecta seguridad, permisos, facturación, pérdida de datos, migraciones o contratos de API pública y el comportamiento solicitado es ambiguo

Definición de Hecho

Una tarea que usa este skill se considera completa solo cuando:

  • los documentos afectados fueron identificados a través del mapa de funcionalidades, rutas o nombre explícito de funcionalidad
  • los documentos requeridos fueron leídos o se señaló la falta de documentos
  • los cambios de código y de documentación coinciden
  • requirements.md cambió solo por cambios de comportamiento intencionados
  • status.md refleja el comportamiento actual después de los cambios de código
  • test-record.md registra la verificación o explica por qué no se ejecutó la verificación
  • change-record.md registra cambios importantes de implementación
  • los índices/verificaciones se ejecutaron cuando estaban disponibles, o se omitieron con justificación

Formato de Respuesta Final

Termina con:

NOC Living Docs:
- docs verificados:
- docs actualizados:
- docs intencionalmente sin cambios:
- comandos ejecutados:
- pruebas ejecutadas:
- riesgos restantes:

Mantén las listas cortas. Usa ninguno cuando una categoría no aplica.

Referencias

  • references/workflow.md: selección de modo, reglas de respaldo, manejo de conflictos, ciclo de trabajo
  • references/feature-doc-template.md: qué debe contener cada documento de funcionalidad
  • references/domain-mode-guide.md: cuándo y cómo usar el modo de dominio
  • references/codex-prompts.md: indicaciones de usuario recomendadas para flujos de plan/objetivo/código de Codex

Skills relacionados