Technische Dokumentation - verständliche Anleitungen und Beispiele.
Buch von Dietrich Juhl

Inhaltsverzeichnis des Buchs

Beispiele und Kommentare zum Kapitel

Vorabüberlegungen und -untersuchungen

• Produktanalyse
• Tätigkeitsanalyse
• Was-macht-Wer?-Matrix
• Zielgruppe analysieren
• Zielanalyse
• Anwendungsszenarien
• Analyse der Rahmenbedingungen

Analysen und Konzepte für die Technische Dokumentation

Vor der Erstellung von Technischer Dokumentation, besonders von Bedienungsanleitungen und Betriebsanleitungen müssen diverse Betrachtungen angestellt werden, um die Anleitung zielgerecht schreiben zu können.
Hierfür gibt es z.B. die folgenden Analysen:

Abb: Analysen zur TD	Abb: Persona als Darstellung der Zielgruppe

Zielgruppe und Darstellung als Persona

Die Zielgruppe muss analysiert werden, d.h. es werden die Merkmale der potentiellen Anwender systematisch ermittelt. In einigen Fällen genügt auch eine Abschätzung.

Zur Anschauung kann ein Anwender als Persona dargestellt werden, siehe Beispiel oben.

Das Konzept

• Fünf Inhalte
• Inhalt
• Umrandung
• Abgrenzung der fünf Inhalte

Standardstrukturen, Zielprogrammierung, lean documentation

Diese Abbildung und alle Strukturen aus dem Buch gibt es als Flyer, zu bestellen auf: www.juhl.de/buecher.

Der Autor beschreibt in seinem Buch Standardstrukturen, wie sie in jeder Technischen Dokumentation verwendet werden können. Aus nur wenigen Elementen lassen sich Anleitungen, Bedienungsanleitungen oder andere spezielle Technische Dokumenationen ableiten.
Diese Strukturierung ist besonders in Ausbildungen für Technische Redakteure interessant.
So verwendet beispielsweise die WBS das Buch in ihren Kursen.
Der Name "Zielprogrammierung" soll zum Ausdruck bringen, dass bei bekannten Ziel die Anleitung programmatisch geschrieben werden kann.

Diese Standardstrukturen sind auch für andere Formen der Technischen Dokumentation anwendbar: Vor allem müssen die Inhaltskategorien Leistungsbeschreibung, Gerätebeschreibung, Tätigkeitsbeschreibung und Beschreibung der Funktionsweise streng unterschieden werden, denn dann können die Inhalte z.B. durch Schreiben nach Struktur optimiert werden.

Alternative Strukturierungsmethoden: Funktionsdesign®, Information Mapping®.

Sicherheit

• Kapitel „Sicherheit"
• Warnhinweise
• Beispiele: Warnhinweise

Sicherheit

Laut DIN EN 82079 gliedern sich die Informationen zur Sicherheit in ein Kapitel "Sicherheit" und "Warnhinweise" in Zusammenhang mit der Handlung.
Das (in der 3. Auflage) neue Kapitel leitet systematisch her, wie Sicherheitshinweise aufgebaut werden müssen und vor welchen Gefahren in welcher Art und Weise gewarnt werden muss.

Leistung

• Die Leistungsbeschreibung
• Zweck
• Ausführung

Leistung, Leistungsbeschreibung

Die Leistungsbeschreibung ist besonders wichtig, sie stimmt den Anwender auf das Gerät ein, fokussiert seine Erwartungen und motiviert ihn zum Gebrauch auch ausgefallener Features.

Bestimmungsgemäßer Gebrauch.

Struktur: Klassifizierung, Oberbegriff, Normalleistung, Besonderheiten, Optionen.

Gerät

• Die Gerätebeschreibung
• Zweck
• Ausführung

Gerät, Gerätebeschreibung. Aufbau und Funktion

Die Gerätebeschreibung führt den Benutzer in die Hardware ein, beschreibt die unterschiedlichen Komponenten und ihre Funktion im Gesamtsystem.
Besonders interessant für den Anwender sind die Bedienteile, wie sie heißen und welche Funktion sie haben.
Bei Software kann das auch der Aufbau des Bildschirms sein.

• Abbildung des Gerätes, der Bedienteile, bzw. Bedienelemente.
• Teilenummer, Positionsnummer.
• Bedeutung von Signalen, Blinksignale, LEDs, Akustische Signale.
   

Tätigkeiten

Die Tätigkeitsbeschreibungen (TB)

