Architecture Decision Record

Active theme: Light

← documentos

Sugestões para escrever bons ADRs

Características de um bom ADR:

  • Justificativa: explique os motivos para tomar o AD em questão. Isso pode incluir o contexto (veja abaixo), prós e contras de várias escolhas potenciais, comparações de recursos, discussões de custo/benefício e mais.

  • Específico: cada ADR deve tratar de um AD, não de vários ADs.

  • Carimbos de data e hora: identifique quando cada item do ADR foi escrito. Isso é especialmente importante para aspectos que podem mudar com o tempo, como custos, cronogramas, escalabilidade e similares.

  • Imutável: não altere informações existentes em um ADR. Em vez disso, emende o ADR adicionando novas informações ou substitua o ADR criando um novo ADR.

Características de uma boa seção “Contexto” em um ADR:

  • Explique a situação da sua organização e as prioridades de negócio.

  • Inclua justificativas e considerações baseadas na composição social e de habilidades das suas equipes.

  • Inclua prós e contras relevantes e descreva-os em termos alinhados às suas necessidades e objetivos.

Características de uma boa seção “Consequências” em um ADR:

  • Explique o que decorre de tomar a decisão. Isso pode incluir efeitos, resultados, saídas, desdobramentos e mais.

  • Inclua informações sobre quaisquer ADRs subsequentes. É relativamente comum um ADR desencadear a necessidade de mais ADRs, como quando um ADR faz uma grande escolha abrangente, o que por sua vez cria necessidade de mais decisões menores.

  • Inclua quaisquer processos de revisão pós-ação. É típico as equipes revisarem cada ADR um mês depois, para comparar as informações do ADR com o que aconteceu na prática, a fim de aprender e crescer.

Um novo ADR pode tomar o lugar de um ADR anterior:

  • Quando um AD é tomado e substitui ou invalida um ADR anterior, deve-se criar um novo ADR