Registro de decisão de arquitetura
Um registro de decisão de arquitetura (ADR) é uma das entregas mais importantes de um arquiteto de soluções. Esse registro documenta as decisões de arquitetura que você toma durante todo o processo de design. Ele também fornece justificativas e implicações específicas do contexto para cada decisão.
O ADR documenta todas as decisões importantes, incluindo alternativas que você descartou, para requisitos arquitetonicamente significativos. O log incorpora requisitos e restrições nos efeitos documentados de uma decisão.
Implementar uma ADR
Inicie o ADR no início de uma carga de trabalho e mantenha-o durante toda a vida útil da carga de trabalho. Uma ADR deve ser iniciada para cargas de trabalho brownfield e, se os dados estiverem disponíveis, ela deve ser gerada retroativamente com base em decisões passadas conhecidas. O ADR serve como um log somente de acréscimo. Esse registro se estende além do design inicial para incluir aspectos de design em relação a requisitos funcionais e não funcionais futuros.
Características sugeridas de um registro individual
Seja consistente com a anatomia de cada registro. Crie um modelo de registro e siga-o de forma consistente.
Um registro deve incluir elementos consistentes, como:
- Declaração do problema com contexto
- Opções consideradas
- Resultado da decisão
- Inclua compensações importantes feitas com essa decisão
- Registre o nível de confiança da decisão. Às vezes, uma decisão arquitetonicamente significativa é tomada com confiança relativamente baixa. Documentar esse status de baixa confiança pode ser útil para futuras decisões de reconsideração.
Divida uma decisão em várias se uma decisão de arquitetura resultar em várias fases, como abordagens de curto, médio e longo prazo. Registre cada fase como seu próprio registro de decisão.
Evite esconder as consequências das decisões intencionalmente ou acidentalmente.
Mantenha registros concisos, assertivos, sobre o tópico e factuais.
Evite fazer guias de design de registros de decisão. Se houver mais justificativa ou concepção de design disponível, forneça um link para um documento como material suplementar, mas a decisão deve ser clara e independente sem esse material.
Repositório de documentação da carga de trabalho
Esse log deve estar prontamente disponível e armazenado abertamente com a documentação da carga de trabalho.
Um arquiteto pode ajudar uma equipe de carga de trabalho a obter recomendações de Excelência Operacional, ajudando a estabelecer e manter um repositório de documentos e ativos. Os arquitetos ajudam as equipes a colocar todos os seus ativos no repositório, como este log de decisão. Eles também incentivam a adoção unificada das equipes de uma única fonte de verdade a ser usada para referência, auditorias e resposta a incidentes.
Próximas etapas
Mais recursos
Para obter exemplos de modelo, visite a organização GitHub de Registros de Decisão Arquitetônica.