• TB 1: Handlungsanweisung
• TB 2: Beschreibung der Bedienelemente
• TB 3: Softwarefunktionsbeschreibung
• TB 4: Abbildung der Handlung
• TB 5: Abb. des Handlungsergebnisses
• TB 6: Vermittlung von Systematik
• TB 7: Regel
• TB 8: Systembeschreibung

Auswahl der geeigneten Tätigkeitsbeschreibung

Tätigkeitsbeschreibungen

Die eigentliche Aufgabe einer Bedienungsanleitung ist die Vermittlung von Handlungswissen. Der Benutzer muss nach Lesen in der Lage sein, das Gerät selbstständig zu benutzen.

klassische Handlungsanweisung, Schritt für Schritt, Juhl'sche Handlungsanweisung

Geeignet für alle Handlungen, bei denen der Anwender Schritt für Schritt handeln kann.

Struktur der Juhl'schen Handlungsanweisung

Alternativen zur Handlungsanweisung

Neben der klassischen Juhl'schen Handlungsanweisung gibt es einige andere Möglichkeiten Handlungswissen zu vermitteln.
Technische Redakteure sollten deshalb unbedingt kennen:

• Bedienelemente
• SW-Funktionsbeschreibung
• Abbildung der Handlung
• Handlungsergebnis
• Vermittlung von Systematik
• Regeln
• Systembeschreibung

Regeln, Systematik, Abbildung der Handlung, Systembeschreibung

... sind alternative Methoden die zur Handlung anzuleiten.
Leider sind die alternativen Methoden Handlung zu vermitteln bei den Technischen Redakteuren nicht verbreitet. Dabei kann die Handlungsanweisung nur in 80% der Fälle sinnvoll eingesetzt werden. Viele andere Handlungen können besser mit alternativen Methoden beschrieben werden. Eine Anleitung für ein Spiel zum Beispiel kann keine Handlungsanweisung verwenden.
Auch bei vieler Software ist die Schritt für Schritt Anleitung nicht angebracht. Vielfach ist die Vorgehensweise eher klar und es muss mehr das Ziel der Handlung vermittelt werden, ggf. muss Orientierung gegeben werden (wo finde ich was?) und es müssen die Parameter erklärt werden.

Software, SW-Funktionsbeschreibung

In Softwareanleitungen, Handlungsziel, Zweck der Funktion, Aufruf der Funktion, Erklärung der Parameter, Beispiele.
Screenshots, Eingabefelder, Optionsfelder, Checkboxen, Dialogboxen.

Funktionsweise

Beschreibung der Funktionsweise

Funktionsweise

Wie funktioniert das Gerät innendrin? Beschreibung der Funktionsweise, immer mit Bild. Möglicherweise als Phasenbild.
Bilder: Schnittbild, Schema, Diagramm, Funktionsschema, Schaltplan, Hydraulikplan, Blockschaltbild kommen in Frage.
Funktion versus Funktionsweise. Im Deutschen missverständlich.

Technische Unterlagen

• Nicht geeignet für Benutzeranleitung!
• Für Beschaffung, Service oder zur allgemeinen Dokumentation
• Zusammenstellung von technischen Unterlagen
• Beispiele für Technische Unterlagen
• Nicht Thema dieses Buches!

Technische Unterlagen

Diverse Unterlagen zum Gerät, Maschine, Anlage. Konstruktionszeichnungen, Schaltpläne, Listen.
Die Technischen Unterlagen taugen meist als Anleitung nicht. Ausnahme sind Anleitungen zu OEM-Produkten, bei denen der technische Verwender eher solche Unterlagen einsetzen kann.

• Maschinenbau: Konstruktionszeichnung, Hydraulikplan, Ersatzteilliste
• Elektrotechnik: Schaltplan, Blockschaltbild, Bestückungsplan, Kontaktbelegung
• Computer: Flowchart, Pflichtenheft, Schnittstellenbeschreibung

Orientierungselemente

• Layout
• Titelblatt
• Inhaltsverzeichnis
• Zu dieser Anleitung
• Seitenzahle
• Register
• Lebende Kolumnentitel
• Bildverzeichnis
• Literaturverzeichnis
• Index, Stichwortverzeichnis
• Exkurs: Volltextsuche bei elektronischen Anleitungen
• Rückseite

Orientierungselemente, Ordnungselemente in Technischer Dokumentation

Technische Dokumentation hat immer diverse Orientierungselemente, wie man sie als Leser von Büchern gewohnt ist.
Bei TD ist Orientierung besonders wichtig, weil der Benutzer häufig nur eine Teil der TD lesen will.

