Architecture Decision Record

Active theme: Light

← documentos

Sugerencias para escribir buenos ADR

Características de un buen ADR:

  • Justificación (Rationale): explique las razones para tomar esa AD en particular. Puede incluir el contexto (véase más abajo), las ventajas y desventajas de las distintas opciones posibles, comparaciones de funcionalidades, análisis de costo-beneficio y más.

  • Específico (Specific): cada ADR debe tratar sobre una sola AD, no sobre varias.

  • Marcas de tiempo (Timestamps): indique cuándo se escribió cada elemento del ADR. Esto es especialmente importante para los aspectos que pueden cambiar con el tiempo, como costos, calendarios, escalado y similares.

  • Inmutable (Immutable): no modifique la información existente en un ADR. En su lugar, enmiende el ADR añadiendo información nueva, o sustitúyalo creando un nuevo ADR.

Características de una buena sección de «Contexto» en un ADR:

  • Explique la situación y las prioridades de negocio de su organización.

  • Incluya justificaciones y consideraciones basadas en la composición social y de habilidades de sus equipos.

  • Incluya ventajas y desventajas pertinentes, y descríbalas en términos que se alineen con sus necesidades y objetivos.

Características de una buena sección de «Consecuencias» en un ADR:

  • Explique lo que se deriva de tomar la decisión. Esto puede incluir efectos, resultados, productos, seguimientos y más.

  • Incluya información sobre cualquier ADR posterior. Es relativamente común que un ADR genere la necesidad de más ADR, por ejemplo, cuando un ADR toma una gran decisión general que a su vez crea la necesidad de decisiones menores.

  • Incluya los procesos de revisión posterior a la acción. Es habitual que los equipos revisen cada ADR un mes después, para comparar la información del ADR con lo ocurrido en la práctica y así aprender y mejorar.

Un nuevo ADR puede sustituir a un ADR anterior:

  • Cuando se toma una AD que reemplaza o invalida un ADR anterior, debe crearse un nuevo ADR