Anforderungen an technische Dokumentation aus Nutzersicht

Nachfolgend werden einige wichtige Anforderungen an technische Dokumentation erläutert. Das Ziel ist, Ihnen einen allgemeinen Eindruck von der Komplexität des Fachgebietes zu verschaffen.

Leicht verständlich

Der Aspekt der leichten Verständlichkeit ist sehr umfangreich. Es gibt eine Vielzahl von Aspekten, die Einfluss darauf haben, was von einer Zielgruppe gut verstanden werden kann:

Logische inhaltliche Reihenfolge

Die Inhalte eines Informationsprodukts sollen so angeordnet sein, wie es dem Gebrauch durch die Zielgruppe entspricht. Die Reihenfolge ist auf allen Inhaltsebenen zu berücksichtigen: Hauptkapitel, Unterkapitel, Abschnitte, Sätze.

Zwei Positivbeispiele für logische Reihenfolge:

Eine Betriebsanleitung für eine Maschine enthält u.a. folgende
Hauptkapitel: „Transport“, „Montage“, „Inbetriebnahme“ und „Betrieb“
in dieser Reihenfolge

Eine Handlungssequenz enthält u.a. folgende Schritte:
1. Muttern lösen.
2. Abdeckung abnehmen.

Schlecht wäre die umgekehrte Reihenfolge:

1. Die Abdeckung abnehmen, nachdem die Muttern gelöst wurden.

Einfacher Satzbau, einfache Formulierungen

Es gibt gerade auch in der deutschen Sprache einen sehr großen Variantenreichtum, mit dem Sachverhalte ausgedrückt werden können. Viele Formulierungsweisen sind für technische Dokumentation jedoch nicht geeignet.

Als Technische Redakteure wollen wir Formulierungen, aus denen unmissverständlich und leicht nachvollziehbar hervorgeht, wer was womit tun soll, wo eine Gefahr lauert oder dergleichen. Schlecht wäre beispielsweise folgende Formulierung:

1. Befestigen Sie die Schutzkappen an den auf eine vorgeschriebene Länge abisolierten Leitungsenden mit einer Flachzange.

Diese Formulierung ist aus zwei Gründen nicht geeignet:

  • Sie ist wegen des Einschubs „auf eine vorgeschriebene Länge abisolierten“ zu komplex.
  • Die Handlungsaufforderung wird vermischt mit Hinweisen („mit einer Flachzange“).

Verbessert könnte der ursprüngliche Satz so lauten:

1. Befestigen Sie die Schutzkappen an den Leitungsenden.
   > Die Leitungsenden sind auf eine vorgeschriebene Länge abisoliert.
   > Verwenden Sie zum Befestigen eine Flachzange.

Der Satzteil „den auf eine vorgeschriebene Länge abisolierten Leitungsenden“ im Ausgangssatz könnte auch als versteckte Handlungsaufforderung gedeutet werden. Dann ist jedoch unklar, wie lang die „vorgeschriebene Länge“ ist. Soll der Nutzer selbst recherchieren? Der nochmals verbesserte Satz könnte wie folgt lauten:

1. Entfernen Sie die Isolierung der Leitungsenden auf eine Länge von je 15 mm.
2. Befestigen Sie die Schutzkappen an den Leitungsenden.
   > Verwenden Sie zum Befestigen eine Flachzange.

Die verbesserten Varianten des Ausgangssatzes sind zwar nicht kürzer, aber wesentlich verständlicher. Verständlichkeit hat in jedem Fall Vorrang vor Kürze.

Geeignete Terminologie

Je nach Zielgruppe kann es sinnvoll sein, bestimmte Fachwörter zu verwenden, Fachwörter zu vermeiden oder sie zumindest zu erklären.

Beispiel: Für die Zielgruppe der Ärzte könnte eine Bedienungsanleitung für ein medizinisches Gerät beispielsweise den Ausdruck „biphasischer Defibrillator“ enthalten. Für die Zielgruppe der medizinischen Laien wären stattdessen die Ausdrücke „2-phasiger Schockgeber“ oder nur „Schockgeber“ möglicherweise verständlicher.

Klare und übersichtliche Struktur und Gestaltung

Die Struktur, einschließlich der Kapitelgliederung, soll den Leser durch den Inhalt führen und ihm die Orientierung im Informationsprodukt erleichtern. Dies geht einher mit einer übersichtlichen Gestaltung. Die Gestaltung sollte die Inhaltsstruktur und die Textfunktionen unterstützen.

Der folgende Ausschnitt aus einer Gebrauchsanleitung ist sehr unübersichtlich:

Technische Dokumentation unstrukturiert

(Abbildung: Ausschnitt aus einer Gebrauchsanleitung mit schlechter Strukturierung und Gestaltung (BOCA 2006))

Den Leser erwartet im Wesentlichen ein Textbrei. Die einzelnen Handlungsschritte, Hinweise und weiteren Informationen muss er sich mühsam zusammensuchen. Der Inhalt ist nicht strukturiert und nicht hilfreich gestaltet.

