Wachstum verändert das Problem
Kleine Dokumentationsbestände überleben fast jede Navigation. Bei zwanzig Seiten können Leser das Menü überblicken, Autoren wissen, wo Inhalte liegen, und Duplikate sind sichtbar. Bei fünfhundert Seiten verschwinden diese Vorteile. Die Struktur wird selbst zu einer Produkteigenschaft.
Die erste Regel: Verwechsle den Verzeichnisbaum des Repositorys nicht mit Informationsarchitektur. Die Ablage dient Maintainers, die Navigation dient Lesern.
Beginne mit Nutzerintentionen und Inhaltstypen
Liste auf, warum Menschen Dokumentation öffnen: ein Konzept verstehen, eine Aufgabe erledigen, ein Feld nachschlagen, einen Fehler beheben oder eine Änderung verstehen. Definiere anschließend wenige Inhaltstypen für diese Absichten.
Ein Content Model gibt jedem Typ vorhersagbare Metadaten und Strukturen. Mit wachsendem Archiv ermöglicht diese Konsistenz Filter, Suche, automatische Prüfungen und wiederverwendbare Layouts.
Halte die oberste Ebene stabil
Die globale Navigation sollte sich langsam ändern. Erzeuge keinen Top-Level-Punkt für jede Technologie, jedes Team oder jeden Trend. Volatile Details gehören tiefer und werden über Tags, Collections und Suche sichtbar.
Wenn eine Kategorie bei der nächsten Reorganisation verschwinden könnte, gehört sie wahrscheinlich nicht in die dauerhafte Navigation.
Entwirf Verbindungen, nicht nur Bäume
Leser kommen über Suche, Issues, Code, Support und alte Bookmarks. Jede Seite braucht genügend Kontext und Links zum nächsten wahrscheinlichen Schritt. Verknüpfe Konzepte mit Aufgaben, Aufgaben mit Reference und Fehler mit Recovery.
Prüfe die Struktur früh
Suche nach verwaisten Seiten, doppelten Titeln, kaputten Links, riesigen Bereichen und synonymen Tags. Beobachte Suchanfragen mit schlechten Ergebnissen.
Informationsarchitektur ist kein einmaliges Diagramm, sondern laufende Pflege. Die nächsten fünfhundert Seiten dürfen die ersten fünfhundert nicht schwerer auffindbar machen.
Praxisbeispiel
Um „Informationsarchitektur für Dokumentation, die weiter wächst“ in eine belastbare Praxis zu verwandeln, nimm ein Dokument, das sich in dieser Woche wirklich ändert: eine Prozedur, Release-Seite, Onboarding-Strecke oder Troubleshooting-Seite. Notiere vor der Bearbeitung, wer sie nutzt, wodurch eine Änderung ausgelöst wird, wer die Fakten bestätigen kann und was der Leser anschließend tun können soll.
Führe eine echte Änderung vollständig durch. Ändere nur einen Fakt, einen Schritt oder eine Verantwortung und beobachte, wo Information verloren geht. Prüfe:
- ist das erwartete Ergebnis ohne Rückfrage verständlich;
- gibt es einen Owner für die nächste Aktualisierung;
- kann ein Reviewer den geänderten Fakt verifizieren;
- bleibt die Seite ohne veraltetes Material verständlich.
Eine Dokumentationspraxis ist dann vertrauenswürdig, wenn sie echte Änderungen übersteht – nicht nur, wenn sie in einem statischen Beispiel ordentlich aussieht.
Kurzer Redaktionscheck
- Wachstum verändert das Problem. Kleine Dokumentationsbestände überleben fast jede Navigation.
- Beginne mit Nutzerintentionen und Inhaltstypen. Liste auf, warum Menschen Dokumentation öffnen: ein Konzept verstehen, eine Aufgabe erledigen, ein Feld nachschlagen, einen Fehler beheben oder eine Änderung verstehen.
- Halte die oberste Ebene stabil. Die globale Navigation sollte sich langsam ändern.
- Entwirf Verbindungen, nicht nur Bäume. Leser kommen über Suche, Issues, Code, Support und alte Bookmarks.
