Quando usar

Publique notas de versão a cada versão lançada, seja um lançamento importante ou uma pequena correção. Usuários e administradores leem para decidir quando atualizar, e as equipes de suporte leem para responder perguntas depois. Uma cópia em PDF é útil para clientes que precisam de documentação de versão para auditorias, aprovação de mudanças ou um arquivo offline.

O que tem dentro

• Um título com um campo de preenchimento para seu projeto, seguido do número da versão e da data de lançamento.
• Destaques, depois listas separadas de itens adicionados, melhorados e corrigidos na ordem familiar de changelog.
• Notas de atualização numeradas, uma seção de problemas conhecidos e uma linha de feedback com um campo de preenchimento para seu e-mail.

Dicas para um documento melhor

• Descreva as correções pelo comportamento que os usuários vão ver agora, não pela causa interna. Eles se importam que as exportações não falhem mais, não com qual função foi corrigida.
• Coloque qualquer coisa que exija ação, como um backup ou uma mudança de configuração, nas notas de atualização e mencione também nos destaques. O estilo Técnico mantém números de versão e comandos fáceis de ler rapidamente.