Suchcenter

Ein Suchcenter für Ihre Dokumentation aufbauen

Dokumentationsbereiche fließen in einen Datensatz und liefern eine Antwort zur Aufgabe mit versionsspezifischen Quellen
Dokumentationsbereiche fließen in einen Datensatz und liefern eine Antwort zur Aufgabe mit versionsspezifischen Quellen

Ein Dokumentations-Suchcenter gibt Lesern einen zentralen Ort, um Implementierungsfragen über ausgewählte Anleitungen hinweg zu stellen. Bauen Sie es entlang der gepflegten Dokumentation auf, nicht über die gesamte Unternehmenswebsite.

Den Umfang der Dokumentation festlegen

Listen Sie die Versionen, Produkte und Zielgruppen auf, die die Seite abdecken soll. Schließen Sie alte Releases, interne Runbooks, generierte Duplikate, Kontoseiten und Marketinginhalte aus, die keine Implementierungsfragen beantworten.

Müssen mehrere Versionen durchsuchbar bleiben, machen Sie die Version in Titeln und Quelltext sichtbar. Sonst kann eine korrekte Antwort für eine alte Version aktuell wirken.

Die Dokumentation erfassen und prüfen

Konfigurieren Sie einen Website-Datenerfassungsjob für den Hostnamen und die Pfade der Dokumentation. Legen Sie Crawling-Tiefe, einbezogene Pfade und Ausschlüsse bewusst fest.

Navigationseinstellungen des Seekdown-Crawlers zur Steuerung erfasster Pfade und der Tiefe mit Beispieldaten
Navigationseinstellungen des Seekdown-Crawlers zur Steuerung erfasster Pfade und der Tiefe mit Beispieldaten

Prüfen Sie den Datensatz nach der Verarbeitung auf:

  • bekannte Seitentitel und codebezogene Begriffe;
  • korrekte kanonische URLs;
  • vollständige Abläufe und Voraussetzungen;
  • Versionsangaben;
  • doppelte Navigations- oder Druckseiten; und
  • veraltete Bereiche, die entfernt werden sollten.

Das Suchcenter anlegen

Wählen Sie beim Anlegen den Dokumentations-Datensatz aus. Verwenden Sie einen Titel und eine Beschreibung, die das abgedeckte Produkt und die Version nennen.

Ergänzen Sie aufgabenbasierte Vorschläge, zum Beispiel:

  • „Wie konfiguriere ich erlaubte Origins?“
  • „Welche Dateitypen kann ich hochladen?“
  • „Wie plane ich eine wiederkehrende Erfassung?“
  • „Was sollte ich prüfen, wenn die Einbettung nicht erscheint?“

Jeder Vorschlag muss auf eine gepflegte Seite verweisen, die die Antwort enthält.

Die Navigation über Antworten testen

Ein Suchcenter findet eine Antwort in der Dokumentation und zeigt drei Quellenkarten mit Beispielinhalten
Ein Suchcenter findet eine Antwort in der Dokumentation und zeigt drei Quellenkarten mit Beispielinhalten

Nutzen Sie eine Testmatrix mit exakten Funktionsnamen, Problembeschreibungen, versionsspezifischen Fragen und nicht abgedeckten Anfragen. Prüfen Sie sowohl die Antwort als auch die verlinkte Textstelle.

Bei Schritt-für-Schritt-Antworten bestätigen Sie, dass Voraussetzungen und Reihenfolge erhalten bleiben. Bei der Fehlerbehebung bestätigen Sie, dass das Ergebnis die Seite zum tatsächlichen Symptom zitiert und nicht eine allgemeine Einstiegsseite der Dokumentation.

Release-Änderungen synchron halten

Legen Sie einen Erfassungszeitplan fest, der zum Release-Prozess Ihrer Dokumentation passt. Prüfen Sie nach einem Release eine geänderte Angabe in der Quelle, im Datensatz-Eintrag und in der Antwort des Suchcenters.

Das Suchcenter ist eine Zugriffsschicht über der Dokumentation. Verantwortlichkeit für die Dokumentation, Versionskontrolle und Quellqualität bleiben das Fundament.