Eine skalierbare Dokumentationsnavigation gestalten

Leser verwenden eine Dokumentations-Sidebar für drei Fragen: Wo bin ich? Welche Seiten gehören zu diesem Thema? Wo finde ich eine andere Art von Antwort? Eine gute Struktur macht diese Antworten sichtbar, ohne jeden Ordner in ein Bedienelement zu verwandeln.

Ginko Docs leitet die Sidebar aus dem Content-Baum ab. Dadurch bleiben Dateireihenfolge, öffentliche Routen, Breadcrumbs, Vor-/Zurück-Links und Suchnavigation aufeinander abgestimmt. Die Informationsarchitektur entsteht im Content und nicht in einem zweiten Frontend-Menü.

Beginne mit der Absicht des Lesers

Trenne lernorientierte Seiten von Nachschlagewerken. Ein Schnellstart führt zu einem funktionierenden Ergebnis. Ein Leitfaden erledigt eine Aufgabe. Eine Referenzseite beschreibt eine öffentliche Oberfläche vollständig.

Stehen diese Seitentypen in einer ungegliederten Liste, erkennen Leser nicht, ob ein Link einen Ablauf erklärt oder eine Optionstabelle öffnet. Große Bereiche wie Dokumentation und Referenz schaffen die erste Entscheidung. Lokale Gruppen wie Inhalte, Funktionen oder Komponenten verkleinern die nächste.

Gib jeder Ebene eine Aufgabe

Verwende sidebar: section für Hauptbereiche im Bereichsumschalter. Verwende sidebar: group für eine sichtbare Überschrift innerhalb des aktiven Bereichs. Lasse einen normalen Ordner nur dann unmarkiert, wenn seine Kinder ein echtes verschachteltes Thema bilden, das Leser ein- und ausklappen sollen.

Halte den häufigsten Pfad flach:

Bereich → Gruppe → Seite

Eine vierte Ebene kann für echte Varianten sinnvoll sein, etwa getrennte Installationen für Nuxt und Vue. Sie sollte nicht entstehen, nur weil ein zusätzlicher Quellordner bequem war.

Indexseiten brauchen einen eigenen Wert

Eine Indexseite ist sinnvoll, wenn sie orientiert, ein gemeinsames Konzept der Unterseiten erklärt oder bei einer Auswahl hilft. Listet sie nur dieselben Links wie die Sidebar, fügt sie einen weiteren Stopp ohne neue Information hinzu.

Strukturelle Gruppen benötigen keine Indexseite. Die Sidebar kann ihr Label anzeigen, während der Bereichsumschalter zur ersten echten Seite führt.

Gestalte Desktop und Mobil gemeinsam

Auf dem Desktop können Dokumentbaum und Inhaltsverzeichnis gleichzeitig sichtbar sein. Mobil fehlt dieser Platz. Halte beide Bedienelemente getrennt: Das eine beantwortet „Welche Seite?“, das andere „Welche Überschrift auf dieser Seite?“. Eine Zusammenlegung spart einen Button, vermischt aber zwei Navigationsmodelle.

Die Suche ist ein dritter Weg und kein Ersatz für Struktur. Sie hilft Lesern, die die gesuchten Begriffe bereits kennen. Die Sidebar dient weiterhin Menschen, die das Vokabular des Produkts erst lernen.

Der Navigationsleitfaden beschreibt die genauen Sidecar-Metadaten. Prüfe bei Änderungen die Struktur anhand von Leseraufgaben und Scan-Tiefe – nicht danach, ob jeder Ordner irgendwo sichtbar ist.