Desenvolvimento
Modelo de decisão de arquitetura (ADR)
Dentro de seis meses, alguém vai perguntar por que o sistema funciona do jeito que funciona. Um registro de decisão de arquitetura responde isso em uma ou duas páginas. Este modelo cobre o contexto, as opções avaliadas, a decisão, as consequências, o trabalho de acompanhamento e as condições para uma revisão.
Abrir este modelo no editor- Categoria
- Desenvolvimento
- Estilo padrão
- Técnico
Quando usar
Escreva um ADR quando uma escolha técnica for cara de reverter: um banco de dados, um framework, um modelo de hospedagem, um estilo de API. Futuros responsáveis pela manutenção, novos integrantes do time e revisores leem para entender as restrições que você enfrentou na época. Escreva enquanto a discussão está fresca e mantenha a linha de status atualizada conforme a proposta avança.
O que tem dentro
- Um título numerado do ADR com campos para preencher projeto, autor e data, e uma linha de status.
- Uma tabela de opções comparando benefícios e custos, incluindo uma linha para manter a abordagem atual.
- Decisão, consequências positivas e negativas, uma lista de verificação de implementação e um gatilho de revisão.
Dicas para um documento melhor
- Declare a decisão em uma frase e dê o motivo mais forte. Se precisar de cinco motivos, a seção de contexto provavelmente precisa de mais trabalho.
- Seja honesto nas consequências negativas. Se um diagrama explica a mudança melhor que o texto, adicione um bloco Mermaid e ele será renderizado no PDF.
Pré-visualização do modelo
ADR-001: Projeto ou tema
Autor: Seu nome · Data: Data
Status: Proposta
Contexto
Descreva o problema, as restrições e as forças que moldam esta decisão.
Opções consideradas
| Opção | Benefícios | Custos |
|---|---|---|
| Opção A | Principal vantagem | Principal contrapartida |
| Opção B | Principal vantagem | Principal contrapartida |
| Manter a abordagem atual | Sem migração | Limitação existente |
Decisão
Declare a abordagem escolhida e o motivo mais importante para essa escolha.
Consequências
Positivas: O que fica mais fácil.
Negativas: O que fica mais difícil ou mais caro.
Implementação
- Definir um responsável
- Planejar migração e reversão
- Atualizar a documentação
Gatilho de revisão
Especifique qual evidência ou mudança levaria a rever esta decisão.
Os campos de preenchimento, como seu nome e a data, são substituídos quando você abre o modelo no editor.