Technische Dokumentationen werden wie ein Roman von vorne nach hinten gelesen? Hmm, eher nicht. Eine gedruckte Anleitung wird entgegen der initialen Erwartung nicht zwangsläufig chronologisch gelesen. Die Leserschaft kann unterschiedlich an die Anleitung herangehen und benötigt dafür unterschiedliche Orientierungselemente, um sich im Dokument zurechtzufinden. Dabei bestimmt die Lesemotivation das Vorgehen. Möchte man sich ganzheitlich mit dem Produkt beschäftigen und es kennen lernen? Benötigt man gezielte Informationen und sucht nach Schlagwörtern im Index? Liegt ein akutes Problem mit dem Produkt vor? Will man sich in dem Moment mit der Anleitung befassen oder muss man es? Diese Fragestellungen bestimmen, wie die einzelne Person an die Anleitung herangeht und dann auch, wie sie sich innerhalb des Dokuments „bewegt“.

 In diesem Blogartikel lernst du verschiedene Orientierungselemente für Technische Dokumente kennen und erfährst, wie du sie gewinnbringend für deine Nutzer:innen einsetzt.

Das Leseverhalten bestimmt das Orientierungselement

Das Leseverhalten jedes Lesers bzw. jeder Leserin bestimmt, welche Orientierungselemente diese:r benötigt. Baut man als Technischer Redakteur oder Technische Redakteurin also verschiedene Typen von Orientierungselementen ein, kann man unterschiedlichen Lesebedürfnissen gerecht werden. Es gilt also der Grundsatz: Baue viele verschiedene Orientierungselemente in deine Anleitung ein, dann kann jeder individuell nach den eigenen Bedürfnissen die passenden Inhalte nutzen.

Und digital?

Eine digitale Anleitung hat noch mehr Möglichkeiten. Dort können beispielsweise zusätzliche Hilfetabs geöffnet werden oder es können Suchfunktionen integriert werden. Die Leserschaft hat damit noch mehr Möglichkeiten, sich innerhalb der Technischen Dokumentation und der referenzierten Dokumente zu bewegen. In diesem Blogartikel konzentrieren wir uns auf gedruckte Anleitungen und deren wichtigen Orientierungselemente.

Das Layout von Orientierungselementen

Die in der Tabelle vorgestellten Orientierungselemente betreffen zum einen das Layout und zum anderen den zu erstellenden Inhalt. Beginnen wir mit dem Layout!

Struktur hilft den Augen der Leser:innen sich zu orientieren und Sachverhalte zu finden. Für ein übersichtliches Layout sollten optisch strukturierende Elemente angelegt werden. So wird das Auge bewusst geleitet: Was ist wichtig? Was ist weniger wichtig? Was gehört zusammen? Geht es um einen Sachverhalt oder um mehrere?

Nachfolgend stellen wir dir wichtige Orientierungselemente vor, welche hauptsächlich das Layout deines Dokuments betreffen.

Titelblatt:

• Es bildet den ersten Eindruck des Dokuments.
• Das Titelblatt ist eine thematische Mischung aus Layout und Inhalt.
• Es dient der Identifikation und Zugehörigkeit.

Zusatz:

Dabei kann das Titelblatt auch als gestalterischer Standpunkt definiert werden. Wie viel Mühe gebe ich dem Aussehen meiner Technischen Dokumentation? Wie attraktiv wirkt meine Technische Dokumentation? Auch die optische Gestaltung kann zu einem positiven Nutzungserlebnis deiner Zielgruppe mit deinem Dokument beitragen.

Die Technische Dokumentation kann durchaus auch als Marketingdokument gesehen werden. Es sollten die gleichen ästhetischen Maßstäbe wie an das Produkt selbst gesetzt werden. Beachte dazu die Corporate Identity deines Unternehmens.

Rückblatt:

• Es ist das Gegenstück zum Titelblatt und kann auch als Layout- und Inhaltselement genutzt werden.
• Die Leserschaft hat Erwartungen an ein Rückblatt. Oft stehen dort Adresse und Kontaktdaten.
• Mögliche Inhalte für das Rückblatt: Adresse und Kontaktdaten des Herstellenden ggf. auch mit Logo, Produktnummer, Version des Drucks, Publikationsdatum

Fließtext:

• Fließtext kann nur linear gelesen werden.
• Fließtext bietet nur bedingt Unterstützung beim Querlesen, Verstehen, Rekapitulieren oder gezielten Suchen.
• Fließtext sollte also nur Sachverhalte erklären, die strukturelle Lenkung muss über die Überschriften erfolgen.

Zwischenüberschriften:

• Zwischenüberschriften helfen bei der Orientierung innerhalb einer Seite.
• Sie dienen besonders beim Durchblättern als Orientierungshilfe.
• Sie verdeutlichen zusammengehörende Sinneinheiten.
• Sie sollten prägnant und aussagestark formuliert werden.

