Gerador de notas de lançamento gratuito

O que são notas de lançamento?

Notas de lançamento são um breve resumo do que mudou em uma nova versão de um produto: novos recursos, melhorias e correções, escritas para que o leitor saiba o que pode fazer agora. Um gerador de notas de lançamento transforma a lista bruta que sua equipe já possui, como commits ou tickets, nesse resumo, para que as notas sejam lançadas junto com a atualização, em vez de uma semana depois.

Boas notas de lançamento dizem aos clientes por que uma atualização é importante para eles. Mensagens de commit dizem aos desenvolvedores qual código mudou. O trabalho é traduzir um para o outro.

Notas de lançamento ou changelog?

As pessoas usam os termos de forma flexível. Uma divisão útil:

Esta ferramenta funciona como um gerador de changelog também: gere notas para cada lançamento e adicione-as ao topo da sua página de changelog.

O que incluir nas notas de lançamento

• Título com produto e versão: “Notas de lançamento do Acme Analytics 3.2”.
• Um resumo de uma linha: as uma ou duas mudanças com as quais a maioria dos leitores se importa.
• Novos, Melhorados, Corrigidos: nessa ordem, omitindo seções vazias.
• Bullets focados em benefícios: o que o usuário pode fazer agora, não o que o código faz.
• Mudanças críticas: exatamente o que alguém precisa fazer, destacado claramente.
• Links: para o artigo de ajuda ou vídeo para qualquer coisa que precise de explicação.

Um exemplo curto de notas de lançamento

Três commits, “feat: exportar relatórios para CSV”, “fix: fuso horário do painel com uma hora de diferença” e “chore: atualizar dependências”, poderiam se tornar:

Acme Analytics 3.2
Agora você pode levar seus relatórios para qualquer lugar, e os painéis mostram os horários corretos.

Novos

• Exportação CSV: baixe qualquer relatório como um arquivo CSV para abri-lo no Excel ou Google Sheets.

Corrigidos

• Horários do painel: os gráficos agora usam seu fuso horário corretamente.

A atualização de dependência é omitida da versão para o cliente, porque os usuários não notarão. A versão interna a mantém.

Como preparar suas alterações para o gerador

Você não precisa limpar sua lista primeiro, mas alguns hábitos geram notas melhores. Cole uma alteração por linha, seja uma mensagem de commit, um título de ticket ou uma frase. Mantenha prefixos convencionais como “feat:” e “fix:” se você os usa; eles ajudam a classificar as alterações em novas e corrigidas. Adicione uma palavra de contexto a itens enigmáticos, por exemplo “fix: exportar (CSV estava vazio para relatórios grandes)”. Preencha o nome do produto e a versão para que o título esteja pronto para publicação. Então, execute duas vezes se precisar de ambas as versões: uma para clientes, outra para a equipe interna.

Melhores práticas para notas de lançamento

Escreva para a pessoa que usa o produto

“Relatórios carregam mais rápido” é melhor que “Planejador de consultas otimizado”. Nomeie o recurso como ele aparece na interface.

Comece pelo que mais importa

Coloque a mudança que a maioria das pessoas notará primeiro. Pequenas correções podem ser uma linha cada no final.

Mostre o novo recurso

Uma captura de tela ou um vídeo curto de um novo recurso faz mais do que um parágrafo. Link o artigo de ajuda que o explica.

Publique em um cronograma que as pessoas possam encontrar

Mantenha cada lançamento em uma página de changelog, do mais novo para o mais antigo, para que os clientes e sua equipe de suporte sempre saibam onde procurar.

Erros comuns em notas de lançamento

• Colar o log de commits como está, com números de ticket e jargões.
• Esconder uma mudança crítica no meio de uma lista.
• Listar cada mudança interna nas notas para clientes.
• Prometer datas ou recursos que não estão no lançamento.

O gerador inclui apenas as alterações da sua lista e não adicionará datas que você não forneceu, mas verifique cada item antes de publicar.