Sie sind hier
E-Book

Technische Dokumentation

Praktische Anleitungen und Beispiele

AutorDietrich Juhl
VerlagSpringer-Verlag
Erscheinungsjahr2006
Seitenanzahl262 Seiten
ISBN9783540278481
FormatPDF
KopierschutzDRM
GerätePC/MAC/eReader/Tablet
Preis49,99 EUR
Die 2. Auflage führt das bewährte Konzept - angereichert mit neuen Beispielen - weiter. Der Autor gibt einfach nachvollziehbare Vorgaben in Form von Bausteinen, nach denen Bedienungsanleitungen und technische Dokumentationen geschrieben werden können. Geboten werden ein geschlossenes Konzept und praktische Rezepte für verständliche Formulierungen. Zudem liefert das Buch die Grundlagen für eine XML-strukturierte Dokumentation, die zunehmend eingesetzt wird. Mehr als 100 vorbildliche Beispiele veranschaulichen das Thema.

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.

Kaufen Sie hier:

Horizontale Tabs

Leseprobe
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.
Blick ins Buch
Inhaltsverzeichnis
Vorwort5
Vorwort zur zweiten Auflage7
Der Autor8
Inhaltsverzeichnis9
Einleitung11
Exkurs: Strukturierte Dokumentation und XML14
Hinweise zu diesem Buch17
Lesehinweise zu diesem Buch17
Die Rolle der Bedienungsanleitung im Kontext Bedienkonzept Anleitung Schulung Anwendung19
Exkurs: Vorschriften, Gesetze, Sicherheit20
Ausblick: Bald elektronische Anleitungen21
Handlungsorientierung22
Was ist Technische Dokumentation?25
Was-macht-Wer?-Matrix27
Das Konzept29
Inhalte32
Umrandung33
Die fünf Inhalte34
Leistungsbeschreibung35
Gerätebeschreibung43
Tätigkeitsbeschreibung53
TB 1: Handlungsanweisung57
TB 2: Beschreibung der Bedienelemente69
TB 3 : Software-Funktionsbeschreibung72
TB 4: Abbildung der Handlung77
TB 5 : Abbildung des Handlungsergebnisses80
TB 6 : Vermittlung von Systematik84
TB 7: Regeln87
TB 8 : Systembeschreibung92
Gegenüberstellung der möglichen Tätigkeitsbeschreibungsarten94
Exkurs: Anleitung auf Handlungsorientierung prüfen97
Beschreibung der Funktionsweise99
Technische Unterlagen109
Ordnungselemente121
Titelblatt124
Inhaltsverzeichnis126
Zu dieser Anleitung129
Seitenzahlen133
Register135
Lebende Kolumnentitel137
Bildverzeichnis140
Literaturverzeichnis142
Index, Stichwortverzeichnis143
Exkurs: Volltextsuche bei elektronischen Anleitungen145
Rückseite147
Verständniselemente149
Advance Organizer152
Merksatz154
Beispiele, Übungen155
Zusammenfassung156
Glossar158
Spezielle Inhalte161
Impressum164
Sicherheitshinweise166
Vorwort171
Bestimmungsgemäßer Gebrauch172
Technische Daten174
Lieferumfang176
Wartungsplan178
Fehlersuchtabelle179
Garantie184
Credits186
Adressen187
Exkurs: Reihenfolge beim Schreiben189
Komplette Anleitungen191
Normale Anleitung194
Sofort-Anleitung202
Exemplarische Einführung207
Nachschlage-Anleitung209
Kurzanleitung213
Schnellstart-Anleitung218
Software-Dokumentation bei „kleiner“ Software220
Software-Dokumentation bei umfangreicher Software222
Exkurs: Vergleich geräteorientierte / handlungsorientierte Anleitung225
Allgemeine Technische Dokumentation227
Planungsunterlage230
Installations-Anleitung, Montage-Anleitung233
Wartungsanleitung237
Service-Anleitung240
Ersatzteil-Katalog245
Anlagen-Dokumentation249
Anhang251
Gesamtstruktur253
Normen und Richtlinien257
Index265

Weitere E-Books zum Thema: Systemadministration - IT

Information Lifecycle Management

E-Book Information Lifecycle Management
Prozessimplementierung Format: PDF

Im Zusammenhang mit IT-Governance, Sarbanes-Oxley Act und Basel II ist Information Lifecycle Management (ILM), ein Thema, das jeder CIO beherrschen muss. Information ist ein Produkt, das einem…

Zwischenbetriebliches Stammdatenmanagement

E-Book Zwischenbetriebliches Stammdatenmanagement
Lösungen für die Datensynchronisation zwischen Handel und Konsumgüterindustrie Format: PDF

