66 lines
1.7 KiB
Text
66 lines
1.7 KiB
Text
---
|
||
type: template
|
||
name: adr
|
||
description: Template canônico para Architecture Decision Records (ADRs)
|
||
updatedAt: "2026-09-02"
|
||
---
|
||
|
||
<!--
|
||
DESTINO CANÔNICO NO PROJETO:
|
||
- Wiki de Desenvolvimento (Pilar 4): <modulo-wiki>/dev/<modulo-id>/adrs/{numero}-{titulo-kebab-case}.md
|
||
(onde <modulo-wiki> e <modulo-id> são extraídos de memorias-ia/modulo.yml; fallback de wiki: ../wiki)
|
||
|
||
EXEMPLO:
|
||
<modulo-wiki>/dev/<modulo-id>/adrs/001-adopcao-bullmq-processamento-noturno.md
|
||
-->
|
||
|
||
# ADR [NUMERO]: [TÍTULO DA DECISÃO ARQUITETURAL]
|
||
|
||
- **Status:** Proposta | Aceita | Rejeitada | Descontinuada | Substituída por ADR-XXX
|
||
- **Data:** `<AAAA-MM-DD>`
|
||
- **Decisores / Autores:** `<Nomes dos arquitetos / devs>`
|
||
- **Módulo(s) Impactado(s):** `<modulo-id>`
|
||
|
||
---
|
||
|
||
## 1. Contexto e Problemática
|
||
<Qual é o cenário atual? Qual limitação, gargalo, requisito ou dívida técnica força a necessidade de uma decisão?>
|
||
|
||
---
|
||
|
||
## 2. Decisão Técnica
|
||
<O que decidimos fazer de forma clara e objetiva? Qual biblioteca, arquitetura, padrão de projeto ou contrato será implementado?>
|
||
|
||
---
|
||
|
||
## 3. Alternativas Consideradas
|
||
|
||
| Alternativa | Prós | Contras | Motivo do Descarte |
|
||
| :--- | :--- | :--- | :--- |
|
||
| **Opção A** | [...] | [...] | [...] |
|
||
| **Opção B** | [...] | [...] | [...] |
|
||
|
||
---
|
||
|
||
## 4. Consequências e Trade-offs
|
||
|
||
### Positivas ✅
|
||
- [...]
|
||
|
||
### Negativas / Riscos Mitigados ⚠️
|
||
- [...]
|
||
|
||
### Neutras ℹ️
|
||
- [...]
|
||
|
||
---
|
||
|
||
## 5. Impacto na Estrutura e Monorepo
|
||
- **Pacotes Afetados:** `*-back`, `*-front`, `*-comuns`, `*-migracao`
|
||
- **Contratos de API / Schemas Zod:** [Sim/Não - Detalhar se houver breaking change]
|
||
- **Migrações de Banco Necessárias:** [Sim/Não]
|
||
|
||
---
|
||
|
||
## 6. Referências e Literatura Técnica
|
||
- [Padrão / RFC / Documentação oficial]: `<link ou citação>`
|