Ein KI-Chatbot für technische Dokumentationsteams, die quellenzitierte Antworten und weniger Support-Tickets benötigen. ChattyBox beantwortet Fragen wie „Wie authentifiziere ich API-Anfragen?“ direkt aus Ihrer Dokumentation und verlinkt die verwendete Seite – ohne benutzerdefiniertes RAG und ohne Migration.
Allzweck-KI-Chatbots versuchen, Gesprächspartner zu sein. Ohne Quellenanbindung können sie selbstsicher aus dem falschen Kontext antworten.
Wir verwenden Retrieval-Augmented Generation für Ihre veröffentlichten Docs und Website-Inhalte und zeigen anschließend Quelllinks, aus denen Antworten stammen.
Für Teams, die sichtbare Nachweise in jeder Antwort brauchen, vergleichen Sie den Workflow für einen KI-Chatbot mit Quellenangaben der Dokumentationstraffic mit unterstützenden Seiten verbindet.
Ein Dokumentations-Chatbot schafft Vertrauen, wenn er die wiederkehrenden Fragen beantwortet, die Ihr Support und Ihre Community bereits sehen — und die verwendete Seite zitiert. Das sind Beispiele, die ChattyBox aus indexierten Dokumentationsinhalten beantwortet.
Erstellen Sie den Testsatz aus realen Dokumentationsaufgaben, ordnen Sie jeder beantwortbaren Frage eine Referenzquelle und erwartete Fakten zu und nehmen Sie Fragen auf, die der Assistent ablehnen muss. Bewerten Sie jede Kategorie separat, damit ein starkes API-Ergebnis keine schwachen Anleitungen zu Migration oder Authentifizierung verdeckt.
Führen Sie die Testsuite vor dem Start, nach wesentlichen Änderungen an Dokumentation oder Abruf sowie nach dem Start anhand einer planmäßigen monatlichen Stichprobe erneut aus.
| Fragenbereich | Testfall | Erfolgskriterium |
|---|---|---|
| API | Endpunkt, Pflichtfelder, Antwortstruktur und Ratenbegrenzung. | Verwendet die dokumentierte Methode und den dokumentierten Pfad; erforderliche Werte und Quellenangabe stimmen mit der Referenz überein. |
| SDK | Eine unterstützte SDK-Version installieren und initialisieren. | Paket, Import, Initialisierung und Codesyntax entsprechen der Sprache und Version. |
| CLI | Installieren, authentifizieren, einen Befehl ausführen und die Ausgabe interpretieren. | Optionen und Reihenfolge sind gültig; die Antwort erfindet keine interaktiven Eingabeaufforderungen. |
| Authentifizierung | Speicherort der Anmeldedaten, Headerformat, Berechtigungsbereiche und ein unzulässiger Ablauf. | Legt niemals ein Geheimnis offen, unterscheidet zwischen Client- und Servernutzung und belegt die Sicherheitsanforderung mit einer Quelle. |
| Paginierung | Erste Seite, Fortsetzung, letzte Seite und maximale Seitengröße. | Verwendet das dokumentierte Cursor- oder Offset-Modell und nennt nur dokumentierte Grenzwerte. |
| Fehler | Bekannter Fehlercode, wahrscheinliche Ursache, Behebungsschritt und unbekannter Code. | Ordnet bekannte Fehler korrekt zu und weicht bei undokumentierten Ursachen aus. |
| Migrationen | Inkompatible Änderung, Voraussetzung, geordnete Schritte und Hinweis zum Rollback. | Behält Reihenfolge und Warnungen bei, ohne alte und neue Verfahren zu vermischen. |
| Versionierte Dokumentation | Dieselbe Verhaltensfrage für die aktuelle, eine frühere und eine nicht angegebene Version stellen. | Beantwortet die genannte Version, fragt bei Mehrdeutigkeit nach und verweist auf diese Version. |
Veröffentlichen Sie die Regeln vor dem Test. Prüfende sollten anhand der Antwort, der erwarteten Fakten und der zitierten Quelle zum selben Ergebnis gelangen, ohne sich darauf zu verlassen, wie überzeugend die Antwort klingt.
| Dimension | Nur akzeptieren, wenn |
|---|---|
| Antwortqualität | Alle erforderlichen Fakten sind korrekt, relevant und widerspruchsfrei und verwenden die angeforderte API-, SDK-, CLI- oder Dokumentationsversion. |
| Genauigkeit der Quellenangaben | Jede wesentliche Aussage besitzt eine erreichbare Quellenangabe, die sie auf der richtigen versionierten Seite direkt belegt. |
| Ausweichverhalten | Fehlende, mehrdeutige, widersprüchliche oder unzulässige Nachweise führen statt zu einer Vermutung zu einer klaren Einschränkung und einem hilfreichen nächsten Schritt. |
| Freigabekriterium | Keine unbelegten kritischen Aussagen zu Authentifizierung oder Migration, 100 % bestandene kritische Fälle, mindestens 90 % Gesamtakzeptanz und mindestens 95 % Genauigkeit der Quellenangaben. |
Methode: Formulieren Sie vor der Ausführung des Assistenten 24 Fragen, drei für jeden Matrixbereich. Halten Sie für jede Frage die vorgesehene Version, die Referenzseite, erforderliche Fakten, unzulässige Aussagen und die Erwartung eines Ausweichverhaltens fest. Zwei Prüfende bewerten die eingefrorenen Antworten unabhängig voneinander, klären Abweichungen anhand der Quelle und bewahren Prompts und Ausgaben für Regressionstests auf.
Die folgenden Zahlen sind ein veranschaulichendes Ergebnis für diesen Testfall mit 24 Fragen, kein gemessener ChattyBox-Produktionsdurchschnitt und keine Zusage künftiger Leistung.
| Beobachtetes Ergebnis | Interpretation |
|---|---|
| 22 von 24 akzeptiert (91,7 %) | Umfasst 20 belegte Antworten und zwei korrekte Ausweichantworten. |
| 20 von 22 inhaltlichen Antworten zitierten direkt belegende Seiten (90,9 %) | Unter dem Freigabekriterium von 95 %; die Versionsrangfolge muss korrigiert werden. |
| 2 von 2 erwarteten Ausweichantworten waren korrekt (100 %) | In diesem kleinen Testfall wich kein beantwortbarer Fall fälschlicherweise aus. |
| 1 von 24 enthielt ein unbelegtes Paginierungsdetail (4,2 %) | Die Freigabe bleibt blockiert, bis die unbelegte Aussage entfernt ist und der Regressionstest besteht. |
Speziell entwickelte Workflows, die dafür sorgen, dass die Antworten präzise, nachvollziehbar und für technische Benutzer nützlich sind.
Geben Sie die URL Ihrer Dokumentation, Website oder Sitemap ein. ChattyBox crawlt und indiziert die Seiten, die Nutzer bereits lesen.
Der Antwortfluss ist so konfiguriert, dass er abgerufenen Kontext nutzt und unbelegte API-, Feature-, Preis- oder Richtlinienaussagen vermeidet.
Antworten können Links zu den Dokumentationsseiten enthalten, auf denen die relevanten Informationen stehen.
Behandeln Sie den Start wie eine Dokumentationsveröffentlichung mit Verantwortlichen, Freigabekriterien, Beobachtbarkeit und einem Rollback-Pfad.
Segmentieren Sie jede Kennzahl nach Thema, Dokumentationsversion, Sprache und Zielgruppe, sofern die Stichprobengröße dies zulässt. Trends und geprüfte Stichproben sind nützlicher als ein einzelner Gesamtwert.
| Kennzahl | Definition und Maßnahme |
|---|---|
| Antwortrate | Anteil der Fragen, die eine inhaltliche Antwort erhalten. Prüfen Sie Themen mit niedriger Quote auf fehlende Inhalte; verbessern Sie die Zahl nicht durch schwächeres Ausweichverhalten. |
| Ungelöste Fragen | Fragen mit Ausweichantwort, negativem Feedback, wiederholter Umformulierung oder Eskalation. Prüfen Sie wöchentlich eine Stichprobe auf Antwort- und Abruffehler. |
| Inhaltslücken | Ungelöste Gruppen, für die keine maßgebliche Seite existiert. Übernehmen Sie diese mit Häufigkeit und Auswirkung auf Nutzende in den Dokumentations-Backlog. |
| Belegquote der Quellenangaben | Geprüfte wesentliche Aussagen mit einer direkt belegenden Quellenangabe. Untersuchen Sie Rückgänge nach Quelle und Version. |
| Ticketvermeidung | Geeignete Sitzungen, die ohne Support-Ticket gelöst werden, gemessen in einem definierten Zeitraum und mit einer Basislinie verglichen. Berichten Sie einen Zusammenhang, sofern ein Experiment keine Kausalität belegt. |
Nutzen Sie den Leitfaden zu RAG-Architektur und -Bewertung zur Diagnose des Abrufs, den Arbeitsablauf für Quellenangaben zur Prüfung von Nachweisen, den Leitfaden für Entwicklerdokumentation für entwicklungsspezifische Anwendungsfälle und die technische Einführungscheckliste für Bereitstellungsschritte.
Diese Antworten fassen zusammen, wie ChattyBox Quellinhalte liest, Dokumentationsseiten zitiert, fehlende Informationen verarbeitet und zusammen mit einem vorhandenen Dokumentationsstapel installiert.
ChattyBox durchsucht Ihre veröffentlichten Dokumente, Websites, Sitemaps, CMS- oder Help-Center-Seiten, extrahiert lesbaren Text und ruft relevante Passagen ab, wenn ein Besucher eine Frage stellt.
Ja. Wenn Quellmaterial verfügbar ist, kann ChattyBox Links zurück zu den Dokumentationsseiten anzeigen, die für die Antwort verwendet wurden, damit Benutzer Details überprüfen und weiterlesen können.
Der Assistent soll nicht unterstützte Behauptungen vermeiden und kann zurückgreifen, wenn indizierte Inhalte keine Antwort enthalten. Diese Lücken können Einfluss auf zukünftige Dokumentationsaktualisierungen haben.
Nein. Sie können Ihren aktuellen Dokumentenstapel behalten und das ChattyBox-Widget einbetten, nachdem Sie die in der Quelle zitierten Antworten gecrawlt und getestet haben.
Nutzen Sie ChattyBox, um wiederkehrende Dokumentationsfragen aus Quelleninhalten zu beantworten und Lücken in Ihren Dokumentations-Backlog zurückzuführen.
