Saltar a contenido

Documentos del proyecto

Dentro de .n45/docs/ encontrarás cuatro archivos generados por N45 para describir tu proyecto. Estos son la base que todo workflow lee antes de hacer cualquier cosa: clasificación, discovery, spec, ejecución, validación — todos ellos.

Los cuatro documentos

STACK.md

El inventario técnico.

  • Lenguaje y versión del runtime
  • Frameworks (web, ORM, tests, build)
  • Gestor de paquetes y lockfile
  • Salidas del build y dónde van

Actualizado cuando N45 detecta un cambio en tus archivos de dependencias o config.

PATTERNS.md

Las convenciones arquitecturales de tu codebase, extraídas leyendo el código real:

  • Convenciones de nombres de archivo
  • Patrones de import
  • Capas (ej: handlers / services / repositories)
  • Estilo de manejo de errores
  • Convenciones de test
  • Patrones de logging y observabilidad

Este es el documento que te protege de que N45 genere código que "funciona" pero rompe tus convenciones.

PROJECT.md

La visión de alto nivel:

  • Resumen del dominio
  • Módulos y sus responsabilidades
  • Entry points públicos (rutas, comandos CLI, APIs exportadas)
  • Dependencias externas (bases de datos, servicios, APIs)

RUNBOOK.md

Cómo operar el proyecto localmente:

  • Instalar dependencias
  • Iniciar el servidor de dev
  • Ejecutar tests
  • Setup de base de datos y migrations
  • Comandos comunes de debug
  • Pasos de deploy (si están disponibles)

/n45-status y otros workflows usan RUNBOOK para ofrecer acciones como "Ejecutar la app".

Cuándo se regeneran

Disparador Qué corre
Primera ejecución /n45 Los cuatro documentos generados desde cero
Tras completar un roadmap estructurado Documentos actualizados para reflejar la nueva arquitectura
/n45-status sin onboarding presente Regeneración completa

También puedes eliminar un documento y N45 lo regenerará en la siguiente ejecución.

Estos documentos son gestionados por N45

No los edites manualmente — N45 los actualiza conforme tu proyecto evoluciona y tus cambios serán sobrescritos. Para influir en lo que N45 genera, trabaja a través de los flujos estructurados (/n45-feat, /n45-fix) — los patrones registrados por N45 reflejan lo que tu código realmente hace, no lo que dice un archivo markdown.