Aperçu

Retour sur la page

Le retour sur la page dans Docsbook est un contrôle Cette page vous a-t-elle été utile ? auquel le lecteur répond en un clic — sans formulaire, sans adresse e-mail et sans compte. Le vote est enregistré comme un événement associé à cette page et comme un webhook sur lequel vous pouvez agir. Sa collecte n'appelle aucun modèle et ne coûte rien.

La note est un indicateur, pas un score. Cette page traite autant de ce qu'un pouce vers le bas ne prouve pas que de la manière d'en recueillir un.

Ce que vous obtenez#

  • Une évaluation en un clic sur chaque page, à un ou deux endroits, quel que soit le forfait.
  • Un vote qui parvient immédiatement à vos propres systèmes — un webhook feedback.received, et un second webhook chat.negative_feedback en cas de pouce vers le bas, afin qu’une mauvaise évaluation puisse apparaître dans le canal de votre équipe dès qu’elle se produit.
  • Un historique par lecteur. Dans la chronologie du visiteur, le vote apparaît comme « A évalué la page comme utile » ou « A évalué la page comme inutile », aux côtés de toutes les autres actions de ce lecteur, c’est ce qui permet d’interpréter un vote isolé.
  • Une file d’attente qui sait déjà quoi en faire. Deux parcours d’agent prêts à l’emploi partent des commentaires négatifs et des questions de chat restées sans réponse, pour aboutir à une page rédigée.

Que peut évaluer un lecteur ?#

Trois contrôles existent, et ils ne mesurent pas la même chose.

Sous la page Dans le panneau « Sur cette page » Sous une réponse de l’IA
Ce qui est évalué La page La page Cette réponse de l’assistant
Emplacement À la fin de l’article, au-dessus des liens précédent/suivant Dans le plan, sous la table des matières À côté de chaque réponse dans le panneau de discussion
Paramètre Évaluer cette page (onglet Contenu) Évaluer la page (onglet Barre latérale droite) Fait partie du chat IA
Valeur par défaut Activé Désactivé Avec le chat
Sur un téléphone Affiché en ligne Derrière le bouton de plan flottant, sous forme de feuille inférieure Affiché
Événement écrit docs.page_feedback_up / _down Le même docs.ai_like / docs.ai_dislike

La barre située sous la page est celle que la plupart des projets souhaitent activer. Un lecteur l’atteint en terminant la page, au moment où il s’est forgé une opinion ; le contrôle du plan n’est vu que par un lecteur dont le regard se trouve déjà sur la barre latérale droite. Les deux contrôles de page écrivent dans une seule série — ce sont deux endroits où poser la question, pas deux métriques.

Les boutons pouce associés aux réponses de l’IA constituent une série véritablement différente et transportent des champs différents : l’identifiant de la conversation et la question qui a motivé le vote, car une évaluation qui ne contient qu’un chemin n’est qu’un compteur inexploitable. Signaler un problème dans le menu de débordement de la réponse écrit le même événement de désapprobation.

Un vote par contrôle et par affichage de page. Après le vote, les boutons sont verrouillés et un court message de remerciement remplace la question. La protection s’applique à chaque contrôle : un projet qui active les deux contrôles de page peut recueillir deux votes du même lecteur sur la même page — un choix délibéré : un lecteur qui vote deux fois intentionnellement vous communique deux fois la même chose, et dédupliquer les votes entre les surfaces nécessiterait un état partagé sans apporter de gain en termes de signal.

Activer les commentaires sur la page#

Sous la page (activé par défaut) :

  1. Ouvrez votre site de documentation en étant connecté.
  2. Ouvrez Float Widget → Paramètres → onglet Contenu.
  3. Activez Évaluer cette page.

Dans le panneau « Sur cette page » :

  1. Ouvrez Float Widget → Paramètres → onglet Barre latérale droite.
  2. Activez Évaluer la page.

Les deux peuvent également être configurés depuis un client MCP avec update_ui_settings (show_content_feedback, show_page_feedback).

Que contient chaque vote#

Un vote sur une page est volontairement minimal. Aucun champ de texte libre n'est présent dans l'un ou l'autre des contrôles de page, aucun identifiant de session et rien de saisi par le lecteur :

Destination Contenu
Événement Analytics Nom de l'événement (docs.page_feedback_up ou _down), votre projet, le chemin de la page, l'adresse IP et le pays du lecteur. Le sens est encodé dans le nom de l'événement, car le schéma du jeu de données Analytics rejette catégoriquement un champ vote inconnu
Webhook feedback.received page_path, vote (up/down), comment (toujours null pour ces contrôles), country — ainsi qu'un identifiant de visiteur
Webhook chat.negative_feedback, uniquement pour un vote négatif session_id, page_path, type (thumbs_down), comment
Identité du visiteur Un SHA-256 salé de l'adresse IP du lecteur, limité à votre projet, tronqué à 16 caractères hexadécimaux. Il s'agit du même hachage que celui utilisé par le reste de vos données Analytics, de sorte qu'un vote peut être associé aux autres événements de ce lecteur — et il n'est pas réversible pour retrouver une adresse

