Durchsuchen Sie Ihr Hilfezentrum
Leser durchsuchen Ihr öffentliches Hilfezentrum über den Suchdialog. Die Ergebnisse können sowohl Artikel als auch API-Referenzoperationen in einer gemeinsamen, nach Relevanz sortierten Liste enthalten. Bei themenfremden Suchanfragen werden möglicherweise weniger oder gar keine Treffer angezeigt.
Suche öffnen
Öffnen Sie die Suche in Ihrem öffentlichen Hilfezentrum mit ⌘K (Mac) oder Ctrl+K (Windows/Linux). Der Dialog zeigt oben ein Suchfeld an.
Der Platzhalter lautet Nach einem Artikel suchen oder KI fragen ..., wenn „Ask AI“ verfügbar ist, und andernfalls Nach einem Artikel suchen ....
Dies unterscheidet sich von der Thread-Suche im Fern-Arbeitsbereich, die nur Fern-Threads und keine veröffentlichten Dokumentationen durchsucht.
Was in den Ergebnissen angezeigt wird
Passende Ergebnisse können auf derselben Seite zwei Typen miteinander kombinieren:
Artikel: der Artikeltitel und ein hervorgehobener Ausschnitt
API-Referenzoperationen: die HTTP-Methode, der Pfad und optional ein hervorgehobener Ausschnitt
Es werden nur Inhalte berücksichtigt, die öffentlich und für den Leser sichtbar sind. Inhalte, auf die der Leser nicht zugreifen kann, werden aus der öffentlichen Suche ausgeschlossen. Autorisierte Leser können eingeschränkte Inhalte finden, einschließlich Inhalten in gesperrten Hilfezentren.
Artikel- und API-Ergebnisse werden gemeinsam sortiert, sodass die relevanteste Übereinstimmung für die Suchanfrage zu beiden Typen gehören kann. Relevante API-Operationen können über Artikeln erscheinen, wenn sie besser zur Suchanfrage passen – und umgekehrt gilt dasselbe.
Wenn die Suche weniger Ergebnisse liefert
Die Suche behält Ergebnisse bei, die für die Suchanfrage relevant sind. Die Seite wird nicht immer vollständig gefüllt.
Suchanfragen zu Ihrem Produkt sollten die passendsten Artikel und API-Operationen hervorbringen. Suchanfragen ohne passende Hilfeinhalte können eine kurze Liste oder gar keine Ergebnisse liefern. Wenn nichts übereinstimmt, zeigt der Dialog Keine Artikel gefunden an.
Wenn die Ergebnisse anders aussehen als bei einem früheren Besuch, kann sich durch eine geänderte Rangfolge die Reihenfolge der Treffer geändert haben oder schwache Übereinstimmungen werden möglicherweise nicht mehr angezeigt.
Sprache
Die Suche richtet sich nach der Sprache, in der der Leser die Inhalte betrachtet. Wenn ein Leser eine aktivierte Sprache verwendet, die nicht die Standardsprache ist, werden Artikelkandidaten vor der Sortierung der Ergebnisse auf diese Sprache beschränkt.
Verbessern Sie, was Leser finden
Die Qualität der Suche hängt von den veröffentlichten Inhalten ab. So verbessern Sie die Ergebnisse:
Veröffentlichen Sie klare Artikel zu den Aufgaben, nach denen Leser suchen
Halten Sie API-Referenzen öffentlich, wenn Leser diese Operationen über die Suche entdecken sollen
Überprüfen Sie verfehlte Suchanfragen in den Analysen, um Inhaltslücken zu erkennen
Informationen dazu, wie Suchmaschinen und KI-Tools Ihr Hilfezentrum außerhalb des In-Product-Dialogs entdecken, finden Sie unter SEO- und GEO-Optimierung (AEO) für Ihr Hilfezentrum.