Ir para o conteúdo

1. Registrar Decisões de Arquitetura

Date: 2023-10-27

Status

Aceito

Contexto

Precisamos de uma maneira de documentar decisões de arquitetura importantes, o contexto por trás delas e suas consequências. Isso é crucial para a manutenção a longo prazo e para alinhar a equipe, especialmente novos membros.

Decisão

Adotaremos o uso de "Architectural Decision Records" (ADRs), que são documentos curtos em Markdown, cada um descrevendo uma decisão. Eles serão armazenados em docs/developer/adr.

Consequências

Positivas:

  • Clareza sobre o "porquê" das escolhas técnicas.
  • Facilita o onboarding de novos desenvolvedores.
  • Cria um histórico de decisões que pode ser consultado no futuro.

Negativas:

  • Exige disciplina da equipe para criar e manter os ADRs atualizados.