Deux comportements méritent d'être connus, car ils modifient la signification de vos chiffres :

  • Les votes de votre propre équipe sont exclus d'Analytics, mais sont tout de même envoyés à vos webhooks. Le trafic interne est ignoré lors de l'enregistrement dans Analytics, car le fait que vous testiez votre propre page ne constitue pas un signal de lecteur — mais le propriétaire doit tout de même être informé qu'une évaluation a eu lieu.
  • Le champ comment existe dans la charge utile et n'est jamais renseigné par ces contrôles. Il est prévu pour une interface qui en collecte un ; aujourd'hui, aucun des deux contrôles de page ne le fait.

Un vote sur une réponse d'IA enregistre votre projet, la page sur laquelle se trouvait le lecteur, l'identifiant de la conversation et la question — aucun texte de réponse, aucune identité du lecteur au-delà du même hachage d'adresse IP.

Ce que voit le propriétaire#

Emplacement Ce qui s’affiche Offre
Analytics → onglet Feedback Pouces vers le haut et vers le bas, au total et par page, 20 premières lignes triées avec les avis négatifs en premier — la page ayant reçu un vote négatif est celle à corriger, tandis que celle ayant reçu un vote positif ne fait que confirmer ce qui fonctionne déjà Toutes les offres
Flux / chronologie des visiteurs Chaque vote comme un événement distinct dans le parcours d’un lecteur, présenté comme une réussite ou un problème Toutes les offres
feedback.received et chat.negative_feedback webhooks Le vote, au moment où il se produit, envoyé à une URL qui vous appartient — signé et réessayé, contrairement aux hooks de chat Toutes les offres
get_negative_feedback (MCP) Pages classées par nombre d’avis négatifs Pro
get_ai_unanswered (MCP) Questions de chat restées sans réponse — l’autre moitié du même signal Pro

L’enregistrement d’un webhook est disponible avec toutes les offres ; les chemins MCP et REST vérifient tous deux la même fonctionnalité, et seuls trois événements avancés (pic de trafic, baisse du trafic, appel d’un outil MCP) sont traités séparément. Plusieurs descriptions d’outils MCP indiquent encore que ces deux événements sont réservés à l’offre Pro — ce texte est obsolète et ne correspond pas au comportement réel.

Point à vérifier — lisez l’onglet Feedback comme une série de réponses de l’IA, et non comme une série de pages. Les totaux et les lignes par page de l’onglet sont générés à partir d’une requête sur docs.ai_like / docs.ai_dislike, les événements enregistrés par les pouces de l’réponse de l’IA. Les contrôles de page enregistrent docs.page_feedback_up / _down, et aucune requête exécutée par cet onglet ne les lit. Ainsi, un vote sur une page aujourd’hui atteint vos webhooks et la chronologie des visiteurs, mais n’apparaît pas dans les compteurs de l’onglet Feedback. get_negative_feedback suit la même logique : son propre commentaire de code indique que l’événement au niveau de la page « n’est pas intégré ici ». Tant que ce problème n’est pas corrigé, considérez l’onglet Feedback comme une mesure des réponses de l’assistant et utilisez le flux d’événements ou un webhook pour les votes sur les pages.

D’un pouce vers le bas à la prochaine page que vous écrivez#

Une évaluation n’est pas le diagnostic. Ce qui la rend exploitable, c’est ce qui l’accompagne : les recherches qui n’ont rien renvoyé, les questions auxquelles l’assistant n’a pas pu répondre et ce que le lecteur a fait après avoir voté.

Deux parcours d’agent sont fournis avec cette séquence déjà configurée, tous deux sur Pro :

Améliorer la documentation à partir des retours des utilisateurs — il est recommandé de l’exécuter chaque semaine. Il lit les pages que les lecteurs ont jugées mauvaises, puis lit ce que les corrections précédentes apportées à ces pages ont déjà produit avant d’en répéter une, demande ensuite quelle tâche le lecteur essayait de terminer, et ne modifie la page qu’après cela. L’étape consacrée à l’historique des modifications existe parce que la version qui ne l’incluait pas mesurait la santé d’une page quelques secondes après sa réécriture, alors que ce chiffre n’avait pas encore pu évoluer.

Combler les lacunes à partir des conversations avec l’assistant — il est recommandé de l’exécuter lors de l’événement chat.no_answer. Il lit les questions auxquelles l’assistant n’a pas pu répondre, distingue une lacune documentaire d’une question mal formulée, choisit celle qui mérite d’être traitée aujourd’hui et rédige cette page.

Les invites derrière chaque bouton Améliorer du panneau appliquent les mêmes quatre règles, qui sont également celles à appliquer manuellement : évaluez chaque chiffre par rapport à quelque chose et indiquez à quoi vous l’avez comparé ; citez les pages et les événements que vous avez réellement consultés ; une métrique que vous ne pouvez pas lire est absente, et non égale à zéro ; et arrêtez-vous au diagnostic avant de modifier quoi que ce soit.

