Boas práticas de escrever notas de versão

Na entrega de todas as versões do software, temos que escrever uma nota de lançamento. Por exemplo, aqui estão alguns dos termos adicionados quando escrevo uma nota de versão:

Data de lançamento
Bug Solved

Isso é suficiente ou existe mais alguma coisa?

release

— CoolProgrammer
fonte

Isto parece uma duplicata de programmers.stackexchange.com/questions/66377/…

não se esqueça recursos adicionados

— aberração catraca

Respostas:

Eu acho que os seguidores darão lugar a boas práticas

// Data Relacionada

Data de lançamento

// Recurso relacionado

Recursos Adicionados
Em destaque removido
Recursos alterados

// Bug related

Bugs resolvidos
Bugs não resolvidos

// Relacionado à dependência

Lista de dependência

// Relacionado a testes

Resultados do teste de unidade
Resultados do teste de aceitação

// relacionado ao controle de versão

Nota da etiqueta
Número de revisão

Também algumas vezes vale a pena destacar coisas que o usuário final pode querer alterar em suas configurações ou fluxo de trabalho.

A maioria dos usuários finais não se importa com o resultado do teste. Eles esperam que ela seja de alta qualidade, independentemente do que diz a nota de lançamento.

O mais importante das notas de versão é estar ciente de que cada frase adicional perde outros 10% dos leitores. Portanto, você deve priorizar estritamente o que seus usuários atuais precisam saber sobre o lançamento.

— Md Mahbubur Rahman
fonte

também vale a pena destacar algumas vezes o que o usuário final pode querer alterar em suas configurações ou fluxo de trabalho

— jk.

@jk. Sim você está certo. Eu editei minha resposta como seu bom comentário.

— Md Mahbubur Rahman

A maioria dos usuários finais não se importa com o resultado do teste. Eles esperam que ela seja de alta qualidade, independentemente do que diz a nota de lançamento.

— Henrik

As notas de versão do @Henrik podem ser úteis para outras pessoas que não os usuários finais

— jk.

O mais importante das notas de versão é estar ciente de que cada frase adicional perde outros 10% dos leitores. Portanto, você deve priorizar estritamente o que seus usuários atuais precisam saber sobre o lançamento.

— ddyer
fonte

cada linha pode perder 10% dos leitores casuais, desinteressados (ou preguiçosos). É para esses leitores que suas notas de versão não foram escritas. Aqueles que se importam com o que você fez lerão todos eles e agradecerão por cada linha relevante - você só precisa ter cuidado ao incluir cotão que realmente precisa entrar na documentação adequada.

— Gbjbaanb