O que é changelog
Changelog é o registro das mudanças de cada versão publicada. Ele informa o que foi adicionado, alterado, corrigido ou removido, com a linguagem de acompanhamento do sistema.
O documento é diferente do histórico de commits. O commit guarda a alteração técnica, e o changelog explica o efeito para o cliente e para a rotina.
O formato e a ordem
Cada versão recebe uma data e um conjunto de entradas. As entradas são agrupadas por tipo, e a mais recente aparece no topo.
A versão segue um identificador estável. O leitor consegue comparar duas versões, e o suporte encontra a mudança que explica um comportamento novo.
O que entra e o que fica de fora
Entra o que muda o comportamento, a configuração ou a experiência. A correção interna sem efeito visível pode ser resumida em uma linha.
Fica de fora o detalhe de implementação que não altera nada para o cliente. O changelog não substitui a documentação técnica nem o postmortem.
Exemplo
Como conferir
Compare a versão publicada com as entradas do changelog. Confira se cada mudança visível aparece e se a data corresponde à publicação. Leia a entrada como se fosse a primeira vez.
O release marca a publicação, e o ciclo de lançamento define a frequência. O changelog fecha a comunicação entre a alteração técnica e o cliente.
Dúvidas frequentes
Perguntas frequentes sobre Changelog
- Changelog é a mesma coisa que histórico de commits?
- Não. O histórico registra cada alteração técnica. O changelog reúne o que mudou para o cliente, na linguagem de acompanhamento do produto.
- Toda versão precisa de entrada?
- Toda versão publicada precisa de uma entrada, mesmo curta. A correção interna sem efeito visível pode ser agrupada, desde que o leitor saiba o que mudou.
- Como organizar as entradas?
- Separe por tipo de mudança, como adicionado, alterado, corrigido e removido. A ordem precisa ser estável para que o leitor encontre a informação.
- O changelog pode ser automático?
- A coleta pode ser automática, e a redação ainda precisa de revisão. O título gerado a partir do commit raramente explica o efeito para o cliente.
Para continuar
Recursos relacionados
Documentação
Keep a Changelog
Apresenta o formato e os tipos de mudança do changelog.
Abrir recursoSite de referência
Wikipedia: changelog
Define o registro e o uso na documentação de software.
Abrir recursoAplicação na formação
Developer Workspace
No Developer Workspace, o changelog aparece na publicação de uma versão e no registro do que mudou para o cliente.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.