KjerrExemplos de changelog
que vale a pena copiar.
Bons exemplos de changelog têm três coisas em comum: um título que diz o que mudou, uma frase sobre o que o usuário pode fazer agora e um aviso honesto sobre o que fazer em seguida. Abaixo estão quatro posts, um para cada tipo de mudança, e depois changelog x release notes e um checklist.
Quatro exemplos de changelog, por categoria
Cada exemplo abaixo foi escrito para um produto fictício, nas quatro categorias que a seção Novidades do Kjerr usa. Copie o formato, não as palavras.
Novo recurso
A verificação em duas etapas chegou
Agora você pode proteger sua conta com uma segunda etapa no login. Abra Configurações, depois Segurança, leia o código QR com qualquer aplicativo autenticador e guarde os códigos de recuperação. O dono do workspace pode exigir isso de todos os membros. Este era um dos pedidos mais votados do nosso quadro.
Por que funciona: Começa pelo que o usuário pode fazer agora, diz onde encontrar e dá crédito ao pedido.
Melhoria
Relatórios até três vezes mais rápidos
Refizemos o cálculo dos relatórios. O resumo mensal, que levava seis segundos nas contas grandes, agora abre em menos de dois, e períodos maiores que um ano não travam mais. Os números em si não mudaram.
Por que funciona: Dá um número que o leitor sente e responde ao receio de que os dados tenham mudado.
Correção
Corrigido: a exportação em CSV perdia a última linha
Exportações com mais de 10.000 linhas saíam sem a última linha. O erro foi corrigido, e as exportações feitas a partir de hoje estão completas. Se você exportou um relatório grande na primeira quinzena de agosto, exporte de novo.
Por que funciona: Diz o que estava errado, quem foi afetado e o que fazer. Sem eufemismo.
Aviso
O que estamos construindo neste semestre
Um resumo dos próximos meses, com base no que vocês votaram. As notificações no Slack já estão em desenvolvimento. O modo escuro vem em seguida; é a ideia mais votada do quadro, e o design já começou. Vamos avisar aqui quando cada uma for lançada.
Por que funciona: Alinha as expectativas sem prometer datas que não dá para cumprir e remete aos votos.
A anatomia de um post de changelog que funciona
- Título: a mudança, não a versão. “Relatórios até três vezes mais rápidos” diz ao leitor se aquilo interessa a ele. “v4.12.1” não diz.
- Categoria. Novo recurso, melhoria, correção ou aviso. Ajuda a passar os olhos e a filtrar.
- O que você pode fazer agora. Uma ou duas frases do ponto de vista de quem usa.
- Onde encontrar. O caminho no menu ou um link.
- O que fazer em seguida. Muitas vezes, nada. Quando uma correção pede uma nova exportação ou um ajuste nas configurações, diga isso com todas as letras.
- Dê crédito ao pedido. Se os usuários pediram, coloque o link do pedido. É a prova mais barata de que o feedback é lido.
Changelog x release notes
O changelog é o registro contínuo de todas as mudanças relevantes; as release notes (notas de versão ou notas de atualização) são o texto sobre um lançamento específico. O changelog é uma lista para passar os olhos: posts curtos, os mais recentes primeiro, um por mudança. As release notes são um documento para ler: agrupam as mudanças de uma versão, explicam as maiores com capturas de tela e trazem os passos de atualização ou de migração.
Equipes pequenas costumam precisar só do changelog, com um post mais longo quando o lançamento merece. Produtos com instalações versionadas ou com API tendem a publicar também as release notes e a colocar, em cada post do changelog, um link para elas.
Um checklist antes de publicar
Leia o post como um usuário que nunca viu o seu roadmap.
- O título faz sentido sem o texto?
- A primeira frase fala do usuário, e não da equipe?
- Há um número, um caminho ou uma captura de tela onde isso ajudaria?
- Se algo quebrou, o post diz quem foi afetado e o que fazer?
- Os pedidos que o post responde estão vinculados?
- Quem pediu vai ficar sabendo, e não só quem por acaso visitar a página?
Como publicar posts assim no Kjerr
A seção Novidades do Kjerr é um changelog com as quatro categorias acima. Os posts aceitam títulos, listas, links e imagens, apontam as ideias que respondem e, na publicação, podem enviar e-mail aos assinantes.
- Categorias, busca por texto e data, reações com emoji e comentários.
- Assinatura por e-mail com endereço confirmado.
- As ideias vinculadas aparecem embaixo do post; mudá-las para Shipped envia e-mail a quem votou.
- Um widget para o seu próprio site mostra os mesmos anúncios em um painel lateral, com o número de posts não lidos no botão.
Perguntas, com respostas diretas.
O que é um changelog?
Um changelog é uma lista datada do que mudou em um produto, da mudança mais recente para a mais antiga, escrita para as pessoas que o usam. Cada post diz o que mudou, quem é afetado e o que a pessoa precisa fazer, se é que precisa.
Qual a diferença entre changelog e release notes?
O changelog é o registro contínuo de todas as mudanças relevantes; as release notes, ou notas de versão, são o texto sobre um lançamento específico. Um post de changelog tem poucas frases. As release notes podem ocupar uma página, com capturas de tela e passos de atualização. Muitos produtos publicam as duas coisas no mesmo lugar.
O que um post de changelog deve ter?
Um título que diz o que mudou, uma categoria, uma ou duas frases sobre o que o usuário pode fazer agora, onde encontrar e a ação necessária, se houver. Se a mudança responde a um pedido, diga isso e coloque o link.
Com que frequência atualizar o changelog?
Sempre que for lançado algo que os usuários possam notar. Um post curto a cada semana ou duas constrói mais confiança do que um longo a cada trimestre.
Onde o changelog deve ficar?
Em uma página pública com endereço próprio, para poder ser linkado, buscado e indexado, e no e-mail de quem assina. O Kjerr o coloca no mesmo quadro dos pedidos de recursos.
Páginas relacionadas
Dê uma resposta aos seus usuários.
O Kjerr é gratuito durante o acesso antecipado: todos os recursos, sem cartão de crédito. Quando os planos pagos chegarem, o preço será por workspace, nunca por assento de administrador.