Technische Dokumentation - Praktische Anleitungen und Beispiele

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.