Skip to content
CodArchthe living map of the architecture
ESEN

ADR 0035 — La guía se lee como un changelog

This content is not available in your language yet.

Estado: aceptado · Fecha: 2026-10-22

La guía (apps/site/docs/guideline/entradas/) guarda lo que se piensa y lo que se hace, día a día. Cada entrada dice qué se decidió —su veredicto: fase, arreglo, esperar— pero no dice qué clase de trabajo es.

Se nota al leer un día entero: el 22 de octubre tenía seis entradas, todas «fase», y entre ellas había dos features, dos de documentos y dos de mantenimiento. El día las pintaba seguidas y el lector no veía la diferencia.

Los changelogs llevan años resolviendo esto (Keep a Changelog, los commits convencionales): secciones por clase de cambio, y cada día pinta solo las que tienen algo. Es el formato que la guía ya insinúa con sus veredictos pero no dice.

La línea de metadatos pasa a decir las dos cosas:

## La web del proyecto
*feature · fase · 2026-10-22*
  • Categoría: qué clase de trabajo es (feature, docs, fix…).
  • Veredicto: qué se decidió (fase, arreglo, esperar, idea), como hasta ahora.

2. Un set cerrado de categorías, el de los changelogs

Sección titulada «2. Un set cerrado de categorías, el de los changelogs»
CategoríaQué es
featurealgo nuevo: una capacidad que antes no estaba
fixun arreglo: algo que prometía y no cumplía
optimizedlo mismo, más rápido o más barato
refactorlo mismo, mejor por dentro
docsdocumentación: lo que se lee, no lo que se ejecuta
choremantenimiento: versiones, repo, herramientas
securityseguridad: permisos, secretos, dependencias
removedquitar algo que ya no se sostiene

Es un set cerrado: una entrada nueva elige de aquí, no inventa. No todas se usan todos los días, y el día pinta solo las que tienen algo, siempre en ese orden.

La web pinta cada día con un grupo por categoría: su nombre, su cuenta y sus entradas. Un grupo vacío no se pinta. Las entradas de un grupo guardan el orden en que se escribieron.

Las que esperan (veredicto esperar) siguen yendo a la sección Futuro, con su categoría a la vista y sin grupos: son una lista de lo que falta, no el changelog de un día.

La categoría vive en la entrada (apps/site/docs/guideline/entradas/), no en los componentes: la web agrupa, no reescribe. Una entrada se declara, no se deduce: el veredicto fase no dice si fue feature o docs.

Los nombres de las categorías van en inglés técnico, como los commits (feat:, fix:); la web los muestra con su nombre corto y la descripción de cada uno va en español.

  • Un día se lee igual siempre: novedades arriba, luego arreglos, luego lo demás.
  • Se ve de un vistazo qué clase de día fue: el 22 de octubre fue de novedades, docs y mantenimiento.
  • Una entrada nueva necesita categoría y veredicto: dos decisiones pequeñas al escribirla.
  • El checksum no cambia: es documentación (la regla de ADR 0029 sigue intacta).
  • Solo Keep a Changelog: Added, Changed, Fixed… como único eje pierde el veredicto, que es lo que dice si la idea es fase o espera.
  • Etiquetas libres: cada día inventaría sus grupos y la guía dejaría de ser estándar, que es justo lo que se busca.
  • Deducir la categoría del veredicto: fase no distingue feature de docs; arreglo y fix se solapan y el resto no tiene equivalente.
  • Grupos en el cuerpo del markdown: serían tres verdades —el día, el grupo y el orden— donde basta una.

Sin fases abiertas: M23 está cerrada.

El idioma del producto es español; este ADR lo sigue. Las claves de las categorías van en inglés técnico, como los commits.