Dietrich Juhl

Dietrich Juhl arbeitet seit 1980 in der Technischen Dokumentation.
Er hat selber sehr viele Anleitungen geschrieben, Konzepte entwickelt und Theorien für verständliche Anleitungen aufgestellt. Ausserdem hat er diverse Ausbildungen zum Technischen Redakteur entwickelt und als Dozent und Prüfer gearbeitet (VDI, tecteam Bildungsinstitut, tekom Zertifizierung, TAE Fachreferent/in Technische Redaktion).
Dietrich Juhl ist bekannt für seine Bücher zur Technischen Dokumentation.

Dietrich Juhl hat 1989 zusammen mit Herbert Herzke und Horst Kleiner die Firma tecteam GmbH und das tecteam Bildungsinstitut gegründet und aufgebaut.
Er arbeitet heute als Fachbuchautor für Technische Dokumentation
(Schwerpunkte: Verständlich schreiben, Software-Anleitungen, Visualisieren).

 

Sicherheitshinweise und Warnhinweise in Anleitungen, Betriebsanleitungen, Bedienungsanleitungen

In der Technischen Dokumentation sind Sicherheitshinweise und Warnhinweise besonders wichtig. Die DIN EN82079-1 macht dazu einige Vorgaben. Allgemeine Sicherheitshinweise im Kapitel Sicherheit.
Warnhinweise bei der Handlung, auffällig mit Warnzeichen.

ANSI Z535-6, Z535-4. Struktur, Gestaltung.
In Anleitungen, Bedienungsanleitungen oder Betriebsanweisungen hat die Sicherheit der Anwender, User eine große Bedeutung.

Sicherheitshinweise

Sicherheitshinweise sollen dem Benutzer eine sichere Handhabung ermöglichen. Sie können ein Sicherheitsverständnis aufbauen, allgemeine Sicherheits- und Warnhinweise geben.
DIe Sicherheitshinweise sind meist in einem eigenen Kapitel am Anfang der Anleitung zusammen gefaßt.

Bestimmungsgemäßer Gebrauch

  • Beschreibung des bestimmungsgemäßen Gebrauchs
  • Grenzen der Anwendung
  • Warnhinweise bezüglich einer vernünftigerweise vorhersehbaren Fehlanwendung

Zielgruppe

  • Beschreibung der Nutzer
  • Einschränkung des Nutzerkreises
  • Gefahren für bestimmte Personengruppen

Gefahren

  • allgemeine Gefahren
  • Schutzmaßnahmen, die der Nutzer treffen muss
  • Warnhinweise bezüglich der Gefährdungen
  • mögliche gesundheitliche Schäden bei Nichtbeachtung

Besondere Vorsichtsmaßnahmen

  • Beschränkungen und/oder Empfehlungen für die sichere Anwendung
  • Hinweis auf die Notwendigkeit, den Zugang für Kinder oder den Kontakt mit Haustieren … zu verhindern.
  • Anhaltspunkte, wann Produkte nicht mehr sicher zu nutzen sind.

Erklärung der Symbole

  • Erklärung der grafischen Symbole für sicherheitsbezogene Informationen

Warnhinweise

Warnhinweise stehen meistens im Zusammenhang mit dem gefährlichen Handlungsschritt.
Vor dem gefährlichen Handlungsschritt. Nach DIIN EN 82079-1.
Auch die amerikanischen Normen machen Vorgaben: ANSI Z535.6, Z535.4. Struktur, Gestaltung.

Gliederung nach SAFE

Warnhinweise werden oft nach SAFE strukturiert. Diese starre Strukturierung hat sich nicht bewährt. Heute sind andere Strukturierungen möglich und sinnvoll.

  • Aufmerksamkeitszeichen
  • Signalwort (Gefahr, Warnung, Vorsicht)
  • Art und Quelle der Gefahr
  • mögliche Folgen
  • Entkommen: Maßnahmen zur Abwendung der Gefahr

Anleiten statt warnen, die eskalierte Handlungsanweisung

Die richtige Anleitung zum Handeln ist das wichtigste Element für sichere Bedienungs- oder Betriebsanweisungen.
Der Benutzer muss informiert werden, wie er richtig handeln kann. Neben der reinen Schritt-für-Schritt-Anleitung kann die Handlungsanweisung eskaliert werden.
Dabei gibt es mehrere Stufen bevor gewarnt werden kann.
DIe Warnung (Art und Quelle, Folgen bei Missachtung) steht erst an letzter Stelle.

Wann muss gewarnt werden?

Gefährlicher Handlungsschritt, ungenaue Handlung, Betonung der Wichtigkeit, Warnung vor allgemeinen Gefahren bei der Handlung.
Verbot von Handlungen und Warnung vor Folgen.

Gestaltung von Warnhinweisen

Der Warnhinweis soll hervorgehoben sein, Hervorhebung. Genauso hervorgehoben wie andere Instruktionen.
Nicht mehr im Kasten, mit Warnzeichen, Warndreieck, Warnfarbe.

Warnzeichen nach ISO 7010. W001, W01, allgemeines Warnzeichen. Warndreieck.
Spezielle Warnzeichen, Warnung vor Laserstrahlung, Augenschutz benutzen.

Produkthaftung, Produzentenhaftung

Instruktionspflicht, richtig anleiten, Warnung vor Gefahren, Restrisiko. Jeder Hersteller ist verpflichtet Informationen zum Gebrauch beizufügen.
Besonders wenn es um die Sicherheit des Anwenders oder anderer Personen geht.

Haftung nach BGB für Schäden, Personenschäden, Verletzung oder Tod des Anwenders.

Risikobeurteilung, Risikoanalyse, Risikobewertung

