Was ist eigentlich Technische Dokumentation?

Ist Ihnen der Begriff Technische Dokumentation bekannt? Falls ja, dann haben Sie diesen bestimmt schon jemandem erklären wollen, nur um dann bei „Wo fange ich jetzt eigentlich an?“ oder „Das hat was mit Bedienungsanleitungen zu tun.“ stehenzubleiben.

Vielleicht kann man den Begriff am einfachsten durch einen typischen Entstehungsprozess erklären, also von den Gedanken zur Zielgruppe über die Nutzersituation bis zur Form der Dokumentation.

Von der Zielgruppe bis zur Dokumentation

Jeder Nutzer benötigt eine verständliche Erklärung, aber er verfügt über unterschiedliches Vorwissen, daher muss jede Person auch unterschiedliche neue Informationen erhalten. Ein Kunde, der sein neues Gerät in den Händen hält, weiß meist nicht so viel darüber. Ein Mitarbeiter, der eine Maschine schon seit Jahren bedient, ist dagegen Profi und kennt sie gefühlt bis ins Detail.

Nun wissen wir allerdings nicht unbedingt, welches Vorwissen vorhanden ist und welches noch vermittelt werden muss. Wie geht man nun also vor? Als Technischer Redakteur, erhalte ich dieses Wissen aus einer Zielgruppenanalyse, z. B. indem ich mir mittels der Persona-Methode typische Nutzende und auch deren Wissensstand entwickle. Dadurch weiß ich, welches Wissen die Nutzenden bereits haben und welches ich ihnen noch vermitteln muss.

Als nächstes muss die Situation bedacht werden, in der der Nutzer die Informationen erhält. Dadurch kann dann das Medium für die Informationen bestimmt werden. Dieser Schritt ist entscheidend dafür, wie hilfreich die Technische Dokumentation letztendlich ist. So wird es z. B. ein Servicetechniker sehr zu schätzen wissen, wenn er seine Informationen bei starkem Wind auf der Baustelle nicht aus einem Papier-Dokument beziehen muss. Das Druckerzeugnis hat zwar immer noch seinen Platz in der Technischen Dokumentation, doch gewinnen z. B. Videos und Apps für Smartphones, Augmented- und Virtual-Reality als Medium immer mehr an Bedeutung.

Nun ist das Was – die fehlende Information – und das Wo – das Medium – geklärt, es bleibt noch das Wie, also die Form der Information. Hier zeigt sich besonders die Vielfalt in der Technischen Dokumentation: Vom klassischen Beispiel der Betriebsanleitung über Schulungsunterlagen, Videos, Online-Hilfen, Projektdokumentationen bis zu Bauplänen erstreckt sich das Feld der Technischen Dokumente. Dabei wird jedes Produkt von der Konzeption bis zur Entsorgung von unterschiedlichen Technischen Dokumenten begleitet.

Rechtssicherheit ist die Pflicht, zufriedene Kunden und Mitarbeiter die Kür

Doch wozu das alles? Technische Dokumente erfüllen meist mehrere Funktionen. Eine der bekanntesten ist wohl die Rechtssicherheit, die einige leider immer noch als die einzige Funktion Technischer Dokumente ansehen. Aus der Sicht eines Technischen Redakteurs ist dies eine vertane Chance.

Ein gutes Technisches Dokument hat – neben der Rechtssicherheit – durch die Zugänglichkeit zu den Informationen durchaus einen Wert für die Nachwerbung eines Produktes. Dadurch kann z. B. eine Betriebsanleitung durch eindeutige und einfache Handlungsanweisungen die Kundenzufriedenheit und folglich die Kundenbindung positiv beeinflussen. Auch die eigenen Mitarbeiter wissen einen einfachen Zugang zu verständlichen Informationen zu schätzen.

Technische Dokumentation mit System

Beim Erstellen Technischer Dokumente können verschiedene Werkzeuge benutzt werden. Das einfachste wäre, ein Textverarbeitungsprogramm (z. B. Word) oder ein Desktop-Publishing-Programm (z. B. InDesign) zu verwenden. Doch finden inzwischen meist Redaktionssysteme Einsatz, durch die die Inhalte und das Layout des Technischen Dokuments getrennt werden können. So kann das Layout z. B. für eine Produktreihe einmal erstellt werden, um dann für weitere Produkte mit ihrem jeweiligen Inhalt wiederverwendet werden zu können.

Diese Redaktionssysteme können durch weitere Systeme erweitert werden, um spezielle Anforderungen zu erfüllen. So müssen z. B. technische Dokumente in so gut wie allen Fällen übersetzt werden, meist in mehrere Sprachen. Also müssen Technische Dokumente so erstellt werden, dass dies schnell und möglichst wenig fehleranfällig möglich ist. Dies wird umso wichtiger, weil das maschinelle Übersetzen immer breitere Anwendung findet.

Wenn nun jemand fragt…

Was also antwortet man nun auf die Frage „Was ist Technische Dokumentation?“, wenn man eine Kurzdefinition in Form eines Satzes haben möchte, die eigentlich jeder verstehen wird? Ein Vorschlag: „In der Technischen Dokumentation geht es darum, Informationen über Produkte und Software einfach und verständlich aufzubereiten, um diese dann an der passenden Stelle und in der passenden Art zur Verfügung zu stellen.“

Hat Ihnen dieser Beitrag geholfen, den Begriff Technische Dokumentation zu erklären oder zu verstehen? Oder haben Sie eine andere Definition oder weitere erwähnenswerte Punkte? Dann lassen Sie es uns in den Kommentaren wissen!