KI-Dokumentationssuche
Leser einer Dokumentation wissen oft, was sie tun wollen, aber nicht, wie die Seite heißt, die es erklärt. Eine KI-Dokumentationssuche versteht die Aufgabe in den Worten des Lesers und liefert eine Antwort, die auf der indexierten Dokumentation beruht.
Sie sollte eine klare Navigation und die exakte Suche ergänzen, nicht die Dokumentation verstecken.
Beginnen Sie mit Aufgaben, nicht mit Seitenzahlen
Sammeln Sie Fragen aus Support-Tickets, der Website-Suche, dem Onboarding und Entwickler-Feedback. Ordnen Sie jede Frage der Seite zu, die sie beantworten soll.
Beispiele:
- „Wo erlaube ich meine Domain?“
- „Wie aktualisiere ich die erfassten Seiten?“
- „Welche Dateiformate kann ich hochladen?“
- „Warum wird der Assistent auf meiner Website nicht angezeigt?“
Erfordert eine Frage Informationen, die über mehrere Seiten verstreut sind, entscheiden Sie, ob die Dokumentation zusammengeführt werden sollte oder ob eine kombinierte Antwort mit Quellen tatsächlich nützlich ist.
Erfassen Sie die Grenzen der Dokumentation
Konfigurieren Sie den Website-Datenerfassungsjob mit dem Hostnamen der Dokumentation und dem relevanten Pfad. Schließen Sie alte Versionen, generierte Indexseiten, Kontoseiten und interne Inhalte aus.
Prüfen Sie gefundene Links und die Inhalte des Datensatzes, bevor Sie das Besuchererlebnis anbinden.
Wählen Sie die passende Oberfläche
Ein Suchcenter eignet sich, wenn die Suche die Hauptaufgabe in der Dokumentation ist und eine eigene öffentliche URL haben soll. Ein eingebetteter Assistent eignet sich, wenn Leser Fragen stellen sollen, ohne die aktuelle Anleitung zu verlassen.
Zeigen Sie in beiden Fällen Quellenlinks an, damit Leser Voraussetzungen, Code, Warnhinweise und weitere Details prüfen können.
Testen Sie, wie nützlich die Antworten sind
| Test | Bestanden, wenn |
|---|---|
| Aufgabenformulierung | Die Begriffe des Lesers die richtige Anleitung finden |
| Exakte Konfiguration | Werte und Oberflächenbezeichnungen mit der Quelle übereinstimmen |
| Mehrstufiger Ablauf | Die Antwort die dokumentierte Reihenfolge einhält |
| Versionsfrage | Die aktuelle Version verwendet wird |
| Nicht unterstützte Integration | Die Antwort keine Unterstützung erfindet |
| Quellenangabe | Der Link die Seite öffnet, die die genannte Angabe enthält |
Halten Sie die exakte Stichwortsuche für Kennungen, Fehlercodes, API-Methoden und bekannte Seitentitel verfügbar. Direkte Antworten und klassische Suche lösen unterschiedliche Aufgaben in der Dokumentation.
Werten Sie Gespräche aus, um fehlende Seiten und verwirrende Begriffe zu finden, verbessern Sie dann die Dokumentation und erfassen Sie sie erneut.