← Todos os casos de uso

Gere notas de versão voltadas ao cliente

O Zero lê commits e PRs mesclados, agrupa as mudanças por impacto no cliente e rascunha notas de versão claras e específicas, prontas para publicar.

O Zero conecta:GitHubSlack

O que o Zero entrega

Gere notas de versão voltadas ao cliente — sample output from Zero — screenshot 1

Qual é o problema

As notas de versão são sempre a última coisa a ser escrita e a primeira a ser cortada quando o release está atrasado. O problema é o material de origem: mensagens de commit escritas para engenheiros, títulos de PR que pressupõem conhecimento tácito e 30 PRs mesclados com os quais seus usuários, individualmente, em geral não se importam. O Release Notes Generator inverte o fluxo. O Zero lê os commits e as descrições dos PRs, filtra as mudanças visíveis ao cliente, agrupa por tema (novos recursos, melhorias, correções) e escreve as notas na voz que seus clientes de fato leem. Você revisa, e o próximo release sai com notas em vez de silêncio.

Como o Zero resolve

Passo 1: conecte suas ferramentas

GitHub
GitHub
Obrigatório
GitHub. O Zero lê PRs mesclados, mensagens de commit, marcadores e tags de release. É necessário acesso de leitura ao repositório.
Conectar
Slack
Slack
Obrigatório
Slack. O Zero entrega os rascunhos no canal de revisão e publica as notas finais depois de aprovadas. É necessário acesso de escrita no canal.
Conectar

Passo 2: peça ao Zero

@Zero para o release que vamos lançar hoje, leia todos os PRs mesclados desde a última tag de release. Agrupe por impacto no cliente: novos recursos, melhorias, correções de bugs. Pule refatorações internas e mudanças de teste. Rascunhe notas voltadas ao cliente na voz do nosso produto.
experimente
O Zero lê cada PR mesclado dentro da janela do release
O Zero reúne os PRs mesclados desde a última tag de release, incluindo títulos, descrições e marcadores. Mudanças apenas internas (refatorações, testes, ajustes de CI) são filtradas com base na sua convenção de marcadores.
O Zero agrupa as mudanças por impacto no cliente
O Zero agrupa os PRs restantes em temas: novos recursos, melhorias e correções. Cada mudança é reescrita a partir da descrição do PR em uma linha voltada ao cliente: específica o bastante para ser útil, livre de jargão interno.
O Zero rascunha as notas na voz do seu produto
O rascunho final cai na sua ferramenta de documentação ou no Slack com seções que seguem o template das suas notas de versão. Você edita para ajustar voz e nuance, depois publica.

Passo 3: leve mais longe

Refinar a voz
Atualize as diretrizes que o Zero usa para tom e formatação.
@Zero a partir de agora, pule os cabeçalhos Markdown nas notas de versão. Apenas prosa simples.
experimente
Encadear com a publicação
Empurre as notas aprovadas diretamente para a sua documentação ou blog.
@Zero assim que eu aprovar as notas, publique-as na seção Releases da nossa documentação e poste o link em #announcements.
experimente
Traduzir
Gere notas em todos os idiomas que você suporta.
@Zero traduza as notas de versão aprovadas para alemão, japonês e espanhol. Preserve a estrutura das seções.
experimente

Dicas para melhores resultados

●Marque os PRs apenas internos com um marcador consistente (como `internal` ou `no-release-notes`). O Zero só consegue pular o que você marcar.
●Mantenha um guia de estilo curto para notas de versão na sua documentação. Voz do cliente, verbos no ativo, sem jargão interno. O Zero o capta e aplica a cada release.
●Rascunhe as notas antes de o release sair, não depois. Revisar um rascunho enquanto o trabalho está fresco é mais rápido do que reconstruir o contexto uma semana depois.