Marginalientexte:

• Marginalientexte können als Zusammenfassung neben dem “normalen” Inhalt stehen.
• Sie können Merksätze enthalten.
• Sie können auch als Zwischenüberschriften genutzt werden.
• Marginalientexte helfen sehr effektiv beim Überfliegen längerer Textabschnitte.

Platzierung der Texte:

• Sinneinheiten sollten gemeinsam und einheitlich platziert werden.
• Gängige Methode ist es beispielsweise, dass ein neues Kapitel auf einer neuen Seite beginnt.
• Zudem können wichtige Texte z. B. in Textboxen platziert werden, die man direkt findet.
• Texttypen sollten ihren eigenen Formatierungsstil haben, z. B. Step-by-step-Abschnitte mit Nummerierung oder Aufzählungszeichen.

Registerkarten:

• Registerkarten können durch Farbcodes, Buchstabencodes oder einheitlich platzierte Stichworte umgesetzt werden.
• Eine Technische Dokumentation kann ein- oder mehrsprachig sein – eben auch innerhalb eines Dokuments. Mehrsprachigkeit lässt sich auch durch verschiedene Register realisieren. Für die Angabe der Sprache können abkürzende Codes verwendet werden. Da kannst du dich übrigens an der ISO 639-2 orientieren.

Der Inhalt von Orientierungselementen

Neben layouttechnischen Orientierungselementen, gibt es auch inhaltliche, strukturierende Elemente. Einige der oben genannten Elemente waren bereits Mischtypen, die Layout und Inhalt betreffen.

Inhaltsverzeichnis:

Ein Inhaltsverzeichnis in einer Technischen Dokumentation ist aus verschiedenen Gründen relevant:

1. Übersichtlichkeit: Ein Inhaltsverzeichnis bietet deinen Leser:innen eine strukturierte Übersicht über den Inhalt des Dokuments. Dies ermöglicht es ihnen, schnell zu bestimmten Abschnitten oder Themen zu navigieren, die für ihre speziellen Bedürfnisse oder Interessen relevant sind. Dies ist besonders wichtig in technischen Dokumentationen, die oft umfangreiche Informationen und eine tiefe hierarchische Struktur enthalten.
2. Effiziente Informationsbeschaffung: Technische Dokumentationen dienen häufig als Referenzmaterial für dritte Personen wie Ingenieur:innen, Techniker:innen oder andere Fachleute. Mit einem Inhaltsverzeichnis können sie die benötigten Informationen effizienter finden und auch Referenzen auf Kapitelnummern setzen. Wenn sie in deiner Technischen Dokumentation auf bestimmte Abschnitte oder Seiten verweisen müssen, können sie dies einfach tun, indem sie sich auf das Inhaltsverzeichnis beziehen.
3. Suchmaschinenoptimierung: In der heutigen digitalen Welt werden Technische Dokumentationen oft online veröffentlicht. Ein gut strukturiertes Inhaltsverzeichnis kann dazu beitragen, dass auch dein Dokument von Suchmaschinen leichter gefunden wird.
4. Nutzungsfreundlichkeit: Insgesamt trägt ein gut gestaltetes Inhaltsverzeichnis zur Nutzungsfreundlichkeit der Technischen Dokumentation bei. Es verbessert die Lesbarkeit, die Navigierbarkeit und die Effizienz beim Abrufen von Informationen.

Insgesamt ist ein Inhaltsverzeichnis in Technischen Dokumentationen also ein wichtiges organisatorisches Element, das dazu beiträgt, die Informationen klar und zugänglich zu präsentieren und den Nutzen und die Verständlichkeit des Dokuments zu steigern.

Einleitung:

Eine Anleitung braucht keine große Einleitung – und schließlich wollen wir ja alle so viel Inhalt wie nötig und eben auch so wenig Inhalt wie möglich in unsere Dokumentation packen. ABER: Ein kurzer Abschnitt, der z. B. “Über diese Anleitung” heißen könnte, fasst den Zweck und die Zielgruppe des vorliegenden Dokuments kurz zusammen. So kann jeder Leser bzw. jede Leserin direkt entscheiden, ob das Dokument relevant für sie ist.

Lebende Kopf- und Fußzeile mit Referenzen:

Das Referenzieren von Kapiteltiteln in einer Kopfzeile ist eine nützliche Technik in Dokumenten, um den Leser:innen zu helfen, den Inhalt und die Struktur des Dokuments besser zu verstehen. Dies ist besonders in längeren Dokumenten oder Büchern hilfreich. Dazu wird eine “lebende” Kopf- bzw. Fußzeile erstellt, worin referenzierte Textelemente platziert werden.