Die effiziente Abwicklung zwischenbetrieblicher Marketing- oder Logistikprozesse setzt unternehmensübergreifend abgestimmte Stammdaten zu Produkten, Geschäftspartnern und Konditionen voraus. Der…

Zwischenbetriebliches Stammdatenmanagement

E-Book Zwischenbetriebliches Stammdatenmanagement
Lösungen für die Datensynchronisation zwischen Handel und Konsumgüterindustrie Format: PDF

Die effiziente Abwicklung zwischenbetrieblicher Marketing- oder Logistikprozesse setzt unternehmensübergreifend abgestimmte Stammdaten zu Produkten, Geschäftspartnern und Konditionen voraus. Der…

Zwischenbetriebliches Stammdatenmanagement

E-Book Zwischenbetriebliches Stammdatenmanagement
Lösungen für die Datensynchronisation zwischen Handel und Konsumgüterindustrie Format: PDF

Die effiziente Abwicklung zwischenbetrieblicher Marketing- oder Logistikprozesse setzt unternehmensübergreifend abgestimmte Stammdaten zu Produkten, Geschäftspartnern und Konditionen voraus. Der…

Management von IT-Architekturen

E-Book Management von IT-Architekturen
Leitlinien für die Ausrichtung, Planung und Gestaltung von Informationssystemen Format: PDF

Das bewährte Handbuch zur richtigen Vorgehensweise bei der Realisierung eines integrierten Architekturmanagements erscheint jetzt in 3. Auflage. In diesem Buch finden Sie maßgebliche Planungs- und…

Steuerung der IT im Klinikmanagement

E-Book Steuerung der IT im Klinikmanagement
Methoden und Verfahren Format: PDF

Unter dem wachsenden Kostendruck im Krankenhaus wird die Effizienz der Leistungserbringung immer wichtiger. Dabei spielt die IT eine zunehmend bedeutsamere Rolle. Sie ist inzwischen ein nicht mehr…

Information Lifecycle Management

E-Book Information Lifecycle Management
Prozessimplementierung Format: PDF

Im Zusammenhang mit IT-Governance, Sarbanes-Oxley Act und Basel II ist Information Lifecycle Management (ILM), ein Thema, das jeder CIO beherrschen muss. Information ist ein Produkt, das einem…

Zwischenbetriebliches Stammdatenmanagement

E-Book Zwischenbetriebliches Stammdatenmanagement
Lösungen für die Datensynchronisation zwischen Handel und Konsumgüterindustrie Format: PDF

Die effiziente Abwicklung zwischenbetrieblicher Marketing- oder Logistikprozesse setzt unternehmensübergreifend abgestimmte Stammdaten zu Produkten, Geschäftspartnern und Konditionen voraus. Der…

Information Lifecycle Management

E-Book Information Lifecycle Management
Prozessimplementierung Format: PDF

Im Zusammenhang mit IT-Governance, Sarbanes-Oxley Act und Basel II ist Information Lifecycle Management (ILM), ein Thema, das jeder CIO beherrschen muss. Information ist ein Produkt, das einem…

Linux-Systemadministration

E-Book Linux-Systemadministration
Grundlagen, Konzepte, Anwendung Format: PDF

Linux ist eine fest etablierte, für vielfältige Rechnerarchitekturen verfügbare Plattform und zeichnet sich insbesondere durch die hohe Stabilität und Sicherheit des Systems aus. Dieses Buch bietet…

Weitere Zeitschriften

bank und markt

bank und markt

Zeitschrift für Banking - die führende Fachzeitschrift für den Markt und Wettbewerb der Finanzdienstleister, erscheint seit 1972 monatlich. Leitthemen Absatz und Akquise im Multichannel ...

Card-Forum

Card-Forum

Card-Forum ist das marktführende Magazin im Themenbereich der kartengestützten Systeme für Zahlung und Identifikation, Telekommunikation und Kundenbindung sowie der damit verwandten und ...

DULV info

DULV info

UL-Technik, UL-Flugbetrieb, Luftrecht, Reiseberichte, Verbandsinte. Der Deutsche Ultraleichtflugverband e. V. - oder kurz DULV - wurde 1982 von ein paar Enthusiasten gegründet. Wegen der hohen ...

e-commerce magazin

e-commerce magazin

PFLICHTLEKTÜRE – Seit zwei Jahrzehnten begleitet das e-commerce magazin das sich ständig ändernde Geschäftsfeld des Online- handels. Um den Durchblick zu behalten, teilen hier renommierte ...

elektrobörse handel

elektrobörse handel

elektrobörse handel gibt einen facettenreichen Überblick über den Elektrogerätemarkt: Produktneuheiten und -trends, Branchennachrichten, Interviews, Messeberichte uvm.. In den monatlichen ...