Pular para o conteúdo

Anti-patterns de ADR

English · Início da documentação · Anterior

“Adotar Redis” não basta. Descreva primeiro o problema de latência, consistência, carga ou operação e mostre como a ferramenta se encaixa.

Um registro relevante que nunca considera o estado atual ou uma alternativa viável esconde o trade-off. Use Extended ou MADR quando a comparação explícita melhorar a revisão.

Benefícios sem custos parecem propaganda. Inclua complexidade, migração, operação, modos de falha, dependência e competências necessárias.

Marcar um rascunho como Accepted antes da revisão transforma status em uma afirmação sem governança. new e draft assistido por IA produzem Proposed intencionalmente; aceitar é ação humana.

Editar uma ADR aceita para descrever sua substituta apaga o que era verdade. Crie uma nova ADR e substitua a anterior com relacionamento explícito.

Deixar [EDITAR], análises vazias ou texto genérico cria aparência de documentação sem conhecimento. Remova instruções, escreva conteúdo específico e use um template menor se as seções não agregarem valor.

Um registro sobre armazenamento, autenticação, implantação e observabilidade fica difícil de revisar e substituir. Separe escolhas que evoluem independentemente e relacione-as quando o contexto se sobrepuser.

Um adr-guard check limpo prova apenas que regras estruturais determinísticas passaram. Não prova que a escolha é segura, viável, econômica, implementada ou aceita.

Uma ADR registra a melhor decisão para um contexto. Observe premissas e substitua a decisão quando o contexto mudar; preserve o histórico em vez de tratá-la como política imutável.