Überspringen zu Hauptinhalt

Technische Dokumentation – Worauf sollte man beim Erstellen der Technischen Dokumentation im Bereich Text achten?

Um eine Technische Dokumentation zielgruppengerecht aufzubereiten, gilt es auch im Bereich der textlichen Gestaltung einiges zu beachten. So sollte der Satzaufbau der Betriebsanleitung einfach gehalten sein. Handlungen beschreibt man in kurzen und verständlichen Sätzen. Der Schreibstil der Betriebsanleitung sollte von der Verständlichkeit auf die jeweilige Benutzergruppe der Betriebsanleitung angepasst sein.

Die gewählten Schriftarten, Schriftgrößen und Abstände in der Betriebsanleitung sollen eine optimale Lesbarkeit der Anleitung garantieren. Die Technische Dokumentation soll bei einem regulären Leseabstand gut zu lesen sein, damit alle darin vorkommenden Informationen einfach aufzunehmen sind. Auch sollten wenige Fachbegriffe zum Einsatz kommen. Wenn nicht anders möglich, dann gilt es die vorkommenden Fachbegriffe in einem Glossar zu erläutern und ebenfalls kein unbekanntes Fachjargon ohne Erläuterung in der Betriebsanleitung zu verwenden. Am besten pflegt man eine Terminologiedatenbank, um die Vielzahl unterschiedlicher Benennungen von Fachbegriffen zu vereinheitlichen.

An den Anfang scrollen