Skip to main content

2015 | Buch

Technische Dokumentation

Praktische Anleitungen und Beispiele

verfasst von: Dietrich Juhl

Verlag: Springer Berlin Heidelberg

Buchreihe : VDI-Buch

insite
SUCHEN

Über dieses Buch

Das Buch ist mittlerweile zum Standardwerk der Technischen Dokumentation geworden. Die vom Autor aus der Praxis entwickelten Strukturen ermöglichen eine systematische Herangehensweise an die Erstellung von Technischer Dokumentation und führen schnell zu hochwertigen, anwendergerechten Anleitungen. Auch die 3. Auflage führt das bewährte Konzept weiter. Das Buch wurde komplett überarbeitet, mit neuen Erkenntnissen des Autors angereichert und mit den aktuellen Normen und Richtlinien abgeglichen. Fast alle Beispiele wurden modernisiert. Ein neues Kapitel systematisiert die Vorüberlegungen und Analysen. Das Kapitel „Sicherheit “ steht jetzt auf der obersten Ebene der Struktur.
Außerdem gibt der Autor einen Ausblick wie die Systematik für Online- und mobile Dokumentation angewendet werden kann.

Inhaltsverzeichnis

Frontmatter
1. Vorab-Überlegungen und -Untersuchungen
Zusammenfassung
Vor dem Konzept und dem Schreiben sollten systematische Überlegungen angestellt werden.
Dietrich Juhl
2. Das Konzept
Zusammenfassung
Für eine gute Anleitung sind fünf Inhalte notwendig. Wenn man diese unterscheidet, einzeln schreibt und einzeln optimiert erhält man fast schon eine vollständige Anleitung.
Dietrich Juhl
3. Sicherheit
Zusammenfassung
Sicherheits- und Warnhinweise müssen normgerecht erstellt und sinnvoll in eine verständliche Anleitung integriert werden.
Dietrich Juhl
4. Leistung
Zusammenfassung
Die Leistungsbeschreibung ist eine wichtige Positivaussage, die den Anwender in das Produkt und seinen Nutzen einführt und seine Erwartungen kanalisiert.
Dietrich Juhl
5. Gerät
Zusammenfassung
Die Beschreibung der Bedienelemente und die Erklärung von Aufbau und Funktion ermöglichen dem Anwender das Gerät kennen zu lernen.
Dietrich Juhl
6. Tätigkeiten
Zusammenfassung
Die Vemittlung von Handlungswissen ist der Kern jeder Anleitung. Neben der bekannten Schritt-für-Schritt-Darstellung gibt es noch sieben andere Möglichkeiten, die ein Technischer Redakteur kennen sollte.
Dietrich Juhl
7. Funktionsweise
Zusammenfassung
Die Funktionsweise wird von Technikern gerne als wichtigstes Element einer Anleitung angesehen. Sie ist aber nur in Ausnahmefällen sinnvoll.
Dietrich Juhl
8. Technische Unterlagen
Zusammenfassung
Technische Unterlagen ergänzen häufig eine Bedienungsanleitung.
Dietrich Juhl
9. Orientierungselemente
Zusammenfassung
Viele Elemente eines Buches (auch einer Anleitung) dienen dem Leser zur Orientierung. Diese Elemente können systematisch erstellt werden.
Dietrich Juhl
10. Verständniselemente
Zusammenfassung
Außer einem verständlichen Text kann man als Technischer Redakteur noch gezielt weitere Elemente einsetzen, wie z.B. ein Glossar. Auch hierfür gibt es Vorlagen und Strukturen.
Dietrich Juhl
11. Spezielle Inhalte
Zusammenfassung
In Anleitungen gibt es diverse „spezielle Inhalte“, wie z.B. der Lieferumfang oder die Fehlersuche, die für ihren Zweck optimiert werden können.
Dietrich Juhl
12. Komplette Anleitungen
Zusammenfassung
Betrachtet werden unterschiedliche Anleitungen, die sich aus den gezeigten Elementen zusammen bauen lassen.
Dietrich Juhl
13. Ausblick: Elektronische Dokumentation und Multimedia
Zusammenfassung
Die gezeigten Elemente und inhaltlichen Strukturen lassen sich auch auf Elektronische Dokumentation und Multimedia anwenden.
Dietrich Juhl
Backmatter
Metadaten
Titel
Technische Dokumentation
verfasst von
Dietrich Juhl
Copyright-Jahr
2015
Verlag
Springer Berlin Heidelberg
Electronic ISBN
978-3-662-46865-4
Print ISBN
978-3-662-46864-7
DOI
https://doi.org/10.1007/978-3-662-46865-4

Neuer Inhalt