Para coletar e visualizar feedback, primeiro ative o recurso na página de Add-ons do seu painel.
A guia de feedback exibe as avaliações quantitativas (positivo/negativo) que sua documentação recebeu e qualquer feedback qualitativo fornecido pelos usuários. Use essas informações para avaliar a qualidade da sua documentação e fazer melhorias. Acesse a guia de feedback na página Analytics do seu painel.

Tipos de feedback

Feedback contextual e de trechos de código estão em beta. Para habilitá-los no seu site de documentação, entre em contato com nossa equipe de vendas.
A aba Feedback exibe informações de acordo com os complementos de feedback que você ativar. Ative os tipos de feedback que preferir:
Captura de tela dos controles de feedback na página Add-ons.
  • Apenas avaliação por polegar: Votação simples de positivo/negativo para medir a satisfação geral com as páginas.
  • Apenas feedback de trechos de código: Feedback especificamente sobre trechos de código.
  • Avaliação por polegar e feedback contextual: Votação na página, além de comentários detalhados e motivos das avaliações.
  • Avaliação por polegar e feedback de trechos de código: Votação na página, além de feedback sobre exemplos de código.
  • Avaliação por polegar, contextual e feedback de trechos de código: Sistema completo de feedback com votação na página, comentários detalhados e feedback de trechos de código.

Gerenciando feedback

Para feedback contextual e de trechos de código, você pode definir o status de cada feedback e adicionar notas internas para acompanhar seu trabalho na resolução do feedback dos usuários.

Alterando o status do feedback

Selecione o status ao lado de um feedback para marcá-lo como Pendente, Em andamento, Resolvido ou Descartado. Boas práticas para definir os status de feedback:
  • Pendente: O feedback está aguardando revisão.
  • Em andamento: O feedback foi validado e está em andamento.
  • Resolvido: O feedback foi resolvido.
  • Descartado: O feedback foi descartado por não ser acionável, irrelevante ou impreciso.

Filtrando por status

Use o filtro de status para controlar quais feedbacks são exibidos. Desmarque um status para ocultar todos os feedbacks com esse status. Por padrão, todos os feedbacks são exibidos.

Adicionando notas internas

Clique em um item de feedback para adicionar uma nota interna. Essas notas são visíveis apenas para pessoas com acesso ao seu painel. Use as notas para adicionar informações para colaboração, vincular tíquetes relevantes de suporte ou engenharia, ou registrar qualquer outra informação útil.

Usando os dados de feedback

Analise seus dados de feedback para:
  • Identificar conteúdo de sucesso: Páginas com mais feedback positivo mostram o que funciona bem na sua documentação.
    • Priorizar melhorias: Páginas com mais feedback negativo indicam quais conteúdos podem precisar de atenção.
    • Tomar providências: Faça atualizações na documentação com base no feedback direto dos usuários.