Wenn man etwas überblicken möchte, dann geht man am besten auf einem hoch gelegenen Beobachtungspunkt. Auf einem Schiff erlangt man den Überblick vom Ausguck am Mast – das sogenannte Krähennest. Laut Wikipedia dienten früher Krähen den Seeleuten bei der Landsuche. Um Land zu finden, wurde eine Krähe freigelassen und das Schiff folgte der Krähe. Was hat der Ausguck auf dem Schiff nun mit Anleitungen zu tun?
Anwender nehmen Anleitungen vorwiegend zur Hand, wenn ein Problem auftritt. Dann suchen sie in der technischen Dokumentation Hilfe. Den Ausgangspunkt ihrer Suche stellt häufig das Inhaltsverzeichnis dar. Damit ist eine der wichtigsten Funktion des Verzeichnisses benannt: Es soll Überblick über das Dokument geben. In diesem Sinne ist das Inhaltsverzeichnis das Krähennest der Anleitung.
Was muss bei der Erstellung eines Inhaltsverzeichnisses berücksichtigt werden?
Wenn eine technische Anleitung mehr als vier Seiten umfasst, fordert die neue Norm DIN EN 82079 ein Inhaltsverzeichnis. Die Norm führt nicht weiter aus, wie das Inhaltsverzeichnis aufgebaut oder gestaltet sein soll. Ebenso fehlt eine Seitenbegrenzung. Zu diesen Aspekten müssen wir uns selber Gedanken machen.
Ich bin immer wieder erstaunt, wie viele Seiten so manches Inhaltsverzeichnis umfasst. Manchmal frage ich mich (etwas boshaft), ob ein Meta-Inhaltsverzeichnis hilfreich wäre, um in einem 5, 6 oder 7-seitigen Verzeichnis den Überblick zu bekommen. Mein klarer Favorit ist ein übersichtlich gestaltetes 2-seitiges Inhaltsverzeichnis. Auf dem Weg dahin muss Ballast abgeworfen werden.
Häufig gleiche Seitenzahlen
Wenn auf einer Seite mehrere Überschriften stehen und diese in das Inhaltsverzeichnis aufgenommen werden, resultiert häufig ein unübersichtliches und langes Verzeichnis. Mit dieser Situation ist u. a. folgende Frage verbunden: Unterstützen mehr als zwei Überschriften pro Seite den Nutzer? Wird diese Frage verneint, ist dies ein Hinweis, die Anzahl der Überschriften zu reduzieren und damit einen Schritt in Richtung eines übersichtlichen Inhaltsverzeichnisses zu gehen.
Kapitel mit nur einem Unterkapitel
Immer wieder gibt es Kapitel mit nur einem Unterkapitel, häufig ergeben sich damit zwei Einträge im Inhaltsverzeichnis (Kapitelüberschrift und die Überschrift des Unterkapitels). Als Redakteure sollten wir uns fragen: Sind zwei Einträge im Inhaltsverzeichnis für den gleichen Inhalt vorhanden?
Wenn wir diesen Umstand auf unser Bild des Schiffes übertragen, bedeutet dies: Das Schiff hat zwei Mastkörbe und der Seemann muss sich zunächst entscheiden, welchen er wählt. Dann klettert er auf den ersten Mast. Wenn er Pech hat, stellt er fest, dass er vom zweiten Ausguck besser sehen kann. Also muss der Mann auf den nächsten Mast gelangen. Dieses Spiel macht ihm sicherlich kein Spaß. Wieso sollte es dem Nutzer Spaß machen, zwei Einträge im Inhaltsverzeichnis für den gleichen Textabschnitt zu finden und sich entscheiden zu müssen. Mit einer einzigen aussagekräftigen Überschrift und damit mit nur einem Eintrag im Inhaltsverzeichnis können wir (technische Redakteure) dem Leser die notwendige Unterstützung bieten und ihm die Chance geben, den Überblick über die Anleitung zu bekommen.
Umfangreiche Dokumente
Umfangreiche Dokumente von mehreren Hundert Seiten können nicht in ein kurzes Inhaltsverzeichnis gepresst werden. In diesem Fall kann die Aufteilung des Inhaltsverzeichnisses helfen. Damit ist gemeint, dass zu Beginn der technischen Dokumentation ein Kapitelverzeichnis steht und in jedem Kapitel das dazugehörige Inhaltsverzeichnis aufgeführt ist. Auf diese Weise geben Sie dem Leser zu Beginn der Anleitung einen Gesamtüberblick und er kann sich in der für ihn unbekannten Dokumentation zu Recht finden. Damit wird das Inhaltsverzeichnis zu einem Krähennest.