Die Dokumentationsseite ist das zentrale Leseerlebnis Ihrer Wissensdatenbank – hier durchstöbern Leser Kategorien, navigieren durch Artikel und konsumieren Ihre Inhalte. Ihr Layout wird vom Gesamtdesign Ihrer Seite bestimmt, aber Document360 ermöglicht es Ihnen, das Verhalten der Suchleiste, der Kategoriennavigation und des Inhaltsverzeichnisses zu optimieren, sodass die Seite so funktioniert, wie Ihre Leser es erwarten, und nicht nur so, wie sie standardmäßig ausgeliefert wird.
Die Seite funktioniert direkt aus der Box, aber es gibt bestimmte Situationen, in denen eine Anpassung dieser Einstellungen für die Leser einen bedeutenden Unterschied macht.
Wann die Dokumentationsseite konfiguriert werden soll
Du musst die Dokumentationsseite nicht konfigurieren, damit es funktioniert – sie hat vernünftige Standardeinstellungen. Es lohnt sich jedoch, es zu überprüfen, wann:
- Die Leser haben Schwierigkeiten, die Suchleiste zu finden – wenn man sie ins linke Feld verschiebt, wird sie direkt über dem Kategorienbaum platziert, wo die Leser natürlich zuerst suchen.
- Dein Kategorienbaum hat lange Titel – das Aktivieren von Anzeigen von Titeln in 2 Zeilen verhindert, dass lange Titel abgekürzt werden, was die Lesbarkeit verbessert.
- Deine Artikel haben tief verschachtelte Überschriften – das zusammenklappende Inhaltsverzeichnis sorgt standardmäßig dafür, dass der rechte Fenster für Leser, die nur die oberste Struktur benötigen, sauberer bleibt.
- Ihre Markenfarbe muss in die Navigation aufgenommen werden – das Anwenden einer benutzerdefinierten Hintergrundfarbe in die Suchleiste oder Kategorienavigation bindet die Dokumentationsseite enger an Ihre Markenpalette.
Greifen Sie auf die Einstellungen der Dokumentationsseite zu.
-
Navigieren Sie zu () > Knowledge base site in der linken Navigationsleiste des Wissensdatenbankportals.
-
Im linken Navigationsfenster navigieren Sie zur Site-Anpassung.
-
Klicken Sie auf die Schaltfläche "Website anpassen ".
-
Wählen Sie im linken Dropdown-Menü unter Hauptseiten Dokumentation aus. Das Anpassungsfeld der Dokumentationsseite erscheint links, rechts eine Live-Vorschau.
Suchleiste
Konfigurieren Sie, wie die Suchleiste auf der Dokumentationsseite angezeigt wird:
| Schauplatz | Optionen | Beschreibung |
|---|---|---|
| Position der Suchleiste | Sekundärer Header (Standard) / Linkes Panel | Secondary Header platziert die Suchleiste oben rechts. Das linke Panel platziert sie oben im linken Navigationsfenster, über dem Kategorienbaum |
| Suchleisten-Stil | Eingabebox / Knopf | Das Eingabefeld zeigt ein sichtbares Textfeld; Der Button zeigt ein kompaktes Symbol, das sich beim Klicken erweitert |
| Individuelle Hintergrundfarbe | Checkkästchen | Verwendet eine benutzerdefinierte Farbe auf die Suchleiste. Wenn ausgewählt, wird die Primärfarbe für helle und dunkle Themen automatisch vorgefüllt |
| Tastatur-Verknüpfung anzeigen | Kontrollkästchen (standardmäßig aktiviert) | Zeigt Strg + K (Befehl + K auf Mac) in der Suchleiste an. Gilt sowohl für die linke Navigationsleiste als auch für die Hauptsuchleiste |
Kategorie-Navigation
Konfigurieren Sie das Erscheinungsbild des linken Navigationsfensters:
| Schauplatz | Beschreibung |
|---|---|
| Hintergrundfarbe hinzufügen | Verwendet eine Hintergrundfarbe auf den gesamten Kategorie-Navigationsabschnitt. Standardmäßig wird ein hellgraues (#F4F4F5) verwendet |
| Hintergrundfarbe des Auswahlzustands hinzufügen | Verwendet eine Hintergrundfarbe auf das aktuell ausgewählte Element im Bereich Kategorien und Artikel. Standardmäßig wird ein hellblaues (#E6F0F7) verwendet |
| Titel in 2 Zeilen anzeigen | Verpackt lange Kategorien- und Artikeltitel in zwei Zeilen im linken Navigationsbereich. Wenn ein Titel zwei Zeilen überschreitet, wird eine Ellipse (...) angezeigt. Wenn deaktiviert, werden lange Titel auf eine einzelne Zeile abgekürzt |
TOC-Navigation
| Schauplatz | Beschreibung |
|---|---|
| Kollaps der TOC-Header | Fügt standardmäßig alle Inhaltsverzeichnis-Header auf der Knowledge Base-Seite zusammen. Wenn beispielsweise H2, H3 und H4 angezeigt werden, ist H4 unter H3 und H3 unter H2 verschachtelt, beide kollabiert, bis der Leser sie erweitert |
Die Einstellung Zusammenklappen der TOC-Header kann () > Knowledge base site > Artikeleinstellungen aktiviert werden. Erweitern Sie den Akkordeon "Artikel rechts" und aktivieren Sie den Umschalter "Collapse TOC".
Speichern und veröffentlichen
- Nutzen Sie rechts den Schalter Vorschau, um Ihre Änderungen zu überprüfen.
- Klicken Sie auf Speichern , um Ihre Änderungen zu speichern.
- Klicken Sie auf Veröffentlichen , um Änderungen live vorzunehmen.
Best Practices
- Nutzen Sie das linke Panel für suchintensive Wissensbasen – wenn Leser stark auf die Suche setzen statt auf den Kategorienbaum zu stöbern, macht die Platzierung der Suchleiste im linken Panel sie sofort sichtbar, ohne den Kopfbereich zu scrollen.
- Anzeigen von Titeln in 2 Zeilen für API- oder technische Dokumente aktivieren – Endpunktnamen und technische Titel sind meist lang; das Abkürzen macht die Navigation verwirrend.
- Wenden Sie die Hintergrundfarbe der Kategorienavigation konsequent an – wenn Sie eine gebrandete Farbe für den Hintergrund im linken Panel verwenden, stellen Sie sicher, dass sie im hellen und dunklen Modus gut mit der Textfarbe kontrastiert.
- Verwende Collapse TOC-Header für Artikel mit tiefen Überschriften-Hierarchien – so bleibt der Inhaltsverzeichnis für lange Artikel handhabbar, während die Leser dennoch die benötigten Abschnitte erweitern können.
FAQ
Wie ändere ich die Position der Suchleiste auf der Wissensdatenbank-Website?
Navigiere zu {{variable. Einstellungen}} () > {{variable. Knowledge Base Site}} > Site-Anpassung und klicke auf Site anpassen. Wähle im linken Dropdown-Menü Dokumentation. Im Bereich Positionsposition der Suchleiste wähle Linkes Feld, um die Suchleiste über dem Kategorienbaum zu platzieren, oder Sekundäre Header , um sie oben rechts zu platzieren. Klicke auf Speichern und Veröffentlichen , um anzuwenden.
Wenn ich Änderungen an der Dokumentationsseite vornehme, werden sie dann automatisch in allen Sprachen aktualisiert?
Nein. Änderungen in deiner Standardsprache werden nicht automatisch in anderen Sprachen angezeigt. Du musst die gleichen Änderungen für jeden Spracharbeitsbereich manuell anwenden.