Zur Technischen Dokumentation gehören jene Dokumente, die Hersteller ihren Maschinen und Anlagen beifügen müssen. Ob es sich um Gebrauchsanweisungen, Konformitätserklärungen, oder um Montageanleitungen handelt, spielt keine große Rolle. Diese Dokumente können auf Papier gedruckt oder in digitaler Form vorliegen. Ziel ist, Produkte, deren Funktionen sowie die Handhabung verständlich zu erklären.
Wichtig bei der Technischen Dokumentation ist ihre sachgerechte Form. Daher wollten wir Ihnen einen Einblick in den Werkzeugkoffer Technischer Redakteure geben, die die Dokumentation Ihrer Maschinen und Anlagen erstellen. Wir beginnen unsere neue Reihe zu diesem Thema mit einigen grundlegenden Anforderungen an die Technische Dokumentation und an die Fähigkeiten der Redakteure.
Weniger ist meistens mehr
Es kommt während der Erstellung darauf an, Inhalte verständlich zu vermitteln – gerade, wenn die Vorgaben komplex sind. Eine Möglichkeit besteht in Step-by-Step-Anleitungen. Diese sind äußerst nutzerfreundlich, sie lassen sich aber nicht in jedem Bereich einsetzen. Je nach Anwendungsgebiet ist es erforderlich, Handbücher zusammenzustellen.
Zum Handwerkszeug Technischer Redakteure gehört die Fähigkeit, Vorgaben zusammenzufassen, ohne relevante Details außer Acht zu lassen. Beim Betrieb wie auch bei der Montage darf es keinesfalls zu Missverständnissen kommen. Klarstrukturierte Dokumentationen tragen nicht nur zur Kundenzufriedenheit bei, sondern auch zur Sicherheit.
Bei der Anfertigung greifen Normen und gesetzliche Bestimmungen Hand in Hand. Die Vorgaben sind komplex, den wichtigsten Baustein stellt die branchenübergreifende Richtlinie IEC/IEEE 82079-1 dar. Im Bereich Maschinen- und Anlagen ist speziell die Maschinenrichtlinie zu beachten.
Mit Marketing nichts am Hut
Schöngeschriebene Zeilen sind etwas für Websites oder den Marketingbereich. Im Rahmen der Technischen Dokumentation sind sie fehl am Platz. Es gilt, kurz und prägnant auf den Punkt zu kommen. Mit Floskeln und Füllsätzen gewinnt man keinen Blumentopf – ellenlange und verschachtelte Texte erschweren das Verständnis und sind damit ungeeignet. Sie schrecken Benutzer ab, sich die Dokumentation bis zum Ende durchzulesen. Zudem lenken sie vom Wesentlichen ab: dem Inhalt.
Dicke Minuspunkte gibt es für Verweise zu anderen Dokumenten und zu nachfolgenden Absätzen. Nutzer sind gezwungen, sich während des Lesens mit verwandten Themen zu befassen, wobei sie den gerade auszuführenden Schritt mitunter aus den Augen verlieren.
Worst Case über den Wolken
Angenommen: Bei einem Linienflug kommt es in 10.000 Metern Höhe zum Notfall. Die Piloten legen sich mächtig ins Zeug, um die Situation und Menschenleben zu retten. Das Handbuch, das aufführt, was in dieser Lage zu tun ist, liegt auf dem Schoß. Während das Flugzeug in bedrohliche Schieflage gerät, findet sich der passende Absatz: „Liebe Piloten, wir bedauern zutiefst, dass Sie in ernsten Schwierigkeiten stecken. Das Problem ist uns bekannt, jedoch ist die Vorgehensweise komplex. Rufen Sie bitte unsere Webseite auf. Dort erfahren Sie, welche Schritte den drohenden Absturz verhindern. Wir drücken Ihnen die Daumen!“
Technische Dokumentationen durch unsere ausgebildeten und erfahrenen technischen Redakeutere helfen dabei, Fälle wie diese zu vermeiden.
