Documentación de DIXI Spec Kit English · Código en GitHub

/dixi.onboard

Propósito

Incorporar un código existente a DIXI: borradores de módulos, features y trazabilidad a partir del código.

Adoptar un proyecto existente: leer el código de las raíces indicadas en $ARGUMENTS y proponer dominios, módulos y features como borradores que valida la persona, con evidencia para cada afirmación. Solo documentación; el código no cambia.

Generada por scripts/build-command-reference.py a partir del texto empaquetado del comando; no la edites a mano.

Invocación

Argumento: [raíces de código a leer, por ejemplo src/ app/]. Los signos de menor y mayor marcan un valor obligatorio y los corchetes uno opcional. En los pasos, $ARGUMENTS es el texto escrito después del comando.

Ejemplo

El texto después del comando es la petición; cámbialo para que corresponda a tu proyecto.

Cuándo usarlo

Pasos

  1. Lee 00-governance/principles.md, 00-master-spec.md, .dixi/traceability.json, el README, los manifiestos de build o de paquetes y las pruebas. Mapea las raíces de código, los puntos de entrada (rutas, comandos, handlers, jobs), los almacenes de datos y las integraciones externas, citando file:line en cada uno.
  2. Propón una división en dominios y módulos, y las features que expone cada módulo, en una tabla con la evidencia de cada línea. Marca los límites dudosos. Detente aquí y pide a la persona que valide o corrija la división; no escribas specs antes de esa respuesta.
  3. Tras la validación, escribe un borrador por módulo en 04-modules/<módulo>/module-spec.md y por feature en 05-features/<slug>/feature-spec.md, cada uno empezando por Status: draft (onboarded from code). Describe el comportamiento observable con evidencia file:line; escribe criterios de aceptación solo para el comportamiento que muestran el código o sus pruebas, y {{pending: …}} para la intención, las reglas y todo lo que el código no puede probar.
  4. Registra los dominios, módulos y features nuevos en .dixi/traceability.json con sus padres. No registres pruebas como cobertura de un criterio salvo que la prueba lo compruebe.
  5. Conserva las specs y los IDs existentes; nunca sobrescribas un documento que escribió la persona. Informa de los conflictos.
  6. Sugiere /dixi.constitution si no hay principios, /dixi.clarify para la intención pendiente y /dixi.converge por feature para convertir los huecos en tareas.

Archivos que lee y escribe

Rutas que nombra el texto del comando:

Paradas y controles humanos

Cierre

Ejecuta dixi check antes de terminar e informa: archivos tocados, módulos y features en borrador, marcas pendientes, comprobaciones (ejecutadas, fallidas, no ejecutadas), pendientes y el siguiente comando sugerido.

Siguiente paso

Relacionado