La collecte d’une évaluation n’appelle aucun modèle et n’est pas comptabilisée. Les parcours d’agent ci-dessus utilisent des modèles et prélèvent sur le solde de votre projet — consultez la page des tarifs.

Pourquoi c’est la bonne méthode (preuves)#

Règle Pourquoi cela fonctionne Source
Considérez la note comme un indicateur, jamais comme la note d’une page Les systèmes d’évaluation volontaires présentent deux biais d’auto-sélection — le biais d’acquisition et le biais de sous-déclaration, selon lesquels « les consommateurs attribuant des notes extrêmes, positives ou négatives, sont plus susceptibles de rédiger des avis que les consommateurs attribuant des notes modérées aux produits » — qui, ensemble, « font de la note moyenne un estimateur biaisé de la qualité du produit » Hu, Pavlou & Zhang, 2017 — On Self-Selection Biases in Online Product Reviews, MIS Quarterly 41(2)
Attendez-vous à ce que presque personne ne vote et ne prenez pas le silence pour une approbation Observé dans quatre communautés en ligne actives depuis longtemps, réunissant 63 990 participants et 578 349 publications, « moins de 25 % des acteurs ont publié une ou plusieurs contributions », tandis que les 1 % les plus actifs ont produit 74,7 % du contenu van Mierlo, 2014 — The 1% Rule in Four Digital Health Social Networks, JMIR (étude observationnelle évaluée par des pairs)
Ne concluez pas qu’une page est mauvaise sur la seule base d’un faible nombre de votes « L’absence de réponse peut, mais ne doit pas nécessairement, introduire un biais de non-réponse dans les estimations d’enquête », et « il n’existe pas de taux de réponse minimal en dessous duquel les estimations d’enquête sont nécessairement biaisées » — le taux n’est pas en soi le problème Groves, 2006 — Nonresponse Rates and Nonresponse Bias in Household Surveys, Public Opinion Quarterly 70(5)
Associez chaque note au comportement qui l’entoure avant d’agir Le biais « se produit en fonction de la corrélation entre la variable étudiée et la propension à être mesuré » — la question n’est donc pas de savoir combien de personnes ont voté, mais si les lecteurs qui votent diffèrent sur le point que vous mesurez. Un lecteur désorienté et un lecteur satisfait n’appuient pas sur le bouton avec la même fréquence Groves, 2006 — same paper

La lecture pratique de ces quatre lignes est la suivante : une page avec dix pouces vers le bas mérite d’être consultée ; une page avec trois pouces vers le haut ne prouve pas qu’elle est utile ; et une page sans aucun vote est une page dont vous ne savez rien, pas une page que personne n’a appréciée.

Limites#

  • L’onglet Feedback ne comptabilise actuellement pas les votes sur les pages. Consultez le bloc situé sous la question ci-dessus. C’est la seule affirmation de cette page qu’une version précédente de cette documentation comportait à tort, et elle est indiquée ici plutôt que supprimée discrètement.
  • Un vote ne fournit aucune raison. Aucun des deux contrôles de page ne recueille de texte libre : un pouce vers le bas vous indique qu’un problème est survenu, mais jamais lequel. L’avis négatif sur la réponse de l’IA est plus riche uniquement parce qu’il contient la question.
  • Les évaluations sont associées à chaque affichage, et non à chaque lecteur. Un lecteur qui revient demain peut voter à nouveau, et un projet où les deux contrôles de page sont activés peut recueillir deux votes d’un même lecteur lors d’un seul affichage de page.
  • Les retours sont particulièrement instructifs sur les pages pédagogiques — tutoriels et guides pratiques, où un lecteur a terminé la tâche ou non. Dans un tableau de paramètres, une évaluation ne vous apprend presque rien.
  • Nous ne publions aucune référence indiquant à quoi ressemble un taux de retour dans Docsbook. Aucune distribution entre clients n’a été mesurée ; il n’existe donc aucun nombre « sain » auquel vous comparer. Les sources externes ci-dessus concernent les retours volontaires en général, et non les sites Docsbook.
  • Un champ de commentaire est présent dans la charge utile, mais rien ne le remplit. Si vous créez une interface qui en recueille un, le contrat du webhook dispose déjà d’un emplacement prévu à cet effet ; par défaut, il vaut toujours null.
  • Chat IA — l’assistant dont les réponses disposent de leurs propres pouces, séparés.
  • Qualité des réponses — ce qui arrive à une question à laquelle l’assistant n’a pas pu répondre.
  • Recherche en texte intégral — les recherches infructueuses sont l’autre signal indiquant qu’une page est absente ou mal nommée.
  • Analyse d’audience Web — vérifiez le trafic d’une page avant de la réécrire après trois votes.
  • Webhooksfeedback.received et chat.negative_feedback au complet, signés et réessayés.

Updated

Cette page vous a-t-elle été utile ?