Wesentlich übersichtlicher ist der folgende Ausschnitt aus einer anderen Gebrauchsanleitung:

Technische Dokumentation strukturiert

(Abbildung: Ausschnitt aus einer Gebrauchsanleitung mit guter Gestaltung (Melitta 2013))

Die einzelnen Handlungsvoraussetzungen, Handlungsschritte und Zwischenergebnisse sind klar erkennbar. Der Inhalt wirkt aufgeräumt. Gegenüber dem Negativbeispiel (BOCA) wurden folgende Gestaltungsmittel verwendet:

  • Farben
  • Hervorhebungen durch Fettschrift und Kursivschrift
  • Einrückungen
  • Nummerierung
  • Listenpunkte/Pfeile
  • Symbole
  • Schriftart ohne Serifen

Konsistenz

Konsistenz ist in mehreren Hinsichten anzustreben:

  • Satzbau und Formulierungsmuster
  • Gestaltung
  • Terminologie
  • Inhaltsstruktur

Mit Hilfe von Konsistenz kann der Leser intuitiv den Aufbau und den wesentlichen Inhalt eines Informationsproduktes erfassen und Wichtiges von Unwichtigem unterscheiden. Inkonsistenz hingegen stiftet Verwirrung, wie in folgendem Beispiel für terminologische Inkonsistenz:

1. Defibrillator an Stromnetz anschließen.
2. Schockgeber einschalten.

Ein medizinischer Laie könnte sich hier fragen, ob „Defibrillator“ und „Schockgeber“ dasselbe ist. Die Sekunden der Unsicherheit könnten im schlimmsten Fall bereits das Ende eines Menschenlebens bedeuten.

Rechtschreibung und Grammatik korrekt

Alle Texte sollten nach den gültigen Rechtschreib- und Grammatikregeln verfasst sein. Kommafehler, Bezugsfehler, Rechtschreibfehler und dergleichen können zu Missverständnissen führen. Nachfolgend ein Beispiel für einen Bezugsfehler:

Wenn eine IF-Kontrollstruktur eine ELSE-Anweisung enthält, dann wird genau einer ihrer Blöcke ausgeführt.“ (tekom 2013, 60)

In diesem Beispiel ist der Bezug des Pronomens „ihrer“ unklar. Es könnte sich auf „IF-Kontrollstruktur“ oder auf „ELSE-Anweisung“ beziehen. Korrigiert könnte der Satz so lauten:

Wenn eine IF-Kontrollstruktur eine ELSE-Anweisung enthält, dann wird genau ein Block der IF-Kontrollstruktur ausgeführt.“ (tekom 2013, 60)

Geeignete Landessprache

Informationsprodukte müssen in einer Landessprache verfasst sein, die von der Zielgruppe verstanden wird. So fordert beispielsweise die Maschinenrichtlinie: „Jeder Maschine muss eine Betriebsanleitung in der [Amtssprache] des Mitgliedstaats beiliegen, in dem die Maschine in Verkehr gebracht und/oder in Betrieb genommen wird.“ (Europäische Union 2006)

Dass dieser Aspekt durchaus nicht immer eine Selbstverständlichkeit ist, zeigt zum Beispiel der „Landmaschinen-Fall":

Ein Hersteller von Landmaschinen in den USA lieferte für seine Maschinen ordentliche Betriebsanleitungen mit. Für den US-amerikanischen Markt waren diese auf Englisch verfasst. Aufgrund einer Fehlbedienung geschah jedoch ein Unfall, es kam zur Klage und der Hersteller wurde für schuldig befunden. Denn: Der Hersteller hätte überprüfen müssen, wer die Zielgruppe ist bzw. wer die Landmaschinen tatsächlich bedient. Dann wäre ihm aufgefallen, dass überwiegend Spanisch sprechende Immigranten die Maschinen bedienen. Mindestens alle sicherheitsrelevanten Informationen hätten in der Folge auch auf Spanisch vorliegen müssen. (Quelle unbekannt, aus dem Gedächtnis)

Gut leserlich

Die Leserlichkeit betrifft die optischen Eigenschaften eines Textes. Dazu zählen unter anderem:

Geeignete Typografie

Standard ist normalerweise serifenlose Schrift. Serifenlose Schriften können im Allgemeinen am besten gelesen werden.

Geeignete Schriftgröße

Die Norm DIN EN 82079-1 empfiehlt für den Fließtext in Handbüchern und auf Bildschirmen eine Mindestschriftgröße von 10 Punkt, für Überschriften 12 Punkt. Für sehr kleine Produkte und Verpackungen werden mindestens 6 Punkt empfohlen (vgl. Beuth 2013, 35).

Gute Kontraste

Standard ist schwarze Schrift auf weißem Grund. Bei der Verwendung von Farben sollte sichergestellt werden, dass diese auch bei einem Graustufen-Ausdruck noch ausreichende Kontraste bieten (vgl. Beuth 2013, 37).

Gut erkennbare Abbildungen

