Ir al contenido

Dar forma a tu Framework

Elegiste una semilla porque era la más cercana. En algún momento deja de encajar, y eso es lo esperado: un Framework (el marco) puede remodelar cualquier parte sin bifurcar el estándar.

Cada cambio es una edición de .eidos/Framework.yaml y de los templates (plantillas) que hay al lado. eidos configure:<noun> hace cada uno desde la terminal, mostrando primero su plan y reescribiendo cada Blueprint (plano) y enlace al que llega el cambio; el Framework Settings del navegador hace lo mismo como formularios. Comandos →

Lo que cambias Lo que nunca tocas
Una colección, carpeta, grupo, variant (variante), propiedad, término, documento o rol La prosa de un Blueprint
El índice generado
properties.core: del estándar, reescrito por migrate
La convención de nombres, una vez existen archivos
Ventana de terminal
eidos configure:collection add decisions --description "Architecture decision records." --grouping Areas

Decide cuatro cosas: su nombre, una descripción de una línea, sus variants (empieza con una) y si agrupa sus Blueprints a un nivel de profundidad.

Ventana de terminal
eidos configure:variant add specs api --from micro

Normalmente la respuesta correcta cuando los Blueprints de una colección varían. Una familia de templates por colección: lo que cambia es qué secciones aparecen, nunca su orden ni sus nombres. «Las specs de integración tienen cinco secciones distintas» no es una variant; es una colección distinta, o una señal de que las secciones deberían ser opcionales en un solo template.

Dos patrones que funcionan: ligero → completo (micro crece hacia full, conservando intención, criterios y non-goals) y una alternativa deliberada de igual peso para un tipo distinto de unidad en la misma colección.

Un grupo cuyos Blueprints toman casi todos una misma variant puede decirlo, y un Blueprint nuevo ahí empieza por ella antes que por la predeterminada de la colección:

Ventana de terminal
eidos configure:group set specs ideas --default-variant micro
Ventana de terminal
eidos configure:property add tier --type Text --applies-to specs --options Core,Extended --meaning "How central the unit is."

Decide todo: nombre, tipo, a qué aplica, si es requerida y significado, y opciones cuando el valor es uno de un conjunto que controlas. Opta por opcional por defecto: una propiedad requerida se rellena en blanco en cada Blueprint al que aplica y se informa hasta que se completa.

Antes de añadir una, comprueba tres cosas:

  • ¿Sería mejor una sección del cuerpo? Si quiere más estructura que uno de los seis tipos, sí. La lista de tipos es corta para forzar esta pregunta.
  • ¿Es una etiqueta blanda o estructural? Una categoría que rige vistas es una etiqueta. Una que cambia qué secciones tiene un Blueprint es una variant.
  • ¿Es seguimiento de trabajo disfrazado? sprint, estimate, assignee y cualquier cosa que signifique «por dónde vas»: progress, phase, target_date. Enlaza con tu gestor de tareas en su lugar.
Ventana de terminal
eidos configure:property remove depends_on

La mitad descuidada. Si una propiedad ha estado en blanco en los últimos veinte Blueprints, no es parte de tu contrato. El plan muestra cada valor que se perdería antes de quitar la entrada y las claves; nada se descarta en silencio.

Los archivos de rol están en commit y el equipo los ajusta: edítalos directamente, o añade uno nuevo con eidos configure:role add. Los repartos de las semillas son ilustraciones, no un conjunto fijo. Roles →

Todo lo que hay en la raíz está declarado. Una carpeta o archivo que el documento del Framework no lista lo informa eidos check hasta que lo declares (configure:folder add, configure:doc add) o lo muevas.

No se permite agrupar a más de un nivel. Si buscas un tercer nivel, lo que quieres es otra colección.

Cuando el tuyo se haya asentado, es forma sin contenido, que es exactamente lo que le entregas a otro equipo. Si dos productos de tu organización deberían describirse igual, publica el Framework en lugar de copiar una raíz y borrar su contenido. Un Framework, cualquier número de raíces. El Registro →