Feedback da página
O feedback da página no Docsbook é um controle de Esta página foi útil? que o leitor responde com um clique — sem formulário, endereço de e-mail ou conta. O voto é registrado como um evento associado à página e como um webhook sobre o qual você pode agir. Coletá-lo não chama nenhum modelo e não custa nada.
A avaliação é um indicador, não uma pontuação. Esta página trata tanto do que um voto negativo não comprova quanto de como coletar um.
O que você obtém#
- Uma avaliação com um clique em todas as páginas, em um ou dois lugares, em todos os planos.
- Um voto que chega imediatamente aos seus próprios sistemas — um webhook
feedback.receivede um segundo webhookchat.negative_feedbackquando a avaliação é negativa, para que uma avaliação ruim chegue ao canal da sua equipe no momento em que acontece. - Um histórico por leitor. Na linha do tempo do visitante, o voto aparece como "Avaliou a página como útil" ou "Avaliou a página como não útil", ao lado de tudo o que o leitor fez, que é onde um único voto se torna interpretável.
- Uma fila que já sabe o que fazer com isso. Duas rotas de agente já disponíveis começam com feedback negativo e com perguntas de chat sem resposta e terminam em uma página em rascunho.
O que um leitor pode avaliar?#
Existem três controles, e eles não medem a mesma coisa.
| Abaixo da página | No painel "Nesta página" | Abaixo de uma resposta de IA | |
|---|---|---|---|
| O que avalia | A página | A página | Aquela resposta do assistente |
| Onde | No final do artigo, acima dos links anterior/próximo | No esquema, abaixo do índice | Ao lado de cada resposta no painel de chat |
| Configuração | Avaliar esta página (aba Conteúdo) | Avaliar página (aba Barra lateral direita) | Parte do chat de IA |
| Padrão | Ativado | Desativado | Com o chat |
| Em um celular | Exibido em linha | Atrás do botão flutuante do esquema, como uma folha inferior | Exibido |
| Evento que registra | docs.page_feedback_up / _down |
O mesmo | docs.ai_like / docs.ai_dislike |
A barra abaixo da página é a que a maioria dos projetos deseja ativar. O leitor chega até ela ao terminar a página, que é o momento em que já tem uma opinião; o controle do esquema só é visto por um leitor cujos olhos já estão na barra lateral direita. Os dois controles da página registram dados em uma única série — são dois lugares para fazer a pergunta, não duas métricas.
Os polegares das respostas de IA formam uma série genuinamente diferente e carregam campos diferentes: o ID da conversa e a pergunta que recebeu o voto, porque uma avaliação contendo apenas um caminho é um contador sobre o qual ninguém pode agir. A opção Relatar problema no menu de opções da resposta registra o mesmo evento de não gostei.
Um voto por controle, por visualização da página. Após votar, os botões são bloqueados e um breve agradecimento substitui a pergunta. A proteção é específica de cada controle, portanto um projeto com ambos os controles da página ativados pode receber dois votos do mesmo leitor na mesma página — isso é aceito deliberadamente: um leitor que vota duas vezes de propósito está dizendo a mesma coisa duas vezes, e eliminar duplicatas entre superfícies exigiria um estado compartilhado sem nenhum ganho de sinal.
Ativar o feedback da página#
Abaixo da página (ativado por padrão):
- Abra o site da documentação enquanto estiver conectado.
- Abra Float Widget → Configurações → aba Conteúdo.
- Ative Avaliar esta página.
No painel "Nesta página":
- Abra Float Widget → Configurações → aba Barra lateral direita.
- Ative Avaliar página.
Ambas as opções também podem ser definidas a partir de um cliente MCP com update_ui_settings (show_content_feedback, show_page_feedback).
O que é armazenado por voto#
Um voto em uma página é deliberadamente minimalista. Não há campo de texto livre em nenhum dos controles da página, nem ID de sessão ou qualquer coisa digitada pelo leitor:
| Para onde vai | O que contém |
|---|---|
| Evento de análise | Nome do evento (docs.page_feedback_up ou _down), seu projeto, o caminho da página, o IP e o país do leitor. A direção é codificada no nome do evento, porque o esquema do conjunto de dados de análise rejeita imediatamente um campo vote desconhecido |
Webhook feedback.received |
page_path, vote (up/down), comment (sempre null nesses controles), country — além de um ID de visitante |
Webhook chat.negative_feedback, somente em um voto negativo |
session_id, page_path, type (thumbs_down), comment |
| Identidade do visitante | Um SHA-256 com salt do IP do leitor, limitado ao escopo do seu projeto e truncado para 16 caracteres hexadecimais. É o mesmo hash usado pelo restante das suas análises, portanto um voto pode ser associado aos outros eventos desse leitor — e não pode ser revertido para um endereço |
Há dois comportamentos que vale a pena conhecer, pois eles alteram o significado dos seus números:
- Votos da sua própria equipe são excluídos das análises, mas ainda são enviados aos seus webhooks. O tráfego interno é ignorado na gravação da análise, pois testar sua própria página não é um sinal do leitor — mas o proprietário ainda deve ser informado de que uma avaliação ocorreu.
- O campo
commentexiste no payload e nunca é preenchido por estes controles. Ele existe para uma superfície que coleta esse campo; atualmente, nenhum dos controles da página o faz.
Um voto de resposta de IA armazena o projeto, a página em que o leitor estava, o ID da conversa e a pergunta — nenhum texto da resposta e nenhuma identidade do leitor além do mesmo hash de IP.
O que o proprietário vê#
| Superfície | O que ela mostra | Plano |
|---|---|---|
| Analytics → aba Feedback | Votos positivos e negativos, no total e por página, as 20 principais linhas ordenadas com avaliações negativas primeiro — a página com voto negativo é a que precisa ser corrigida; a que recebeu voto positivo apenas confirma o que já funciona | Todos os planos |
| Feeds / linha do tempo do visitante | Cada voto como seu próprio evento no percurso de um leitor, marcado como uma vitória ou um problema | Todos os planos |
Webhooks feedback.received e chat.negative_feedback |
O voto, no momento em que acontece, enviado para uma URL sua — assinado e reenviado em caso de falha, ao contrário dos hooks de chat | Todos os planos |
get_negative_feedback (MCP) |
Páginas classificadas por avaliações negativas | Pro |
get_ai_unanswered (MCP) |
Perguntas no chat que não produziram uma resposta — a outra metade do mesmo sinal | Pro |
O registro de um webhook está disponível em todos os planos; tanto o caminho MCP quanto o caminho REST verificam a mesma capacidade, e apenas três eventos avançados (pico de tráfego, queda de tráfego, ferramenta MCP chamada) são separados. Várias descrições de ferramentas MCP ainda anunciam esses dois eventos como Pro — esse texto está desatualizado, não o comportamento.
Uma questão — leia a aba Feedback como a série de respostas da IA, não como a série de páginas. Os totais e as linhas por página da aba são criados a partir de uma consulta sobre
docs.ai_like/docs.ai_dislike, os eventos gravados pelos votos de resposta da IA. Os controles da página gravamdocs.page_feedback_up/_down, e nenhuma consulta por trás dessa aba os lê. Portanto, um voto em uma página hoje chega aos seus webhooks e à linha do tempo do visitante, mas não chega às contagens da aba Feedback.get_negative_feedbacktem a mesma estrutura: seu próprio comentário no código afirma que o evento no nível da página "não é incluído aqui". Até que isso seja corrigido, trate a aba Feedback como uma medida das respostas do assistente e use o feed de eventos ou um webhook para os votos nas páginas.
De uma avaliação negativa à próxima página que você escrever#
Uma avaliação não é a conclusão. O que a torna acionável é o que vem junto dela: as pesquisas que não retornaram nada, as perguntas que o assistente não conseguiu responder e o que o leitor fez depois de votar.
Duas rotas de agente já vêm com essa sequência configurada, ambas no Pro:
Melhorar a documentação com base no feedback dos usuários — recomenda-se executar semanalmente. Ela lê as páginas que os leitores marcaram como ruins e, antes de repetir uma correção, lê o que as correções anteriores dessas páginas já fizeram; depois pergunta qual tarefa o leitor estava tentando concluir e só então edita. A etapa de histórico de alterações existe porque a versão sem ela media a saúde de uma página segundos depois de reescrevê-la, um número que ainda não poderia ter mudado.
Preencher lacunas com base nas conversas com o assistente — recomenda-se executar no evento chat.no_answer. Ela lê as perguntas que o assistente não conseguiu responder, separa uma lacuna na documentação de uma pergunta inadequada, escolhe aquela que vale a pena escrever hoje e cria um rascunho dessa página.
Os prompts por trás de cada botão Melhorar no painel seguem as mesmas quatro regras, que também devem ser aplicadas manualmente: avalie cada número em relação a algo e diga com o que você o comparou; cite as páginas e os eventos que você realmente leu; uma métrica que você não consegue ler está ausente, não é zero; e pare no diagnóstico antes de editar qualquer coisa.
Coletar uma avaliação não chama nenhum modelo nem é contabilizado. As rotas de agente acima envolvem trabalho de modelo e consomem o saldo do seu projeto — consulte a página de preços.
Por que esta é a maneira certa (evidências)#
| Regra | Por que funciona | Fonte |
|---|---|---|
| Trate a avaliação como um indicador, nunca como a pontuação de uma página | Os sistemas de avaliações voluntárias carregam dois vieses de auto-seleção — viés de aquisição e viés de subnotificação, nos quais "os consumidores com avaliações extremas, sejam positivas ou negativas, têm mais probabilidade de escrever avaliações do que os consumidores com avaliações moderadas do produto" — que, juntos, "fazem da avaliação média um estimador enviesado da qualidade do produto" | Hu, Pavlou & Zhang, 2017 — Sobre os vieses de auto-seleção nas avaliações de produtos on-line, MIS Quarterly 41(2) |
| Espere que quase ninguém vote e não interprete o silêncio como aprovação | Observado em quatro comunidades on-line de longa duração, com 63.990 participantes e 578.349 publicações, "menos de 25% dos participantes fizeram uma ou mais publicações", e o 1% mais ativo produziu 74,7% do conteúdo | van Mierlo, 2014 — A regra de 1% em quatro redes sociais digitais de saúde, JMIR (estudo observacional revisado por pares) |
| Não conclua que uma página é ruim apenas com base em uma baixa quantidade de votos | "A não resposta pode, mas não necessariamente, induzir viés de não resposta nas estimativas de pesquisas", e "não existe uma taxa mínima de resposta abaixo da qual as estimativas de pesquisas estejam necessariamente sujeitas a viés" — a taxa não é, por si só, o problema | Groves, 2006 — Taxas de não resposta e viés de não resposta em pesquisas domiciliares, Public Opinion Quarterly 70(5) |
| Associe cada avaliação ao comportamento relacionado a ela antes de agir | O viés "ocorre em função de quão correlacionada a variável da pesquisa está com a propensão a ser medida" — portanto, a questão não é quantas pessoas votaram, mas se os leitores que votam diferem naquilo que você está medindo. Um leitor confuso e um leitor satisfeito não pressionam o botão com a mesma frequência | Groves, 2006 — mesmo artigo |
A leitura prática dessas quatro linhas: vale a pena abrir uma página com dez avaliações negativas; uma página com três avaliações positivas não é evidência de que funciona; e uma página sem votos é uma página sobre a qual você não sabe nada, não uma página de que ninguém não gostou.
Limites#
- A aba Feedback atualmente não contabiliza votos nas páginas. Consulte o bloco abaixo da pergunta. Esta é a única afirmação nesta página que uma versão anterior desta documentação apresentou incorretamente, e ela é declarada aqui em vez de ser simplesmente omitida.
- Um voto não contém um motivo. Nenhum dos controles da página coleta texto livre, portanto um voto negativo informa que algo estava errado, mas nunca o que. A avaliação negativa da resposta da IA é mais rica apenas porque inclui a pergunta.
- As avaliações são por visualização, não por leitor. Um leitor que retornar amanhã poderá votar novamente, e um projeto com os dois controles de página ativados poderá receber dois votos de um leitor em uma única visualização da página.
- O feedback é mais informativo em páginas instrucionais — tutoriais e guias práticos, nos quais o leitor concluiu ou não a tarefa. Em uma tabela de parâmetros, uma avaliação informa muito pouco.
- Não publicamos nenhum benchmark de qual seria uma taxa de feedback típica do Docsbook. Nenhuma distribuição entre clientes foi medida, portanto não há um número “saudável” com o qual você possa se comparar. As fontes externas acima tratam de feedback voluntário em geral, não de sites do Docsbook.
- Há um campo de comentário no payload, mas nada o preenche. Se você criar uma interface que colete um comentário, o contrato do webhook já tem um lugar para ele; pronto para uso, ele é sempre
null.
Relacionado#
- Chat de IA — o assistente cujas respostas têm seus próprios votos positivos separados.
- Qualidade das respostas — o que acontece com uma pergunta que o assistente não conseguiu responder.
- Pesquisa de texto completo — pesquisas malsucedidas são o outro sinal de que uma página está ausente ou tem um nome incorreto.
- Análise da web — verifique o tráfego de uma página antes de reescrevê-la com base em três votos.
- Webhooks —
feedback.receivedechat.negative_feedbackcompletos, assinados e reenviados.