Pular para conteúdo

Template — ADR

Escopo: backend e infraestrutura associada, conforme a governança; consumidores aparecem somente como atores externos.

Modelo editorial. Não representa uma decisão aprovada. Nome sugerido: adr-NNNN-titulo.md.

Identificação

Número, título, data, responsáveis e status: proposta, aceita, rejeitada, substituída ou depreciada. Vincular a aprovação efetiva; não marcar aceita por ter sido documentada.

Contexto e problema

Motivação, restrições, requisitos, evidências e escopo. Separar fatos, contexto do owner e hipóteses.

Alternativas

Opções realmente consideradas, benefícios, custos e limitações relevantes. Evitar alternativas artificiais para justificar a decisão.

Decisão

Escolha, fundamento, alcance, ambiente e condições de aplicação. Distinguir experimento local, proposta e decisão corporativa aprovada, com fonte da aprovação; aprovação local não comprova adoção pelo TOTVS Apps. Identificar impactos em contratos, tenancy, dados, eventos e deployment.

Consequências e validação

Tradeoffs, riscos aceitos, migração/compatibilidade, rollback quando pertinente e como verificar resultados. Registrar itens ainda não implementados.

Referências e evolução

Código/commit, épico, PR, análises e ADRs relacionadas ou substituídas. Alterações posteriores preservam o histórico da decisão.