Seitenfeedback
Das Seitenfeedback in Docsbook ist ein War diese Seite hilfreich?-Element, auf das Leser mit einem Klick antworten – ohne Formular, E-Mail-Adresse oder Konto. Die Abstimmung wird als Ereignis für diese Seite und als Webhook erfasst, auf den du reagieren kannst. Das Erfassen löst kein Modell auf und kostet nichts.
Die Bewertung ist ein Hinweis, keine Punktzahl. Auf dieser Seite geht es ebenso sehr darum, was ein Daumen nach unten nicht beweist, wie darum, wie man eine solche Bewertung erfasst.
Was Sie erhalten#
- Eine Ein-Klick-Bewertung auf jeder Seite, an einer oder zwei Stellen, in jedem Tarif.
- Eine Bewertung, die sofort Ihre eigenen Systeme erreicht — ein
feedback.received-Webhook und ein zweiterchat.negative_feedback-Webhook bei einem Daumen nach unten, sodass eine negative Bewertung genau in dem Moment in den Kanal Ihres Teams gelangen kann, in dem sie abgegeben wird. - Eine Spur pro Leser. In der Besucher-Timeline wird die Bewertung als „Seite als hilfreich bewertet“ oder „Seite als nicht hilfreich bewertet“ angezeigt, neben allem anderen, was dieser Leser getan hat – dort wird eine einzelne Bewertung interpretierbar.
- Eine Warteschlange, die bereits weiß, was damit zu tun ist. Zwei bereits ausgelieferte Agenten-Routen beginnen mit negativem Feedback bzw. unbeantworteten Chatfragen und enden bei einem Seitenentwurf.
Was kann ein Leser bewerten?#
Es gibt drei Steuerelemente, und sie messen nicht dasselbe.
| Unter der Seite | Im Bereich „Auf dieser Seite“ | Unter einer KI-Antwort | |
|---|---|---|---|
| Was bewertet wird | Die Seite | Die Seite | Diese eine Assistentenantwort |
| Wo | Am Ende des Artikels, über den Links für vorherige/nächste Seite | In der Gliederung, unter dem Inhaltsverzeichnis | Neben jeder Antwort im Chatbereich |
| Einstellung | Diese Seite bewerten (Registerkarte „Inhalt“) | Seite bewerten (Registerkarte „Rechte Seitenleiste“) | Teil des KI-Chats |
| Standard | Ein | Aus | Mit dem Chat |
| Auf einem Smartphone | Inline angezeigt | Hinter der schwebenden Schaltfläche für die Gliederung als Bottom Sheet | Angezeigt |
| Geschriebenes Ereignis | docs.page_feedback_up / _down |
Dasselbe | docs.ai_like / docs.ai_dislike |
Die Leiste unter der Seite ist diejenige, die die meisten Projekte aktivieren möchten. Ein Leser erreicht sie, indem er die Seite zu Ende liest – genau in dem Moment, in dem er sich eine Meinung gebildet hat; das Steuerelement in der Gliederung wird nur von einem Leser gesehen, dessen Blick bereits auf die rechte Seitenleiste gerichtet ist. Die beiden Steuerelemente für die Seite schreiben in eine Serie – sie sind zwei Stellen, an denen gefragt wird, und keine zwei Metriken.
Die Daumenbewertung der KI-Antworten gehört tatsächlich zu einer anderen Serie und enthält andere Felder: die Konversations-ID und die Frage, die die Bewertung ausgelöst hat, denn eine Bewertung, die nur einen Pfad enthält, ist ein Zähler, mit dem niemand etwas anfangen kann. Problem melden im Überlaufmenü der Antwort schreibt dasselbe Negativbewertungsereignis.
Eine Bewertung pro Steuerelement und Seitenaufruf. Nach der Bewertung werden die Schaltflächen gesperrt und ein kurzer Dank ersetzt die Frage. Die Sperre gilt pro Steuerelement. Ein Projekt, bei dem beide Steuerelemente für die Seite aktiviert sind, kann daher zwei Bewertungen desselben Lesers auf derselben Seite erfassen – bewusst so vorgesehen: Ein Leser, der absichtlich zweimal abstimmt, teilt Ihnen zweimal dasselbe mit, und eine Deduplizierung über verschiedene Oberflächen hinweg würde einen gemeinsamen Zustand erfordern, ohne den Informationsgehalt zu erhöhen.
Seitenfeedback aktivieren#
Unterhalb der Seite (standardmäßig aktiviert):
- Öffnen Sie Ihre Dokumentationsseite, während Sie angemeldet sind.
- Öffnen Sie Float Widget → Einstellungen → den Tab Inhalt.
- Aktivieren Sie Diese Seite bewerten.
Im Bereich „Auf dieser Seite“:
- Öffnen Sie Float Widget → Einstellungen → den Tab Rechte Seitenleiste.
- Aktivieren Sie Seite bewerten.
Beide können auch über einen MCP-Client mit update_ui_settings (show_content_feedback, show_page_feedback) festgelegt werden.
Was pro Bewertung gespeichert wird#
Eine Seitenbewertung ist bewusst schlank. Keines der beiden Seitenelemente enthält ein Freitextfeld, eine Sitzungs-ID oder etwas, das ein Leser eingegeben hat:
| Wohin es geht | Was es enthält |
|---|---|
| Analyseereignis | Ereignisname (docs.page_feedback_up oder _down), Ihr Projekt, der Seitenpfad, die IP-Adresse und das Land des Lesers. Die Richtung ist im Ereignisnamen kodiert, da das Schema des Analysedatensatzes ein unbekanntes Feld vote direkt ablehnt |
feedback.received-Webhook |
page_path, vote (up/down), comment (von diesen Seitenelementen immer null), country — sowie eine Besucher-ID |
chat.negative_feedback-Webhook, nur bei einer negativen Bewertung |
session_id, page_path, type (thumbs_down), comment |
| Besucheridentität | Ein gesalzener SHA-256-Hash der IP-Adresse des Lesers, auf Ihr Projekt beschränkt und auf 16 hexadezimale Zeichen gekürzt. Es ist derselbe Hash, den der Rest Ihrer Analysen verwendet, sodass eine Bewertung mit den anderen Ereignissen dieses Lesers verknüpft werden kann — und er lässt sich nicht in eine Adresse zurückverwandeln |
Zwei Verhaltensweisen sollten Sie kennen, da sie die Bedeutung Ihrer Zahlen verändern:
- Bewertungen Ihres eigenen Teams werden aus den Analysen ausgeschlossen, aber weiterhin an Ihre Webhooks gesendet. Interner Datenverkehr wird beim Schreiben der Analysen übersprungen, da das Testen Ihrer eigenen Seite kein Signal eines Lesers ist — der Eigentümer soll jedoch weiterhin darüber informiert werden, dass eine Bewertung abgegeben wurde.
- Das Feld
commentist in der Payload vorhanden und wird von diesen Seitenelementen nie ausgefüllt. Es ist für eine Oberfläche vorgesehen, die ein solches Feld erfasst; derzeit tut dies keines der beiden Seitenelemente.
Eine Bewertung einer KI-Antwort speichert das Projekt, auf welcher Seite sich der Leser befand, die Konversations-ID und die Frage — keinen Antworttext und keine Leseridentität über denselben IP-Hash hinaus.
Was der Eigentümer sieht#
| Oberfläche | Was angezeigt wird | Plan |
|---|---|---|
| Analytics → Feedback-Tab | Positive und negative Bewertungen, insgesamt und pro Seite, die 20 wichtigsten Zeilen, sortiert nach negativen Bewertungen zuerst — die negativ bewertete Seite ist diejenige, die korrigiert werden sollte, die positiv bewertete bestätigt nur, was bereits funktioniert | Jeder Plan |
| Feeds / Besucher-Timeline | Jede Bewertung als eigenes Ereignis im Verlauf eines Lesers, als Erfolg oder Problem gekennzeichnet | Jeder Plan |
feedback.received- und chat.negative_feedback-Webhooks |
Die Bewertung in dem Moment, in dem sie abgegeben wird, an eine URL deiner Wahl — signiert und mit Wiederholungsversuchen, anders als bei Chat-Hooks | Jeder Plan |
get_negative_feedback (MCP) |
Nach negativen Bewertungen sortierte Seiten | Pro |
get_ai_unanswered (MCP) |
Chat-Fragen, auf die keine Antwort gegeben wurde — die andere Hälfte desselben Signals | Pro |
Das Registrieren eines Webhooks ist in jedem Plan möglich; sowohl der MCP-Pfad als auch der REST-Pfad prüfen dieselbe Berechtigung, und nur drei erweiterte Ereignisse (Verkehrsspitze, Verkehrsrückgang, aufgerufenes MCP-Tool) sind davon ausgenommen. Mehrere Beschreibungen von MCP-Tools weisen diese beiden Ereignisse weiterhin als Pro aus — dieser Text ist veraltet und entspricht nicht dem tatsächlichen Verhalten.
In Frage gestellt — lies den Feedback-Tab als Reihe von KI-Antworten, nicht als Reihe von Seiten. Die Summen und Zeilen pro Seite im Tab werden aus einer Abfrage über
docs.ai_like/docs.ai_dislikeerstellt, den Ereignissen, die durch die Bewertungen der KI-Antwort geschrieben werden. Die Seitensteuerungen schreibendocs.page_feedback_up/_down, und keine Abfrage hinter diesem Tab liest sie aus. Daher erreicht eine heute abgegebene Seitenbewertung deine Webhooks und die Besucher-Timeline, nicht jedoch die Zähler des Feedback-Tabs.get_negative_feedbackhat dieselbe Struktur: Der eigene Codekommentar weist darauf hin, dass das Ereignis auf Seitenebene „not folded in here“ ist. Bis dies korrigiert ist, betrachte den Feedback-Tab als Messung der Antworten des Assistenten und verwende den Ereignis-Feed oder einen Webhook für Seitenbewertungen.
Von einem Daumen nach unten zur nächsten Seite, die Sie schreiben#
Eine Bewertung ist nicht die Erkenntnis. Nutzbar wird sie durch das, was danebensteht: die Suchen, die keine Ergebnisse lieferten, die Fragen, die der Assistent nicht beantworten konnte, und das, was der Leser nach seiner Bewertung getan hat.
Zwei Agent-Routen werden bereits mit dieser Abfolge ausgeliefert, beide im Pro-Tarif:
Dokumentation anhand von Nutzerfeedback verbessern — sollte wöchentlich ausgeführt werden. Die Route liest die Seiten, die Leser als schlecht markiert haben, und liest dann was frühere Korrekturen an diesen Seiten bereits bewirkt haben, bevor sie eine davon wiederholt. Anschließend fragt sie, welche Aufgabe der Leser erledigen wollte, und bearbeitet die Seite erst dann. Der Schritt zur Änderungshistorie existiert, weil die Version ohne ihn die Qualität einer Seite wenige Sekunden nach ihrer Überarbeitung maß — ein Wert, der sich zu diesem Zeitpunkt noch gar nicht verändert haben kann.
Lücken anhand von Assistentenunterhaltungen schließen — sollte beim chat.no_answer-Ereignis ausgeführt werden. Die Route liest die Fragen, die der Assistent nicht beantworten konnte, unterscheidet eine Dokumentationslücke von einer schlecht gestellten Frage, wählt diejenige aus, deren Erstellung sich heute lohnt, und erstellt einen Entwurf für diese Seite.
Die Prompts hinter jeder Schaltfläche Verbessern im Panel enthalten dieselben vier Regeln, die auch manuell angewendet werden sollten: Bewerten Sie jede Zahl im Vergleich zu etwas und nennen Sie, womit Sie sie verglichen haben; zitieren Sie die Seiten und Ereignisse, die Sie tatsächlich gelesen haben; eine Kennzahl, die Sie nicht lesen können, fehlt — sie ist nicht null; und stoppen Sie bei der Diagnose, bevor Sie irgendetwas bearbeiten.
Das Erfassen einer Bewertung ruft kein Modell auf und wird nicht abgerechnet. Die Agent-Routen oben verwenden Modelle und greifen auf das Guthaben Ihres Projekts zurück — siehe die Preisseite.
Warum dies der richtige Weg ist (Belege)#
| Regel | Warum es funktioniert | Quelle |
|---|---|---|
| Betrachten Sie die Bewertung als Hinweis, niemals als Bewertung einer Seite | Freiwillige Bewertungssysteme weisen zwei Selektionsverzerrungen auf — Akquisitionsverzerrung und Verzerrung durch Untererfassung, wobei „Verbraucher mit extremen, entweder positiven oder negativen, Bewertungen eher Rezensionen schreiben als Verbraucher mit moderaten Produktbewertungen“ — die gemeinsam „den Mittelwert der Bewertungen zu einem verzerrten Schätzer der Produktqualität machen“ | Hu, Pavlou & Zhang, 2017 — Zu Selektionsverzerrungen in Online-Produktbewertungen, MIS Quarterly 41(2) |
| Gehen Sie davon aus, dass fast niemand abstimmt, und werten Sie Schweigen nicht als Zustimmung | In vier langjährig bestehenden Online-Communities mit 63.990 Teilnehmern und 578.349 Beiträgen beobachtet: „weniger als 25 % der Akteure veröffentlichten einen oder mehrere Beiträge“, und das oberste 1 % erstellte 74,7 % der Inhalte | van Mierlo, 2014 — Die 1-%-Regel in vier digitalen Gesundheitsnetzwerken, JMIR (begutachtete Beobachtungsstudie) |
| Schließen Sie nicht allein aus einer geringen Anzahl von Stimmen, dass eine Seite schlecht ist | „Nichtbeantwortung kann, muss aber nicht, zu einer Verzerrung der Nichtbeantwortung in Schätzungen aus Befragungen führen“, und „es gibt keine minimale Rücklaufquote, unterhalb derer Schätzungen aus Befragungen zwangsläufig einer Verzerrung unterliegen“ — die Quote selbst ist nicht das Problem | Groves, 2006 — Rücklaufquoten und Verzerrungen durch Nichtbeantwortung in Haushaltsbefragungen, Public Opinion Quarterly 70(5) |
| Kombinieren Sie jede Bewertung mit dem Verhalten in ihrem Umfeld, bevor Sie handeln | Die Verzerrung „tritt in Abhängigkeit davon auf, wie stark die Umfragevariable mit der Wahrscheinlichkeit ihrer Messung korreliert ist“ — die Frage lautet also nicht, wie viele abgestimmt haben, sondern ob sich die abstimmenden Leser in Bezug auf das, was Sie messen, unterscheiden. Ein verwirrter Leser und ein zufriedener Leser drücken nicht gleich häufig den Knopf | Groves, 2006 — derselbe Artikel |
Die praktische Schlussfolgerung aus diesen vier Zeilen: Eine Seite mit zehn Daumen nach unten ist es wert, geöffnet zu werden; eine Seite mit drei Daumen nach oben ist kein Beleg dafür, dass sie funktioniert; und eine Seite ganz ohne Stimmen ist eine Seite, über die Sie nichts wissen, nicht eine Seite, die niemandem gefallen hat.
Einschränkungen#
- Der Tab „Feedback“ zählt derzeit keine Seitenbewertungen. Siehe den Block unter der Frage oben. Dies ist die einzige Aussage auf dieser Seite, die in einer früheren Version dieser Dokumentation falsch war, und sie wird hier genannt, anstatt stillschweigend entfernt zu werden.
- Eine Bewertung enthält keinen Grund. Keine der beiden Seitensteuerungen erfasst Freitext, daher sagt ein Daumen nach unten lediglich, dass etwas falsch war, aber niemals was. Die Ablehnung einer KI-Antwort ist nur deshalb aussagekräftiger, weil sie die Frage enthält.
- Bewertungen gelten pro Ansicht, nicht pro Leser. Ein Leser, der morgen wiederkommt, kann erneut abstimmen, und ein Projekt, bei dem beide Seitensteuerungen aktiviert sind, kann bei einer Seitenansicht zwei Stimmen von einem Leser erhalten.
- Feedback ist auf Anleitungsseiten am aussagekräftigsten — bei Tutorials und Anleitungen, bei denen ein Leser die Aufgabe entweder abgeschlossen hat oder nicht. Bei einer Parametertabelle sagt eine Bewertung nahezu nichts aus.
- Wir veröffentlichen keinen Benchmark dafür, wie hoch eine Feedbackrate bei Docsbook aussieht. Es wurde keine kundenübergreifende Verteilung gemessen, daher gibt es keine „gesunde“ Zahl, mit der Sie sich vergleichen können. Bei den oben genannten externen Quellen geht es um freiwilliges Feedback im Allgemeinen, nicht um Docsbook-Seiten.
- Ein Kommentarfeld ist in der Nutzlast vorhanden, und nichts füllt es aus. Wenn Sie eine Oberfläche erstellen, die einen Kommentar erfasst, enthält der Webhook-Vertrag bereits einen Platz dafür; standardmäßig ist es immer
null.
Verwandte Themen#
- KI-Chat — der Assistent, dessen Antworten eigene, separate Daumenbewertungen haben.
- Antwortqualität — was mit einer Frage geschieht, die der Assistent nicht beantworten konnte.
- Volltextsuche — fehlgeschlagene Suchen sind ein weiteres Signal dafür, dass eine Seite fehlt oder falsch benannt ist.
- Webanalyse — prüfen Sie den Traffic einer Seite, bevor Sie sie aufgrund von drei Bewertungen überarbeiten.
- Webhooks —
feedback.receivedundchat.negative_feedbackvollständig, signiert und erneut versucht.