EL01 | Modul 1 | Lektion 1 | Thema 1: Was ist Technische Dokumentation?

Starten wir mit der offensichtlichsten Frage: Was ist denn überhaupt Technische Dokumentation?

Technische Dokumentation ist wie ein intergalaktischer Sternenatlas; sie beschreibt, zeigt auf und gibt Navigationshilfe.

Definition:

Die Technische Dokumentation umfasst alle schriftlichen, grafischen und digitalen Informationen, die notwendig sind, um ein Produkt zu verstehen, zu verwenden, zu warten oder zu reparieren. Sie dient als Schnittstelle zwischen dem Produkt und dessen Nutzern bzw. Nutzerinnen.

Es handelt sich also immer um Informationsprodukte, die einen technischen Sachverhalt erklären.

Beispiele:

  • Bedienungsanleitungen (dein intergalaktisches Handbuch)
  • Installationshandbücher (wie man die Rakete zusammenbaut)
  • Wartungsanleitungen (damit der Hyperantrieb läuft)
  • Sicherheits- und Risikohinweise („Nicht ins schwarze Loch fallen!“)
  • Schulungsunterlagen (Training für neue Raumfahrer)

Diese Beispiele sind verschiedene Dokumentationstypen.

Sie sind aber alle Informationsprodukte.

Soweit so gut. Aber…

Was macht eine Technische Dokumentation zu einer guten Technischen Dokumentation?

Die Qualität einer Technischen Dokumentation hängt von verschiedenen Merkmalen ab.

Merkmale der Technischen Dokumentation:

  • Zweckorientierung: Sie unterstützt den Nutzer bzw. die Nutzerin bei spezifischen Aufgaben.
  • Zielgruppenfokus: Sie ist an die Bedürfnisse und das Wissen der jeweiligen Zielgruppe angepasst.
  • Strukturiertheit: Informationen sind klar gegliedert und leicht zugänglich.
  • Vollständigkeit: Sie deckt alle Informationsbedürfnisse ab, die bei der Verwendung des Produkts entstehen können.
  • Normenkonformität: Sie erfüllt rechtliche und branchenspezifische Standards (z. B. CE-Kennzeichnung).