IMP — CHG: CHANGELOG & Release Notes (B)

O que é

Ponto de vista: IMP — Implementação · Documentos: CHG (changelog) e REL (release notes), tipicamente em IMP/07-referencias/ ou raiz acordada.

Segue o formato Keep a Changelog + SemVer. Toda versão publicada deve ter entrada no CHG. Histórias implementadas são vinculadas pelo seu id.

Como usar

Registe cada release com versão SemVer e ligação ao RDM quando existir roadmap formal.
Liste histórias e PRs com IDs ESP-* / IMP-* nas secções corretas (Adicionado, Corrigido, …).
Mantenha REL legível para negócio; CHG técnico pode ser mais denso.
Quando a versão incluir desvio controlado da especificação (mudanças sob pendência documental), referencie na entrada os IDs das notas de desvio, RFC ou IRA associados, além das histórias ESP, para o release manter rastreabilidade entre código entregue e documentação ainda em consolidação.

Exemplo

Entrada de CHANGELOG

## [1.2.0] — 2026-04-11

### Adicionado
- ESP-HNU-0001: Registro de solicitação de serviço
- ESP-HAI-0001: Autenticação gov.br nível Prata

### Corrigido
- ESP-HRD-0002: Regra de elegibilidade com renda per capita

### Segurança
- IMP-API-0001: Timeout de 5s em chamadas externas

Seções do CHANGELOG

Seção	Quando usar
`Adicionado`	Nova funcionalidade ou história implementada
`Modificado`	Mudança em funcionalidade existente
`Descontinuado`	Funcionalidade que será removida em versão futura
`Removido`	Funcionalidade removida definitivamente
`Corrigido`	Correção de defeito
`Segurança`	Correção de vulnerabilidade

Onde se aplica

Destino	Link
Framework IMP	/framework/imp/
Índice IMP	/artefatos/imp/
RDM (GTI)	/artefatos/gti/rdm/

REL — Release Notes

Documento público resumindo a versão entregue ao usuário final. Derivado do CHG, mas em linguagem de negócio.

---
id: IMP-REL-0001
tipo: REL
titulo: "Release Notes — v1.2.0"
status: publicado
autor: fulano.de.tal
data: 2026-04-11
versao: "1.2.0"
publico-alvo: usuario-final
---

Regras

O número de versão segue SemVer (MAJOR.MINOR.PATCH): major para mudanças incompatíveis, minor para novas funcionalidades, patch para correções.
Toda entrada do CHG deve referenciar ao menos um id de história ou artefato.
Desvios documentais materializados na versão devem aparecer explicitamente na entrada (ligações a evidências ou RFC), conforme Desvio controlado da especificação.
A versão [Unreleased] é mantida no topo e promovida quando há release.

← DOD · GTI — Visão Geral →