Pular para o conteúdo

5. Modelos · versão 2.0.0

Modelo — ADR (os seis arquivos)

manifesto/04-templates/01-template-adr.md

Copie para .specs/adr/NNN-slug-em-portugues/ (numeração sequencial global, kebab-case; o número vem da reserva do Gestor ou, sem ele, do maior + 1 — com o Gestor, o MCP entrega estes seis esqueletos já preenchidos). Os seis arquivos são obrigatórios, sempre — entregar os artefatos é o que torna o trabalho revisável. Detalhe de cada um em Os seis arquivos. Cada seção segue obrigatório + recomendado + flexível: o obrigatório sempre existe; o resto entra quando ajuda. Um exemplo preenchido está em ADR de exemplo (000).

.specs/adr/NNN-slug/
├── 001-executive.md
├── 002-resources.md
├── 003-plan.md
├── 004-tasks.md
├── 005-relatorio-tecnico.md
├── 006-relatorio-executivo.md
├── resources/ ← só quando há anexos
└── pdf/ ← gerado no fechamento (pnpm adr:pdf NNN-slug)

001-executive.md

# 001 — Executive · [Título]
**Status:** Em planejamento | Em execução | Concluído
**Aprovado por / em:** [Nome (papel)] — [AAAA-MM-DD]
---
## Decisões executivas
[O quê e por quê, em linguagem de negócio. Pouco ou nenhum tecniquês.]
## Escopo
**Entra agora**
- …
**Pode adiar**
- …
**Fica de fora**
- …
## Prazos
| Marco | Esperado | Real |
|-------|----------|------|
| Plano aprovado | AAAA-MM-DD | — |
| Entrega | AAAA-MM-DD | — |
## Recursos a implementar (recomendado)
- …
## Objetivos / KPIs (recomendado)
- …
## Módulos / áreas afetados (recomendado)
- … (link para .specs/stack/ quando aplicável)
## Referências e links
- … (anexos: ver 002-resources.md)

O status da ADR vive apenas aqui. Uma ADR que substitui outra diz qual, e onde.


002-resources.md

# 002 — Resources · [Título]
Curadoria dos materiais de apoio. Cada item: o que é e por que importa.
| Recurso | O que é | Por que importa |
|---------|---------|-----------------|
| `resources/arquivo.png` | … | … |
| [Link externo](https://…) | … | não versionado por ser vivo |
## Observações
- Versionar é caso a caso (link × arquivo). Dados sensíveis: anonimizar ou referenciar.

Se não há recursos, o arquivo existe assim mesmo e declara: “Sem recursos para esta ADR.” A pasta resources/ só nasce quando há material.


003-plan.md

# 003 — Plan · [Título]
**Data:** AAAA-MM-DD
## Contexto
[Por que esta decisão precisa ser tomada; forças em jogo.]
## Decisão
[O que será feito, em termos técnicos.]
## Consequências
[O que muda no sistema; padrões novos; custos.]
---
## Tarefas
- **T1** — …
- **T2** — …
---
## Quiz de decisões
> `( )` avaliada · `(X)` escolhida. As descartadas permanecem (memória técnica), com o
> certo × errado **enfático** para não confundir a IA em sessões futuras.
### Tema: [Banco / API / Frontend / Design / Testes / …]
**P1. [pergunta]?**
- (X) A) [opção escolhida] ✅ — [por quê]
- ( ) B) [opção avaliada] ❌ **rejeitada**: [motivo]
Justificativa: …
---
## Pós-plan (flexível)
**Riscos:** …
**Dependências:** …
**Fora de escopo:** …
**Critério de aceite:** … (inclui `pnpm lint`, `pnpm typecheck`, `pnpm test` e `pnpm build` verdes)

Não há número fixo de perguntas — quantas fizerem sentido, com um piso razoável.


004-tasks.md

# 004 — Tasks · [Título]
Execução viva. Status: `todo` / `doing` / `done` / `blocked`. O histórico detalhado vem do git.
O passo que também é uma tarefa do Gestor leva o identificador ao lado (`… (KBP-12)`).
## Passos
| # | Passo | Status |
|---|-------|--------|
| T1 | … | todo |
## Bibliotecas instaladas (nome · versão · porquê)
| Lib | Versão | Porquê |
|-----|--------|--------|
| … | … | … |
## Decisões e contradições em execução
- [Desvios do plano, documentados.]
## Estratégia da IA
- [Agente único / subagentes / agentes exploradores / paralelismo em massa, por tarefa.]
## Plan mode durante a execução
- [Perguntas e respostas surgidas na execução ficam AQUI, não voltam ao 003.]

005-relatorio-tecnico.md

# 005 — Relatório Técnico · [Título]
Redigido pela IA ao finalizar. O PDF é gerado por script (pnpm adr:pdf NNN-slug).
## Resumo da entrega
…
## Commits
| Hash | Mensagem |
|------|----------|
| `…` | feat(…): … |
## Testes automatizados criados
- …
## Smoke tests
- … (pronto para rodar)
## Arquivos tocados (e por quê)
| Arquivo | Por quê |
|---------|---------|
| … | … |
## Tarefas no Gestor
| Tarefa | Título | Papel |
|--------|--------|-------|
| `KBP-12` | … | implementa |
[Copiadas do Gestor no fechamento; "Nenhuma" quando a ADR não teve tarefa vinculada.]
## Bibliotecas
- [Dependências novas ou atualizadas, com a versão e o motivo; "nenhuma" quando não houver.]
## Decisões
- [Decisões tomadas na execução e desvios do 003, com o porquê.]
## Validações
`pnpm lint` ✅ · `pnpm typecheck` ✅ · `pnpm test` ✅ · `pnpm build` ✅ · smoke ✅

006-relatorio-executivo.md

# 006 — Relatório Executivo · [Título]
Resumo humano. **Zero técnico.** Não inclui status de prazo (isso vive no 001 e no 004).
## Entregue
[O que passou a existir, em linguagem de gestor.]
## Impacto
[Para o negócio ou a equipe.]
## Próximos passos
[O que pode vir depois.]

Fechamento

IA escreve 005 → escreve 006 → marca o 001 como Concluído (com os prazos reais)
→ atualiza o 004 e a linha do índice → roda pnpm adr:pdf NNN-slug → commita tudo
→ com o Gestor, move a tarefa para Revisão (com o comentário interno)
→ avisa "PDFs prontos para envio" (o envio por outro canal é opcional e manual).

ADR concluída é imutável. Mudanças futuras abrem uma nova ADR que referencia a anterior.