Nach Maschinenrichtilinie muss eine Risikobeurteilung während der Entwicklung durchgeführt werden.
Gesundheit und Leben der Anwender sollen geschützt werden, schon während der Konstruktion Gefährdungen ausschließen.
Risikominderung, 2006/42/EG Abs. 1.1.2.b

  • Beseitigung oder Minimierung der Risiken. Integration der Sicherheit in Konstruktion.
  • Notwendige Schutzmaßnahmen
  • Unterrichtung der Benutzer über Restrisiken, Hinweis auf erforderliche Ausbildung, Schutzmaßnahmen. Persönliche Schutzausrüstung.

Restgefahren aus der Risikobeurteilung

Eine Anleitung muss vor den Gefahren warnen, die als Restgefahren in der Risikobeurteilung ermittelt wurden. Hierfür muss die Risikobeurteilung bei der Erstellung der Technischen Dokumentation vorliegen.

Schwere und Wahrscheinlichkeit, Gefahr, Warnung, Vorsicht.
Danger, Warning, Caution, Notice. Safty Instuctions.

Vorhersehbare Fehlanwendung. Bestimmungsgemäßer Gebrauch. Naheliegender Fehlgebrauch, Fehlverhalten. Missbrauch.
Normalen Menschenverstand voraussetzen.

Warnhinweise nach ANSI Z535.6

USA, Produktnutzer mit geringerem intellektuellen Niveau. Signalwortfeld.
Embeded warnings, integrierte Warnhinweise.

Hund in der Mikrowelle, unbegründete Haftungsansprüche ausschließen. Allerdings ist das Rechtssystem in USA ganz anders als in Europa.

Strukturierung, Strukturen von Technischer Dokumentation

Buch von Dietrich Juhl: Technische Dokumentation – verständliche Anleitungen und Beispiele
Standardwerk der Technischen Dokumentation, abgeglichen mit der Norm DIN EN 82079-1.
Das Buch von Dietrich Juhl zeigt Strukturen, die der Autor aus der Praxis entwickelt hat. Mit diesen Strukturen lassen sich Anleitungen ganz leicht schreiben, weil die Struktur eine gute Vorgabe macht. Die von Dietrich Juhl dargestellten Strukturen sind konkret auf die Technische Dokumentation bezogen und bieten mehr konkrete Hilfe als Funktionsdesign® oder Information Mapping®.

Analysen, Konzepte für Technische Dokumentation

Vor der Erstellung von Technischer Dokumentation, besonders vonBedienungsanleitungen 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:

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.

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.

Standardstrukturen, Zielprogrammierung, zielorientiertes Schreiben, lean documentation, Juhl, XML

Zielprogrammierung, Strukturen der Technischen Dokumentation“
Sicherheit, Leistungsbeschreibung, Gerätebeschreibung, Aufbau und Funktion, Tätigkeitsbeschreibung nach Produktlebenszyklus,
Funktionsweise, Technische Unterlagen

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 Dokumenation ableiten.
DIese Strukturierung ist besonders in Ausbildungen für Technische Redakteure interessant. So verwendet beispielsweise die WBS das Buch in jedem Kurs.
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®.

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. Klassifizierung, Oberbegriff, Normalleistung, Besonderheiten, Optionen.

Gerät, Gerätebeschreibung. Aufbau und Funktion.

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

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.
Neben der klassischen Juhl’schen Handlungsanweisung gibt es einige andere Möglichkeiten Handlungswissen zu vermitteln.
Technische Redakteure sollten deshalb unbedingt kennen:

Alternativen zur Handlungsanweisung

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

Handlungsanweisung, klassische Handlungsanweisung, Schritt für Schritt, Step by Step, Juhl’sche Handlungsanweisung

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

Struktur Juhlsche Handlungsanweisung
  • Überschrift aus Anwendersicht Ansagetext aufsprechen
  • Ziel der Handlung Sie können … tun. Das ist z. B. sinnvoll, um …
  • Ggf. Überblick über die Handlung oder Hinweis auf ähnliche Handlungen.
    Nur bei komplexen Handlungen
  • Ggf. Voraussetzungen,
    vorzugsweise als Handlungsschritt,
    … muss erfüllt sei,
    Stellen Sie sicher, dass …
  • Schritt für Schritt
    • Handlungsaufforderung
    • ggf. Bild der Handlung
    • ggf. Feedback
    • ggf. Hintergrund (warum oder was dadurch bewirkt wird)
    • Drücken Sie die Taste … Die Lampe leuchtet, Dadurch ist …
  • Resultat der Handlung Jetzt ist … fertig
  • Ggf. Ausblick

Regeln, Systematik, Abbildung der Handlung, Systembeschreibung

alternative Methoden 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

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

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, Ordnungselemente in Technischer Dokumentation

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.

Orientierungselemente helfen bei unterschiedlichen Lesearten

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

Verständniselemente

Advance Organizer, Zusammenfassung, Vorschau. Diese Elemente dienen dazu dem Benutzer das Verständnis zu erleichtern.
Das ist gerade bei Bedienungsanleitungen eine wichtige Aufgabe.

Glossar

Für ein Glossar gibt es eine gut geeignete Struktur.

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

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.

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

Ganze Anleitungen

Es gibt in der TD unterschiedliche Anleitungen für unterschiedliche Zwecke. Hier sollen ein paar Beispiele beschrieben werden.
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.

  • 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 Technische Dokumentation
  • Automatisch arbeitende Maschine
  • Planungsunterlage
  • Installationsanleitung, Montageanleitung
  • Wartungsanleitung
  • Serviceanleitung
  • Ersatzteilkatalog
  • Anlagen-Dokumentation

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.