Technische Dokumentation

Frontmatter

Einleitung

Zusammenfassung

Ich bin fest davon überzeugt, dass es möglich ist, gute Bedienungsanleitungen zu schreiben! In 22 Jahren Berufserfahrung habe ich viele (hoffentlich gute) Anleitungen geschrieben und meine Methoden weiterentwickelt.

Dietrich Juhl

Hinweise zu diesem Buch

Zusammenfassung

Dieses Buch richtet sich an alle, die professionelle Technische Dokumentation schreiben wollen. Sowohl Berufsanfänger als auch gestandene Technische Redakteure und auch sogenannte „nebenbei schreibende Techniker“ finden hier Grundlagen für das verständliche Schreiben von Anleitungen.

Dietrich Juhl

Handlungsorientierung

Zusammenfassung

Drei Meinungen zur Technischen Dokumentation

Dietrich Juhl

Das Konzept

Zusammenfassung

Im Folgenden möchte ich Ihnen ein Konzept vorstellen, das Ihnen schnell hilft, gute Anleitungen in kurzer Zeit zu erstellen.

Dietrich Juhl

Leistungsbeschreibung

Zusammenfassung

Die Leistungsbeschreibung erklärt dem Benutzer, welche Art von Gerät er vor sich hat und was er mit dem Gerät tun kann. Dadurch erhält er einen ersten Eindruck und kann seine Erwartungen an das Gerät präzisieren.

Dietrich Juhl

Gerätebeschreibung

Zusammenfassung

Die Gerätebeschreibung stellt dem Benutzer das Gerät bildlich vor und erläutert die benutzerrelevanten Teile.

Dietrich Juhl

Tätigkeitsbeschreibung

Zusammenfassung

Die Tätigkeitsbeschreibung ist der Kern jeder Anleitung. Hier erfährt der Benutzer, welche Tätigkeiten er ausführen muss oder ausführen kann, und wie er vorgehen soll.

Dietrich Juhl

Beschreibung der Funktionsweise

Zusammenfassung

Die Funktionsweise erklärt, nach welchen Prinzipien das Gerät arbeitet.

Dietrich Juhl

Technische Unterlagen

Zusammenfassung

Technische Unterlagen sind Unterlagen, die im Laufe der Konstruktion entstehen und diese festschreiben. Dazu gehören auch Unterlagen, die aus technischer Sicht für Servicezwecke hergestellt werden.

Dietrich Juhl

Ordnungselemente

Zusammenfassung

Ordnungselemente dienen dem Benutzer dazu, die Reihenfolge in der Bedienungsanleitung zu verstehen und gewünschte Informationen schnell zu finden.

Dietrich Juhl

Verständniselemente

Zusammenfassung

Der Benutzer kann beim Verstehen der Anleitung unterstützt werden.

Dietrich Juhl

Spezielle Inhalte

Zusammenfassung

Außer den bisher beschriebenen Inhalten müssen, je nach Gerät und Anleitung, spezielle Inhalte aufgenommen werden.

Dietrich Juhl

Komplette Anleitungen

Zusammenfassung

Je nach Gerät, Zielgruppe und Aufgabe der Anleitung gibt es viele verschiedene Anleitungen,

Dietrich Juhl

Backmatter