Pular para o conteúdo principal

Buscar

Digite uma palavra ou pergunta para buscar nos artigos de ajuda.

Como publicar notas de versão e changelog do meu produto?

Nesta matéria

Antes de começar

  • Esse recurso foi feito para sites de Central de Ajuda e Documentação do Produto. Ele vem ativado por padrão no modelo inicial de Software ou SaaS. Sites de outros tipos não podem adicioná-lo.
  • Você precisa de permissão para gerenciar a central de ajuda.

Passo a passo

  1. Abra o Matérias e escolha Notas de versão. Isso abre a lista de notas de versão.
  2. Escolha Novo.
  3. Preencha Título, version e releasedOn, a data em que a versão foi lançada. Esses três campos são obrigatórios.
  4. Opcional: Resumo, com até 1.000 caracteres, e Link para uma página mais detalhada.
  5. Adicione uma linha para cada alteração no campo de lista. Neste formulário, a lista aparece como Momentos. Escolha o seu Tipo: Novo, Melhorado ou Corrigido. Escreva o texto em até 300 caracteres. Você pode adicionar até 100 linhas.
  6. Coloque a nota na seção do hub correto e publique.

O formulário mostra esses campos de suporte pelos seus nomes curtos, como version e releasedOn, em vez de frases completas.

Importante saber

  • Ordem. As notas são listadas pela data de lançamento mais recente primeiro.
  • Por hub. A página de um hub lista as notas da sua própria seção e tópicos.
  • RSS. Os leitores podem acompanhar o changelog por um feed. O feed fica no endereço que termina com /help/release-notes.rss no seu site.
  • Dados de busca. Cada nota é informada aos mecanismos de busca como um artigo técnico com sua versão. Isso não garante uma exibição especial nos resultados de busca.
  • Escreva para o seu leitor. Explique o que mudou para ele, com palavras simples.

Dúvidas frequentes

Perguntas frequentes

Posso agendar uma nota de versão?

Sim. As notas de versão funcionam como posts, então você pode agendar a publicação para depois.

E quanto aos problemas que ainda não foram corrigidos?

Artigos relacionados

Feedback

Isso foi útil?

Também disponível em

Ainda precisa de ajuda?