BA #021 Überblick in der Betriebsanleitung behalten

Wenn ein Produktanwender Informationen zu seinem Produkt benötigt, schaut er in die Technische Dokumentation des Produktes. Der Benutzer sucht aber nur bestimmte Informationen und möchte diese gezielt und schnell finden. Um in der Fülle an Informationen in der Anleitung auch die richtigen Informationen zu finden, sind entsprechende Orientierungssysteme notwendig, um den Überblick in der Betriebsanleitung zu behalten.

Die angesprochenen Orientierungssysteme erlauben dem Benutzer sich durch die Inhalte der Technischen Dokumentation zu navigieren. Die richtige typografische Gestaltung von Orientierungssystemen kann helfen die Informationen in einer Technischen Dokumentation schnell zu erschließen.

Wie lenkt man am besten die Aufmerksamkeit des Benutzers auf die jeweiligen Inhalte der Technischen Dokumentation?

Schauen wir uns dazu erst mal den Prozess zur Informationsaufnahme an:

Der Benutzer nimmt zuerst Informationen wahr, versucht dann diese zu verstehen und anschließen abzuspeichern. Er kann im Nachhinein dann die abgespeicherten Informationen bei Bedarf abrufen und anwenden.

Uns geht es bei der Gestaltung von Orientierungssystem hauptsächlich darum, wie der Benutzer Informationen wahrnimmt. Er muss die Informationsmenge überblicken, entsprechende Stellen herausfinden und diese entsprechend ihrer Relevanz einschätzen.

Dafür springt der Benutzer am Anfang oft von Textpassage zu Textpassage, um die gesuchten Informationen schnell zu finden. Hier bieten Orientierungssysteme dem Benutzer entsprechende Navigationshilfen. Ein Inhaltsverzeichnis verweist den Benutzer auf entsprechende große Informationsblöcke. Danach helfen dem Benutzer Überschriften, Kolumnen, Marginalien oder Register die bestimmten Themenfelder und Suchbegriffe zu finden.

In längeren Textpassagen helfen dem Benutzer entsprechende Auszeichnungen den Text schneller nach gewünschten Informationen zu durchsuchen. Das können fette oder größere Schriftschnitte sein oder die Abgrenzung von Textblöcken durch entsprechende Weißräume.

Wir sehen, dass Typografie eine zentrale Rolle bei der Strukturierung eines Textes spielt, damit der Benutzer schnell Informationen finden kann.

Die Typografie bietet bestimmte Elemente, die für das schnelle Auffinden von Informationen zuständig sind. Das können im Bereich der Technischen Dokumentation Verzeichnisse, Überschriften oder Indexe sein.

Damit der Leser möglichst ökonomisch also zeitsparend an seine gesuchten Informationen gelangen kann, benötigt er zuerst einen Überblick über alle verfügbaren Inhalte.

Der erste Blick des Benutzers wird also sehr wahrscheinlich auf das Inhaltsverzeichnis landen. Danach wählt der Benutzer ein bestimmtes Kapitel zur weiteren Recherche nach Informationen aus.

In dem jeweiligen Kapiteln helfen Überschriften, Register oder Marginalien dem Benutzer bei der weiteren Suche nach Informationen. So finden sich auf den Seiten der Technischen Dokumentation am Rand abgedruckte Marginalien, die eine Randbemerkung zu dem jeweiligen Textabschnitt beinhalten. Durch diesen Informationshappen kann der Benutzer schnell entscheiden, ob der betreffende Textabschnitt für Ihn relevante Informationen enthalten könnte. Ähnlich verhält es sich mit Registern oder den Überschriften, die mehreren Seiten oder einen Seitenbereich, einem Thema zuordnen.

Auch der Anhang einer Technischen Dokumentation kann Orientierungshilfen enthalten. Ein Abbildungsverzeichnis bietet dem Benutzer beispielsweise die Möglichkeit die Dokumente nach gewissen Schaltbildern, Zeichnungen, Diagrammen oder Produktabbildungen zu durchsuchen.

Ebenfalls finden sich im Anhang auch Indexe oder Stichwortverzeichnisse, die eine Orientierungshilfe für den Benutzer darstellen. Mit diesen Verzeichnissen kann der Benutzer die Technische Dokumentation nach bestimmten Fachbegriffen durchsuchen und so schnell an gewünschte Informationen gelangen.

Das Inhaltsverzeichnis einer Technischen Dokumentation bietet dem Leser einen Überblick über die Inhalte. Zwar genügt es die Inhalte mit einer Nummerierung und entsprechenden Überschriften zu versehen, jedoch ermöglichen visuelle Hilfsmittel die unterschiedlichen Ebenen besser darzustellen. Beispielsweise kann man die untergeordneten Ebenen mit Einzügen einrücken. Die oberste Hierarchieebene kann man durch eine entsprechende Schriftstärke zusätzlich hervorheben. Mit zusätzlichem Weißraum zwischen den unterschiedlichen Ebenen schafft man zudem sinnstiftende Einheiten. Dadurch kann sich der Leser einen schnelleren Überblick über die einzelnen Kapitel verschaffen.

Einen Vergleich zwischen einem einfachen Inhaltsverzeichnis und einem optimierten Inhaltsverzeichnis führen wir hier nachfolgend auf:

Einfaches Inhaltsverzeichnis:

3             Transport
3.1          Transportmittel
3.1.1      Gabelstapler
3.1.2      Kran
3.2          Aufnahmepunkte
3.3          Transporthinweise
4             Aufstellung
4.1          Anlieferung
4.1.1      Überprüfung auf Schäden
4.2          Platzbedarf
4.3          Aufstellung

Übertreiben sollte man die Differenzierung der einzelnen Ebenen aber nicht. Ganz nach dem Motto: „Zu viele Köche verderben den Brei“. Fügt man beispielsweise unterschiedlich große Schriftgrade hinzu, um die Differenzierung der einzelnen Ebenen hervorzuheben, kippt die Übersichtlichkeit der Darstellungsweise zusammen.

Bei der Gestaltung von Verzeichnissen geht es nicht darum, möglichst viele visuelle Unterscheidungen einzuarbeiten. Vielmehr sollten wenige angemessen Ausprägungen dem Benutzer beim Lesen unterstützen.

Durch entsprechende Strukturmerkmale im Text kann der Benutzer schnell von Textpassage zu Textpassage springen.

Die geläufigste Orientierungshilfe ist die Seitenzahl. Aber auch Zwischenüberschriften, Marginalien, Stichwörter oder Register helfen dem Benutzer bei der schnellen Navigation durch das Dokument. Einige dieser Orientierungshilfen finden sich in den Kopf- und Fußzeilen des Dokumentes. Andere wiederum sind im seitlichen Bereich zu finden und grenzen sich vom eigentlichen Satzspiegel ab, um beim Blättern schnell aufzufallen.

Bevor der Benutzer zum sequenziellen Lesen übergeht, also die Methode bei dem der Blick Zeile für Zeile den Text abarbeitet, springt der Blick des Lesers über mehrere Textbereiche zur gewünschten Stelle.

Hier bieten sich auch entsprechende Abstände an. Sind mehrere Passagen nicht durch Abstände getrennt, werden diese schnell mal als eine Einheit wahrgenommen und übersprungen. Werden diese durch einen Weißraum ausreichend voneinander getrennt, nimmt Sie das Menschliche Auge als eigene Einheit dar und erfasst den Inhalt genauer beim Querlesen des Textes.

Auch kann mit Farbe im Text bestimmte Sachen hervorgehoben werden. Je nach Wahl der Farbe sticht die Hervorhebung auch stärker im umgebenden Kontext hervor. So hat die Farbe Rot einen stärkeren Hervorhebungscharakter als die Farbe Grau. Auch ein fett hervorgehobenes Wort im Fließtext ist auffällig und sticht aus dem normalen Text hervor. Visuelle Reize erzeugen Aufmerksamkeit, daher sind typografische Ausprägungen des Textes auch wichtig für die Steuerung der Aufmerksamkeit des Lesers.

Ein Einzug sorgt in einer Textmasse zudem auch für eine gewisse Struktur und hebt einen Abschnitt vom restlichen Text ab.

Eine weitere Möglichkeit den Blick des Lesers auf einen bestimmten Bereich zu setzen ist die Anwendung von Symbolen an der Seite. So kann ein Piktogramm den Leser auf einen Hinweis oder Warnung aufmerksam machen.

Am Ende der Technischen Dokumentation ist häufig ein Index mit den Fachbegriffen und deren Vorkommen in der Dokumentation zu finden.

Folgende Merkmale muss ein guter Index beinhalten, damit der Benutzer schnell seine gesuchten Informationen mithilfe des Indexes finden kann: 

1. Der Index ist eine korrekt sortierte Liste nach alphabetischen angeordnete Begriffen.
2. Er ist vollständig und enthält alle wichtigen Themen, Schlagwörter und Fachbegriffe, die den Zugang zum Inhalt erleichtern,
3. Zeigt Zusammenanhänge auf und enthält Schlagworte, die den Inhalt beschreiben.
4. Der Index ist in einer konsistenten Schreibweise geschrieben und enthält keine Schreibfehler.
5. Die Verweise geben nicht mehr als 5 Seitenzahlen an nach dem jeweiligen Eintrag-
6. Der Index ist gut gegliedert in zwei bis drei Ebenen und mit Einzügen für die Untereinträge und zeigt Zusammenhänge durch die Untereinträge auf.

Ein Beispiel eines angepassten Index, der die obigen Punkte beinhaltet, ist hier nachfolgend als Ausschnitt zu finden:

Abschließend kann ich nur nochmal hervorheben, wie wichtig es ist die Texte in einer Technischen Dokumentation entsprechend aufzubereiten und zu gestalten. Sie ersparen den Benutzern der Dokumentation eine Menge Zeit und Energie, wenn Ihre geschriebenen Texte verständlich, schnell und effizient ausgewertet werden können. Eine lesefreundliche Gestaltung der Dokumentation unterstützt den Verständnisprozess enorm und mindert dadurch auch die Gefahren von Unfälle und Produkthaftungsrisiken.

Man darf zudem nicht vergessen: Eine unleserliche Technische Dokumentation (die auch die Betriebs- bzw. Gebrauchsanleitung beinhaltet) gilt als nicht verständlich und somit als fehlerhaft. Und laut dem Produkthaftungsgesetz ist eine fehlerhafte Gebrauchsanleitung eine Ordnungswidrigkeit, die mit Straf- und Bußgelder verhängt werden kann.

Wenn Sie Unterstützung benötigen bei der Erstellung einer Technischen Dokumentation, können wir Ihnen dabei behilflich sein. Werfen Sie zudem auch einen Blick auf unsere kostenlose E-Books zur Technischen Dokumentation im Downloadbereich.