Dokumentation & Wissensdatenbank

Halten Sie KI-Antworten synchron mit Ihrer Dokumentation

Ein Dokumentations-Release durchläuft die erneute Erfassung bis zur überprüften Antwort
Ein Dokumentations-Release durchläuft die erneute Erfassung bis zur überprüften Antwort

Eine Änderung an der Dokumentation zu veröffentlichen und einen Assistenten zu aktualisieren, sind zwei getrennte Ereignisse. Ein regelmäßiger Erfassungsjob verbindet sie, indem er die ausgewählten Dokumentationsseiten erneut besucht und den aktuellen Text in den Datensatz übernimmt.

Der Zeitplan sollte sich am Release-Prozess der Dokumentation orientieren, nicht an einem beliebigen SEO-Ziel.

Stimmen Sie Jobs auf Dokumentationsversionen ab

Liegen aktuelle und ältere Dokumentation unter verschiedenen Pfaden, erfassen Sie sie in getrennte Datensätze oder schließen Sie die Versionen aus, die keine öffentlichen Fragen beantworten sollen.

Nehmen Sie zum Beispiel den Pfad der aktuellen Dokumentation auf und schließen Sie Archiv- oder Versionspfade aus, die nicht mehr gelten. Prüfen Sie die erlaubten Hostnamen, wenn die Dokumentation Subdomains nutzt.

Wählen Sie den Zeitplan

VeröffentlichungsmusterEmpfohlener Ausgangspunkt
Laufend kleine ÄnderungenTägliche Erfassung
Mehrere Releases pro TagErfassung alle paar Stunden, wenn die Aktualität es erfordert
Wöchentlicher Release-ZyklusErfassung nach dem Release oder alle sieben Tage
Kontrollierte Compliance-DokumenteManuelle Erfassung nach Freigabe

Seekdown bietet Intervalle von stündlich bis alle sieben Tage sowie die Option Never.

Zeitplanauswahl in Seekdown für die Erfassung von Dokumentation mit Beispieldaten
Zeitplanauswahl in Seekdown für die Erfassung von Dokumentation mit Beispieldaten

Ergänzen Sie das Release um Aktualitätsprüfungen

Für jede wesentliche Änderung an der Dokumentation:

  1. die geänderte Seite benennen;
  2. eine Frage festhalten, die von der Änderung betroffen ist;
  3. bestätigen, dass die nächste Erfassung abgeschlossen wird;
  4. die neue Formulierung im Datensatz finden;
  5. die festgehaltene Frage stellen; und
  6. die Quellenangabe öffnen.

Das ist zuverlässiger, als nur den Zeitstempel der Erfassung zu prüfen. Ein abgeschlossener Job kann eine URL trotzdem verpasst haben – wegen Pfadregeln, Tiefe oder eines Seitenfehlers.

Gehen Sie mit Entfernungen und Widersprüchen um

Wird ein Workaround oder eine alte Option entfernt, durchsuchen Sie den verbleibenden Datensatz nach der alten Formulierung. Release Notes, übersetzte Seiten und zwischengespeicherte Kopien können die veraltete Antwort weiterhin stützen.

Lassen Sie den Assistenten nicht stillschweigend zwischen widersprüchlichen Dokumenten wählen. Legen Sie eine aktuelle Quelle fest, entfernen Sie die veraltete Seite oder benennen Sie die Versionsgrenze ausdrücklich.

Regelmäßiges Crawling hält die Kopie der Quelle in Bewegung. Regressionsfragen zeigen, ob die Antwort mitgezogen ist.