Templates
Release notes
Release notes
Um release note (ou nota de versão) informa os usuários sobre atualizações, melhorias e correções de bugs em uma nova versão do produto. Neste guia, você verá orientações gerais sobre como escrever um release note e o modelo de release note.
Revise as diretrizes em Melhores práticas para escrever documentação.
Este tipo de conteúdo é somente criado em inglês.
Como escrever um release note
| Tema | Descrição |
|---|---|
| Introdução |
|
| "O que mudou?" | Explique as alterações feitas na versão. |
| "Por que fizemos esta mudança?" | Explique o que motivou a VTEX a realizar a mudança e os problemas solucionados. |
| "O que precisa ser feito?" |
|
Modelo de release note
O release note deve ter as seguintes tags no início:
| Nome da tag | Ícone | Descrição |
|---|---|---|
added | + | Novos recursos, funcionalidades ou componentes adicionados à versão. |
deprecated | ➖ | Um recurso, função ou componente que não é mais recomendado para uso. |
info | ℹ | Informações relevantes ou atualizações que não estão vinculadas a alterações específicas, mas são importantes para os usuários. |
fixed | ✔ | Bugs ou problemas que foram resolvidos nesta versão. |
removed | x | Um recurso, funcionalidade ou componente que foi excluído. |
improved | ^ | Melhorias ou otimizações feitas em funcionalidades ou produtos existentes. |
Modelo de release note
# Nome da funcionalidade: resumo Criamos/modificamos essa funcionalidade para <incluir o principal benefício> para que você possa <tarefa a ser realizada>.## O que mudou?Antes, você precisava/era necessário <como o usuário resolvia o problema>. Agora, você pode/é possível usar <novo botão/tela> para <benefício>.## Por que fizemos esta mudança?Para <facilitar a tarefa a ser realizada>, desenvolvemos <assunto>. Este recurso está disponível para <usuários específicos ou todos os usuários?>.## O que precisa ser feito?Para <usar este novo recurso>, você deve <instalar algo ou ajustar uma configuração>.Para saber mais <sobre o recurso/módulo/produto>, confira <o artigo>.
Veja exemplos de release notes no Developer Portal.