Technische Dokumentation (eBook)

Dietrich Juhl arbeitet seit mehr als 20 Jahren auf dem Gebiet der technischen Dokumentation. Er ist technischer Redakteur, hat selbst viele Anleitungen geschrieben, in Aus- und Weiterbildung Studierende und Praktiker unterrichtet und arbeitet heute als freier Berater und Trainer. Anleitungen nach Konzepten des Autors haben bei mehreren Vergleichstests gewonnen.

Vorwort 5
Vorwort zur zweiten Auflage 7
Der Autor 8
Inhaltsverzeichnis 9
Einleitung 11
Exkurs: Strukturierte Dokumentation und XML 14
Hinweise zu diesem Buch 17
Lesehinweise zu diesem Buch 17
Die Rolle der Bedienungsanleitung im Kontext Bedienkonzept Anleitung Schulung Anwendung 19
Exkurs: Vorschriften, Gesetze, Sicherheit 20
Ausblick: Bald elektronische Anleitungen 21
Handlungsorientierung 22
Was ist Technische Dokumentation? 25
Was-macht-Wer?-Matrix 27
Das Konzept 29
Inhalte 32
Umrandung 33
Die fünf Inhalte 34
Leistungsbeschreibung 35
Gerätebeschreibung 43
Tätigkeitsbeschreibung 53
TB 1: Handlungsanweisung 57
TB 2: Beschreibung der Bedienelemente 69
TB 3 : Software-Funktionsbeschreibung 72
TB 4: Abbildung der Handlung 77
TB 5 : Abbildung des Handlungsergebnisses 80
TB 6 : Vermittlung von Systematik 84
TB 7: Regeln 87
TB 8 : Systembeschreibung 92
Gegenüberstellung der möglichen Tätigkeitsbeschreibungsarten 94
Exkurs: Anleitung auf Handlungsorientierung prüfen 97
Beschreibung der Funktionsweise 99
Technische Unterlagen 109
Ordnungselemente 121
Titelblatt 124
Inhaltsverzeichnis 126
Zu dieser Anleitung 129
Seitenzahlen 133
Register 135
Lebende Kolumnentitel 137
Bildverzeichnis 140
Literaturverzeichnis 142
Index, Stichwortverzeichnis 143
Exkurs: Volltextsuche bei elektronischen Anleitungen 145
Rückseite 147
Verständniselemente 149
Advance Organizer 152
Merksatz 154
Beispiele, Übungen 155
Zusammenfassung 156
Glossar 158
Spezielle Inhalte 161
Impressum 164
Sicherheitshinweise 166
Vorwort 171
Bestimmungsgemäßer Gebrauch 172
Technische Daten 174
Lieferumfang 176
Wartungsplan 178
Fehlersuchtabelle 179
Garantie 184
Credits 186
Adressen 187
Exkurs: Reihenfolge beim Schreiben 189
Komplette Anleitungen 191
Normale Anleitung 194
Sofort-Anleitung 202
Exemplarische Einführung 207
Nachschlage-Anleitung 209
Kurzanleitung 213
Schnellstart-Anleitung 218
Software-Dokumentation bei „kleiner“ Software 220
Software-Dokumentation bei umfangreicher Software 222
Exkurs: Vergleich geräteorientierte / handlungsorientierte Anleitung 225
Allgemeine Technische Dokumentation 227
Planungsunterlage 230
Installations-Anleitung, Montage-Anleitung 233
Wartungsanleitung 237
Service-Anleitung 240
Ersatzteil-Katalog 245
Anlagen-Dokumentation 249
Anhang 251
Gesamtstruktur 253
Normen und Richtlinien 257
Index 265

Das Konzept (S.21)

Im Folgenden möchte ich Ihnen ein Konzept vorstellen, das Ihnen schnell hilft, gute Anleitungen in kurzer Zeit zu erstellen. Beachten Sie dazu auch das Bild auf der nächsten Seite.

Fünf Inhalte

Die fünf Inhalte bilden den Kern der Anleitung. Wenn Sie diese Inhalte richtig beschreiben, haben Sie die notwendigen Informationen fixiert. Diese „lean documentation" würde dem Anwender im Grunde genügen, das Gerät zu verstehen und zu bedienen. Alle weiteren Elemente (außen herum) sind nicht unbedingt notwendig, in vielen Fällen aber hilfreich. (Eine Ausnahme bilden natürlich die Sicherheitshinweise.)

Strukturen zum Schreiben

Im weiteren Verlauf des Buches finden Sie Strukturen, mit deren Hilfe Sie die Inhalte und alle weiteren Elemente einfach (d.h. ohne viel Nachdenken) schreiben können.

Umrandung

Die vielen Elemente der Umrandung (siehe Bild) helfen Ihnen, Ihre Inhalte gezielt zu ergänzen, und die Anleitung so zu komplettieren, dass sich ein Buch ergibt.

Vorteil der inhaltlichen Trennung

Die Trennung der Inhalte in die fünf Kategorien bietet Ihnen beim Schreiben viele Vorteile:

• Sie haben von Anfang an eine Grobgliederung.

• Sie haben für alle Inhalts-Elemente eine Struktur, nach der Sie formulieren können.

• Sie können die einzelnen Inhalts-Elemente gezielt optimieren.

• Sie haben sehr schnell eine Anleitung, die alle notwendigen Informationen enthält.

Reihenfolge beim Schreiben

Wenn Sie sich beim Schreiben zuerst auf die fünf Inhalte konzentrieren, behalten Sie einen besseren Überblick und lenken sich selbst nicht durch andere Elemente ab. Erst wenn Sie die fünf Inhalte fertig haben, sollten Sie sie durch die speziellen Inhalte, Verständnis- und Ordnungselemente ergänzen. Dabei helfen Ihnen auch hier die konkreten Strukturen beim Schreiben. Viele Elemente der Umrandung liegen strukturell fest und lassen sich so standardisieren, dass sie vom DTP- oder DMS-System automatisch zusammengestellt werden können.

Inhalte

Den Kern einer Anleitung bilden die fünf Inhalte:

• Leistungsbeschreibung,

• Gerätebeschreibung,

• Tätigkeitsbeschreibung,

• ggf. Funktionsweise (nur notwendig, wenn der Benutzer die Funktionsweise verstehen muss),

• ggf. Technische Unterlagen (wie z.B. Konstruktionszeichnung, Schaltplan, Ersatzteilliste...)

In den fünf Inhalten stehen die wesentlichen Punkte für den Benutzer, um das Gerät kennenzulernen und die möglichen oder notwendigen Tätigkeiten zu erlernen.

Umrandung

Um die fünf Inhalte herum sind viele weitere Elemente angeordnet. Sie dienen dem Benutzer zu unterschiedlichen Zwecken:

• zur Orientierung (Ordnungselemente),

• helfen ihm schwierige Dinge zu verstehen (Verständniselemente)

• oder sind spezielle Inhalte, die in ihrer Form häufig festliegen.

Die fünf Inhalte

Die fünf Inhalte liefern dem Benutzer die benötigten Informationen in der richtigen Reihenfolge. Zuerst erfährt er wichtige Grundlagen zum Verständnis (Leistungs- und Gerätebeschreibung) und bekommt in der Tätigkeitsbeschreibung die konkrete Anleitung zum Handeln. Die Beschreibung der Funktionsweise und die Technischen Unterlagen sind bei einfachen Geräten nicht notwendig.