Regras de Validação de Artefatos (B)
O que é
Seção intitulada “O que é”Este documento define regras transversais de validação para artefatos do monorepo: cabeçalho YAML mínimo, ciclo de vida e obrigações de evidência — complementa a Convenção de nomenclatura.
Como usar
Seção intitulada “Como usar”- Valide antes de merge ou de mover artefatos para
08-publicado/. - Aplique as regras gerais a todos os PVs; use páginas de tipo (HNI, ADR, …) para campos extra.
- Histórias ESP: critérios de aceite mensuráveis; decisões: contexto + alternativas; evidências: vínculo ao artefato de origem.
Regras gerais:
- Todo artefato deve ter cabeçalho YAML com
id,tipo,status,autoredata. - Histórias (ESP) devem ter critérios de aceite mensuráveis.
- Decisões (ADR/DEC) devem registrar contexto, alternativas e justificativa.
- Evidências (EVD) devem vincular ao artefato de origem.
- Nenhum artefato pode ser publicado em
08-publicado/sem evidência de revisão.
Exemplo
Seção intitulada “Exemplo”---id: ESP-HNI-0001tipo: HNItitulo: "Título descritivo do artefato"status: rascunho # rascunho | refinado | aprovado | implementado | canceladoautor: fulano.de.taldata: 2026-04-11versao: "1.0"---Artefatos de decisão (ADR, RFC) exigem campos adicionais — ver ADR (GTI) e ADR (PDP).
Onde se aplica
Seção intitulada “Onde se aplica”| Destino | Link |
|---|---|
| Convenção de nomes | /artefatos/nomenclatura/ |
| Framework — convenções §11 | /framework/referencias/#11-convenção-de-nomenclatura-de-arquivos |
| Índice ESP | /artefatos/esp/ |
| Tipos de história | Páginas HNI, HNE, … no menu Artefatos do Projeto |
Status do ciclo de vida
Seção intitulada “Status do ciclo de vida”| Status | Quem move | Significado |
|---|---|---|
rascunho | Autor | Em elaboração — não revisado |
refinado | Time + PO | Revisado com o time — aguardando aprovação |
aprovado | PO ou GTI | Aprovado formalmente — pode ser consumido |
implementado | IMP | Consumido e implementado pelo ponto de vista correspondente |
cancelado | PO ou GTI | Descartado — mantido no repositório para registro histórico |