• Orientierungselemente helfen bei unterschiedlichen Lesearten
• Layout, strukturierte Information. Fließtext ist häufig nicht geeignet, Punktaufzählung bietet mehr Anhalt.
• Tabellen sind in der TD sehr beliebt, viele Informationen können übersichtlich dargestellt werden und ermöglichen einen gezielten Zugriff.
• Marginalien, Punktaufzählung, Listen, nummerierte Liste, tabellarische Darstellung, Tabellenspalte, Tabellenzeile.

Verständniselemente

• Advance Organizer
• Beispiel
• Zusammenfassung
• Glossar

Verständniselemente

Verständniselemente dienen dazu dem Benutzer das Verständnis zu erleichtern.
Das ist gerade bei Bedienungsanleitungen eine wichtige Aufgabe.

Glossar, Beispiel für eine Struktur

Für ein Glossar gibt es eine gut geeignete Struktur. Nach dieser Struktur läßt sich ein Glossareintrag leicht schreiben.

• Fachausdruck
• ggf. ausgeschriebene Abkürzung
• ggf. Herkunft, Wortherkunft
• ggf. Übersetzung
• Oberbegriff
• Merkmale, Nutzen
• Beispiele

Spezielle Inhalte

• Impressum
• Identifikation
• Vorwort
• Bestimmungsgemäßer Gebrauch
• Technische Daten
• Fachliche Grundlage
• Lieferumfang
• Warnhinweise
• Wartungsplan
• Fehlersuchtabelle
• Garantie
• Zertifikate
• Credits
• Adresse
• Exkurs: Reihenfolge beim Schreiben

Spezielle Inhalte

Spezielle Inhalte in der Technische Dokumentation, mit festliegendem Zweck, feste Strukturen, sind tradierte Elemente von Anleitungen.
Solche Speziellen Inhalte liegen meist in der Struktur fest (meist tradierter Aufbau) und können so vom Technischen Redakteur abgearbeitet werden.

Beispiel: Stuktur der Fehlersuchtabelle

Komplette Anleitungen

• Normale Anleitung
• Sofortanleitung
• Exemplarische Einführung (Tutorial)
• Nachschlageanleitung
• Kurzanleitung
• Schnellstartanleitung
• Softwaredokumentation bei „kleiner“ Software
• Softwaredokumentation bei umfangreicher Software
• Exkurs: Vergleich geräteorientierte/ handlungsorientierte Anleitung
• Allgemeine Techn. Dokumentation
• Automatisch arbeitende Maschine
• Planungsunterlage
• Installationsanleitung, Montageanleitung
• Wartungsanleitung
• Anlagen-Dokumentation

Ganze Anleitungen

Es gibt in der TD unterschiedliche Anleitungen für unterschiedliche Zwecke.
Im Buch von Dietrich Juhl sind die unterschiedlichen Anleitungen beispielhaft erklärt und anhand vieler Beispiele dargestellt.
So findet auch der Anfänger Zugang zur Vielfalt der Technischen Dokumentation.
Alle Anleitungen lassen sich aus den bekannten Elementen "zusammenbauen".

Anleitungen, Bedienungsanleitungen, Betriebsanweisungen, Softwareanleitungen

Für Maschinenbau, Software, Geräte, Anlagen werden Anleitungen gebraucht. Informationen zur Benutzung. Grundlagen. Aufbau und Funktion.
Je nach Zweck gibt es sehr unterschiedliche Typen von Technischer Dokumentation. Jeder Typ muss für seinen Zweck optimiert sein.
Tutorial: Das Tutorial spielt eine besondere Rolle. Ich nenne es auch gerne Exemplarische Einführung.
Zeigt anhand eines Beispiels die Grundlagen der Bedienung und der Bediensystematik.

Ausblick

• Abspielgerät
• Gelten die Prinzipien auch für elektronische Anleitungen?
• Die Inhalte bleiben!
• Neue Möglichkeiten
• Formen elektronischer Dokumentation
• Integration und Verfügbarkeit

Elektronische Dokumentation

Technische Dokumentation wird zunehmend elektronisch publiziert.
Der Autor geht hier der Frage nach, wie Texte für elektronische Medien strukturiert werden müssen, ob sich die im Buch gezeigten Strukturen übertragen lassen oder was bei elektronischer Dokumentation anders gemacht werden muss.

Ein neues Buch "Elektronische Dokumentation - Grundlagen textbasierte Anleitungen" erscheint in Kürze.