Architecture Decision Records (ADRs) — AWaC
Cada decisión arquitectónica importante de AWaC queda documentada acá con su contexto, las opciones consideradas, y por qué se eligió esa. En 6 meses cuando alguien se pregunta “¿por qué hicimos esto así?”, la respuesta está versionada y es buscable.
Formato
Section titled “Formato”Cada ADR sigue el formato Michael Nygard:
## Título
## Status
Accepted | Superseded | Deprecated
## Context
La situación que motivó la decisión.
## Decision
Lo que decidimos hacer.
## Consequences
Los efectos esperados (positivos y negativos).Índice
Section titled “Índice”Cómo agregar un ADR
Section titled “Cómo agregar un ADR”- Identificá el siguiente número.
- Copiá el template en un archivo
<NNN>-<slug-corto>.md. - Llenalo con: contexto, decisión, opciones consideradas, consecuencias.
- Agregá la entry al índice de arriba.
- PR a
getGanemo/awac-docs.
Cuándo escribir un ADR
Section titled “Cuándo escribir un ADR”- Cualquier decisión que afecta a la arquitectura o al diseño del sistema (no a la implementación puntual).
- Cualquier decisión donde se consideraron múltiples opciones y elegir mal hubiera tenido consecuencias.
- Cualquier decisión que futuros engineers se preguntarían por qué.
NO escribir ADR para:
- Decisiones de implementación (cómo se llama una variable, qué library usar).
- Bugfixes triviales.
- Decisiones del día-a-día (qué task hacer primero).