Beginnen Sie mit Ihrer öffentlichen Dokumentation, testen Sie echte technische Fragen und prüfen Sie die verlinkten Quellen, bevor Sie das Widget zu Ihrer Website hinzufügen.
Der Free-Tarif ist dauerhaft verfügbar: eine Website, bis zu 10 Seiten und 100 Nachrichten pro Monat, ohne Kreditkarte. Prüfen Sie Antworten und Quellen und betten Sie das Widget ein, sobald Sie bereit sind.
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.
Verwenden Sie Fragen, die Ihr Support und Ihre Community bereits kennen. Prüfen Sie jede Antwort und die dazugehörige Quellseite, bevor Sie das Widget veröffentlichen.
„Wie starte ich, authentifiziere mich und sende meine erste Anfrage?“
„Was bedeutet dieser Fehler und wo ist die Lösung dokumentiert?“
„Welche Planlimits, Rate Limits und Preise gelten für diese Funktion?“
„Muss ich meine Docs-Plattform migrieren oder kann das neben meiner aktuellen Website laufen?“
Nutzen Sie den Chatbot, um Entwicklern Endpunkte, Authentifizierungsschritte, Parameter, SDK-Methoden und bekannte Fehler zu zeigen, und verweisen Sie dann für den vollständigen Kontext zurück auf die Referenz. Ein plausibles Codebeispiel oder eine sichtbare Quellenangabe beweist kein korrektes API-Verhalten.
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 |
|---|---|---|
Fragenbereich API | Testfall Endpunkt, Pflichtfelder, Antwortstruktur und Ratenbegrenzung. | Erfolgskriterium Verwendet die dokumentierte Methode und den dokumentierten Pfad; erforderliche Werte und Quellenangabe stimmen mit der Referenz überein. |
Fragenbereich SDK | Testfall Eine unterstützte SDK-Version installieren und initialisieren. | Erfolgskriterium Paket, Import, Initialisierung und Codesyntax entsprechen der Sprache und Version. |
Fragenbereich CLI | Testfall Installieren, authentifizieren, einen Befehl ausführen und die Ausgabe interpretieren. | Erfolgskriterium Optionen und Reihenfolge sind gültig; die Antwort erfindet keine interaktiven Eingabeaufforderungen. |
Fragenbereich Authentifizierung | Testfall Speicherort der Anmeldedaten, Headerformat, Berechtigungsbereiche und ein unzulässiger Ablauf. | Erfolgskriterium Legt niemals ein Geheimnis offen, unterscheidet zwischen Client- und Servernutzung und belegt die Sicherheitsanforderung mit einer Quelle. |
Fragenbereich Paginierung | Testfall Erste Seite, Fortsetzung, letzte Seite und maximale Seitengröße. | Erfolgskriterium Verwendet das dokumentierte Cursor- oder Offset-Modell und nennt nur dokumentierte Grenzwerte. |
Fragenbereich Fehler | Testfall Bekannter Fehlercode, wahrscheinliche Ursache, Behebungsschritt und unbekannter Code. | Erfolgskriterium Ordnet bekannte Fehler korrekt zu und weicht bei undokumentierten Ursachen aus. |
Fragenbereich Migrationen | Testfall Inkompatible Änderung, Voraussetzung, geordnete Schritte und Hinweis zum Rollback. | Erfolgskriterium Behält Reihenfolge und Warnungen bei, ohne alte und neue Verfahren zu vermischen. |
Fragenbereich Versionierte Dokumentation | Testfall Dieselbe Verhaltensfrage für die aktuelle, eine frühere und eine nicht angegebene Version stellen. | Erfolgskriterium 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 |
|---|---|
Dimension Antwortqualität | Nur akzeptieren, wenn Alle erforderlichen Fakten sind korrekt, relevant und widerspruchsfrei und verwenden die angeforderte API-, SDK-, CLI- oder Dokumentationsversion. |
Dimension Genauigkeit der Quellenangaben | Nur akzeptieren, wenn Jede wesentliche Aussage besitzt eine erreichbare Quellenangabe, die sie auf der richtigen versionierten Seite direkt belegt. |
Dimension Ausweichverhalten | Nur akzeptieren, wenn 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. |
Dimension Freigabekriterium | Nur akzeptieren, wenn 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.
Jede folgende Zahl ist ein hypothetisches Beispiel für einen Testfall mit 24 Fragen, kein gemessenes Ergebnis von ChattyBox, kein Produktionsdurchschnitt und kein Versprechen für die künftige Leistung.
| Beispielergebnis, nicht gemessen | So verwenden Sie das Beispiel |
|---|---|
Beispielergebnis, nicht gemessen Beispiel: 22 von 24 akzeptiert (91.7 %) | So verwenden Sie das Beispiel Beispielinterpretation: 20 belegte Antworten und zwei korrekte Ausweichantworten. |
Beispielergebnis, nicht gemessen Beispiel: 20 von 22 inhaltlichen Antworten verwiesen direkt auf unterstützende Seiten (90.9 %) | So verwenden Sie das Beispiel Beispielinterpretation: Unter dem Freigabekriterium von 95 %, daher muss das Versionsranking korrigiert werden. |
Beispielergebnis, nicht gemessen Beispiel: 2 von 2 erwarteten Ausweichantworten waren korrekt (100 %) | So verwenden Sie das Beispiel Beispielinterpretation: In diesem kleinen Testfall wich kein beantwortbarer Fall fälschlicherweise aus. |
Beispielergebnis, nicht gemessen Beispiel: 1 von 24 enthielt ein unbelegtes Paginierungsdetail (4.2 %) | So verwenden Sie das Beispiel Beispielinterpretation: Blockieren Sie den Start, bis die unbelegte Aussage entfernt wurde und der Regressionstest bestanden ist. |
Speziell entwickelte Workflows, die Antworten für technische Nutzer nachvollziehbar, quellenbasiert und nützlich halten.
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 |
|---|---|
Kennzahl Antwortrate | Definition und Maßnahme 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. |
Kennzahl Ungelöste Fragen | Definition und Maßnahme Fragen mit Ausweichantwort, negativem Feedback, wiederholter Umformulierung oder Eskalation. Prüfen Sie wöchentlich eine Stichprobe auf Antwort- und Abruffehler. |
Kennzahl Inhaltslücken | Definition und Maßnahme 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. |
Kennzahl Belegquote der Quellenangaben | Definition und Maßnahme Geprüfte wesentliche Aussagen mit einer direkt belegenden Quellenangabe. Untersuchen Sie Rückgänge nach Quelle und Version. |
Kennzahl Ticketvermeidung | Definition und Maßnahme 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 Prüfkatalog für API-Dokumentation 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.
Ja, wenn Endpunktreferenzen, Parameter, Authentifizierungsleitfäden, SDK-Beispiele und Fehlerdetails in indexierten öffentlichen Inhalten vorhanden sind. Er führt keine API-Aufrufe aus und prüft keine privaten Konten. Abgerufener Kontext und Quellenangaben verhindern kein erfundenes API-Verhalten; testen Sie wichtige Aussagen anhand der Referenz.
Nein. Free ist ein dauerhafter Nachweis im kleinen Umfang: eine Website, bis zu 10 Seiten und 100 Nachrichten pro Monat, ohne Kreditkarte.
Beginnen Sie mit den öffentlichen Seiten, die häufige Fragen zu Einrichtung, Fehlerbehebung, Preisen und Produkten beantworten. Nachdem Sie die ersten Antworten geprüft haben, können Sie den Quellumfang erweitern.
Fügen Sie weitere Seiten hinzu, wenn der erste Testsatz nützlich ist und die unterstützenden Quellen aktuell sind. Halten Sie private, veraltete und nicht relevante Seiten aus dem Chatbot heraus.
Ja. Crawlen Sie die ausgewählten öffentlichen Docs, stellen Sie echte technische Fragen und öffnen Sie die zitierten Quellseiten, um Antworten vor der Widget-Installation auf Ihrer Docs-Seite zu prüfen.
Der Assistent sollte die Einschränkung nennen oder einen hilfreichen nächsten Schritt anbieten, statt zu raten. Behandeln Sie nicht unterstützte Antworten als Testfall und als mögliche Dokumentationslücke zur Prüfung.
Starten Sie mit dem dauerhaft kostenlosen Free-Test für ausgewählte öffentliche Seiten, testen Sie technische Fragen und prüfen Sie die Quellen vor dem Einbetten des Widgets.
Wir verwenden optionale Analyse- und Tag-Management-Tools, um zu verstehen, wie die Website genutzt wird. Entscheiden Sie, ob Sie Ahrefs Web Analytics, PostHog und Google Tag Manager erlauben möchten. Wenn Sie die Analyse deaktivieren, wird diese Seite neu geladen, damit die Änderung sauber wirksam wird. Die grundlegenden Funktionen der Website und die Fehlerüberwachung werden von dieser Auswahl nicht gesteuert. Datenschutzerklärung lesen.