Abbildungen sollten stets in ausreichender Qualität verwendet werden, so dass sie sowohl am Bildschirm, als auch in Ausdrucken deutlich erkennbar sind.

Reibungsloser Zugang möglich

Bei der Erstellung von technischer Dokumentation sollte berücksichtigt werden, unter welchen Umständen die Zielgruppe sie voraussichtlich nutzen wird. Die Art der Darbietung soll dieses Nutzungsverhalten unterstützen und einen reibungslosen Zugriff auf die Informationen ermöglichen. Neben der Leserlichkeit (siehe obiger Abschnitt „Gut leserlich“) sind hier beispielsweise noch folgende Aspekte relevant:

Hilfreiche Navigationsmittel

Neben Inhaltsverzeichnissen werden häufig auch Stichwortverzeichnisse gern von Lesern genutzt, um schnell bestimmte Informationen zu finden. Auch Griffregister können sehr nützlich sein. Diese Navigationsmittel sind jedoch bei der Erstellung der technischen Dokumentation mit einem erhöhten Aufwand verbunden. Das Kosten-Nutzen-Verhältnis muss auch hier abgewogen werden.

Geeignetes Medium

Das Medium, auf dem die technische Dokumentation ausgeliefert wird, darf dem Nutzer nicht den Zugriff auf die Informationen erschweren. Wird beispielsweise eine Gebrauchsanleitung nur als PDF-Dokument geliefert, nicht in Papierform, dann muss sichergestellt sein, dass der Leser einen Rechner mit der nötigen Software zur Verfügung hat, um das PDF-Dokument öffnen zu können.

Beispiel: Bei einem Laserdrucker wird man davon ausgehen können, dass der Nutzer auch einen Rechner zur Verfügung hat. Bei einem Toaster wäre diese Voraussetzung jedoch nicht unbedingt gegeben. Beide Geräte haben sehr unterschiedliche Zielgruppen.

Zielgruppengerechter Inhalt und Umfang der technischen Dokumentation

Das Motto lautet: „So viel wie nötig, so wenig wie möglich!“

Die technische Dokumentation muss alle Informationen enthalten, die erforderlich sind, damit der Nutzer das Produkt gefahrlos verwenden und den Funktionsumfang ausschöpfen kann. Alles Weitere ist meistens überflüssig.

Je umfangreicher beispielsweise eine Gebrauchsanleitung ist, …

  • … desto größer ist die Hürde für den Nutzer, die Gebrauchsanweisung überhaupt zu lesen,
  • … desto schwieriger ist es für den Nutzer, einen Überblick über die Inhalte zu bekommen.

Nebenbei bemerkt steigen mit dem Umfang einer Anleitung auch die Kosten für die Erstellung der Gebrauchsanleitung, insbesondere für die Übersetzungen. Auch der Pflegeaufwand nimmt mit dem Umfang zu.

Häufige Negativbeispiele sind Gebrauchsanweisungen, die von den Entwicklern eines Produktes geschrieben wurden. Entwickler haben eine ganz andere Sichtweise auf ihr Produkt, sie halten andere Dinge für wichtig als die Nutzer des Produktes. Typische Fehler solcher Gebrauchsanleitungen sind:

  • umfangreiche Beschreibungen technischer Hintergründe und Zusammenhänge, die für den Gebrauch des Produkts jedoch nicht relevant sind
  • dadurch oft insgesamt ein unnötig großer Umfang
  • unvollständige, nicht leicht nachvollziehbare Handlungsanleitungen, weil die Vorkenntnisse der Zielgruppe kaum berücksichtigt oder falsch eingeschätzt wurden

Korrekter Inhalt der technischen Dokumentation

Die Inhalte von technischer Dokumentation sollen selbstverständlich korrekt sein. Hierzu arbeiten sich Technische Redakteure in das betreffende Produkt ein, um es anschließend in ausreichender, zielgruppengerechter Tiefe beschreiben zu können. Eine enge Zusammenarbeit mit den Entwicklern des Produkts ist unbedingt nötig.

Fehlerquellen können jedoch auch in der Übersetzung der technischen Dokumentation liegen. Abhängig von der Qualifikation und Motivation der Übersetzer und von der Qualität der Zusammenarbeit mit dem Auftraggeber können sich auch bei der Übersetzung Fehler einschleichen. Diese Fehler bleiben oft unbemerkt, weil der Auftraggeber die Zielsprache nicht beherrscht.

Sichere Anleitungen

Alle Sicherheitsstandards, die für eine Branche und für ein Produkt relevant sind, müssen selbstverständlich berücksichtigt werden. Das Ziel ist, dem Nutzer alle Informationen an die Hand zu geben, damit dieser das Produkt möglichst gefahrlos verwenden kann. Der Nutzer muss deshalb auch über Restrisiken aufgeklärt werden.

Dieser Artikel ist ein Auszug aus dem kostenfreien E-Book "Grundlagen der technischen Dokumentation - Motivationen, Methoden und Zusammenhänge".