Hier sind einige Gründe und Vorteile, warum man Kapiteltitel in einer Kopfzeile referenzieren kann:

1. Übersichtlichkeit: Indem du den aktuellen Kapiteltitel in der Kopfzeile anzeigen lässt, können die Leser:innen leicht feststellen, in welchem Abschnitt des Dokuments sie sich gerade befinden.
2. Schnelle Navigation: Leser:innen können das Inhaltsverzeichnis überfliegen, um schnell zu einem bestimmten Kapitel zu gelangen, oder sie können durch das Dokument blättern und anhand der Kopfzeile erkennen, wo sie sich befinden. Du bietest hier also Lösungen für verschiedene Bedürfnisse und Herangehensweisen – super!
3. Rückverfolgbarkeit: Wenn Leser:innen in deinem Dokument vor- oder zurückspringen, können sie anhand der Kapitelreferenzen in der Kopfzeile leicht verfolgen, welche Kapitel sie bereits gelesen haben oder noch lesen müssen.
4. Konsistenz: Wenn du automatisch aktualisierbare Kopfzeilen verwendest, bleibt die Kapitelreferenz konsistent und korrekt, selbst wenn du Änderungen am Dokument vornimmst, wie das Hinzufügen oder Löschen von Kapiteln.

In den meisten modernen Anwendungen gibt es Möglichkeiten, automatisch die aktuellen Kapiteltitel in die Kopfzeile einzufügen und sicherzustellen, dass sie immer auf dem neuesten Stand sind. Dies erleichtert die Verwaltung von umfangreichen Dokumenten und verbessert die Lesbarkeit für deine Zielgruppe.

Index bzw. Stichwortverzeichnis:

Ein Stichwortverzeichnis, auch als Index bezeichnet, ist ein wichtiges organisatorisches Element in Dokumenten. Es listet Schlüsselbegriffe oder Stichwörter auf und verweist auf die Seiten oder Abschnitte im Text, in denen diese Begriffe vorkommen. Hier sind einige der Vorteile eines Stichwortverzeichnisses:

1. Effiziente Informationssuche: Ein Stichwortverzeichnis ermöglicht dir, schnell und gezielt nach spezifischen Informationen zu suchen. Du musst nicht das gesamte Dokument durchblättern, sondern kannst direkt zu den relevanten Stellen springen.
2. Verbesserte Benutzungsfreundlichkeit: Ein gut gestaltetes Stichwortverzeichnis verbessert die Nutzungsfreundlichkeit eines Dokuments erheblich. Du kannst leichter die Informationen finden, die du benötigst, und wirst weniger frustriert, wenn du nach bestimmten Themen oder Begriffen suchst. Das gilt für gedruckte Anleitung, wo du keine automatische Suchfunktion laufen lassen kannst.
3. Hervorhebung wichtiger Konzepte: Durch das Hinzufügen von Stichwörtern zu einem Verzeichnis können wichtige Konzepte, Personen, Orte oder Ereignisse in deinem Text hervorgehoben werden. Dies kann dazu beitragen, die Bedeutung bestimmter Elemente in deinem Dokument zu betonen.
4. Bessere Organisationsstruktur: Die Erstellung eines Stichwortverzeichnisses erfordert, dass du dein Dokument sorgfältig organisierst und die wichtigsten Themen identifizierst. Dies führt zu einer besseren Strukturierung des Textes und hilft dir, die Zusammenhänge zwischen verschiedenen Abschnitten zu erkennen.

Insgesamt erleichtert ein Stichwortverzeichnis die Navigation und den Zugriff auf Informationen in einem Dokument erheblich. Es ist ein wertvolles Hilfsmittel, um sicherzustellen, dass dein Text gut strukturiert ist und von deinen Leser:innen effektiv genutzt werden kann.

Du hast jetzt einige Orientierungselemente kennengelernt, so wohl die, die das Layout wie auch die, die den Inhalt betreffen. Du musst nicht alle davon in deinem Dokument umsetzen. Wichtig ist, dass dein Leser:innen bewusst lenkst und ihnen auf jeder Seite das Gefühl von Orientierung gibst. Da ist eine Technische Dokumentation etwas wie der Straßenverkehr: Wir brauchen Straßenschilder, richtungsweisende Pfeile und Ampeln, um sicher zu dem gewünschten Ort zu kommen. Auch beim Lesen einer Anleitung brauchen wir Informationen, bei welchem übergeordneten Sachverhalt wir momentan sind, wo wir relevante Informationen sonst noch finden können und wann wir stoppen und handeln müssen. So läuft alles reibungslos!

Wenn wir dich bei der Umsetzung eines neuen Layoutkonzepts für deine Technische Doku unterstützen können, melde dich gerne ganz unverbindlich.