öffentlich
Redaktion Druckversion

Technische Dokumentation: Verständliche und juristisch einwandfreie Bedienungsanleitungen schreiben

Das Informationsmarketing

Wie bei der Produktion und dem Vertrieb von Gütern ...

... muss auch das Erstellen und Verbreiten von Technischer Dokumentation den unabdingbaren Gesetzmäßigkeiten in der Geschäftswelt folgen:

  • Bedarfsorientierung - Wer muss was wissen?

  • Wirtschaftlichkeit - Beim Aufwand unterscheiden, ob ein Reisewecker oder eine "Rolex" beschrieben wird

  • Sicherheit - Worin besteht beim unachtsamen Gebrauch dieses Gerätes oder dieser Computerapplikation das GAU (größtes anzunehmendes Unglück)?

  • Aufmachung - fast so wichtig wie der Inhalt, denn dieser wird vor allem gelesen, wenn er attraktiv verpackt ist.

Schaffen Sie emotionale Anreize!

Bild 2Nur ein kleiner Teil Ihrer "Leserschaft" ist wirklich begierig, Ihre technische Beschreibung zu lesen. Wecken Sie deshalb das Interesse; erklären Sie, warum es sich lohnt, die Dokumentation zu studieren, so im Sinn etwa von: "Was nützt mir dies?" Und denken Sie daran, eigene Vorteile interessieren den Leser mehr, als das Aufzählen von Leistungsdaten (Bild 2).

Sicher kennen Sie den Effekt aus eigener Erfahrung: Einen all zu simplen Text hält man für Zeitverschwendung, man beginnt zu überblättern und legt ihn bald einmal zur Seite. Eine hochgestochen anspruchsvolle Beschreibung ermüdet und frustriert, spätestens dann, wenn man ohne wiederholtes Zurückspringen den Faden verliert.

Versuchen Sie deshalb, die Information häppchenweise zu vermitteln, eventuell mit einer kleinen Rekapitulation oder Zusammenfassung nach einem längeren Abschnitt. Auf diese Weise vermitteln Sie Erfolgserlebnisse, im Sinn von "Aha, so funktioniert das!".

Und schließlich wollen Sie doch in jedem Fall dem Anwender, der Anwenderin, das Aufnehmen erleichtern. Dies bedeutet keinen großen Zusatzaufwand Ihrerseits. Es genügt, dass Sie kurze statt verschachtelte Sätze schreiben, vielleicht eine Entscheidungstabelle statt vieler "wenn ..." und "falls ..." einfügen. Vor allem aber sollten Sie visualisieren, doch darauf kommen wir noch zu sprechen.

Als Deutschsprachige bleibt uns zwar eine Entschuldigung ...

... herrscht doch im Deutschen die Unsitte, das Hauptwort unendlich weit vom Tätigkeitswort zu legen. Zur Veranschaulichung ein Beispiel aus der Praxis mit konventionellem Satzbau:

Beispiel: Sach(un)logischer Satzbau

"Dabei sind nicht nur die Wirkstoffe, sondern auch die Füllsubstanzen und bei den halbfesten Formen die Fettanteile im Herstellungsrapport unter der Rubrik "Zusammensetzung" zu notieren." (Originaltext)

Besser wäre ein sachlogischer Satzbau:

"Bitte notieren Sie im Herstellungsrapport unter der Rubrik "Zusammensetzung" sämtliche:

- Wirkstoffe

- Füllsubstanzen

- Fettanteile bei halbfesten Formen."

Als Mitglied können Sie diesen Beitrag weiterlesen!

Werden Sie Mitglied und testen Sie akademie.de 14 Tage lang kostenlos!

In den ersten 14 Tagen haben Sie Zugriff auf alle Inhalte auf akademie.de, außer Downloads. Sie können in dieser Zeit ohne Angabe von Gründen stornieren. Eine E-Mail an service@akademie.de genügt. Nur wenn Sie Mitglied bleiben, wird der Mitgliedsbeitrag nach Ende der 14tägigen Stornofrist abgebucht.

Ich bin bereits Mitglied
Jetzt Mitglied werden und akademie.de 14 Tage kostenlos testen
Ich entscheide mich für folgende Zahlungsweise:
14 Tage Stornorecht:
Ich kann meine Mitgliedschaft in den ersten 14 Tagen jederzeit formlos stornieren, z.B. per E-Mail an service@akademie.de.

Inhalt

Downloads zu diesem Beitrag

Über den Autor:

bild117234

René Brunner verfasst und illustriert Bedienungsanleitungen im IT- und Gerätebereich. Als freier Fachjournalist arbeitet er für verschiedene Fachzeitungen. Beruflicher Background: Maschineningenieur ...

Newsletter abonnieren