Home / HomepageTDWiki / Technische Dokumentation

Technische Dokumentation

Technische Dokumentationen sind alle Formen von Benutzerinformationen zu technischen Geräten, Maschinen, Anlagen oder Software.

Ein Unterscheidungsmerkmal von Technischen Dokumentationen ist das Medium, in dem sie erscheinen; man unterscheidet vor allem:
  • Printdokumentation wie z. B. Gebrauchsanleitungen, Betriebsanleitungen, Wartungshandbücher usw.,
  • elektronische Dokumentation wie z. B. Online-Hilfen (in Software eingebaut), Service-Websites, elektronische Ersatzteilkataloge auf CD-ROM oder im Internet, Schulungs-CD-ROMs usw.

Qualität Technischer Dokumentation

Technische Dokumentationen sollen bestimmten Qualitätsanforderungen genügen – sowohl aus Sicht der Nutzer als auch aus der Sicht der Hersteller.
  • Verfügbarkeit von Technischer Dokumentation (Availability): Technische Dokumentation soll zur richtigen Zeit zu angemessenen Kosten bereitgestellt werden. Technische Redakteure müssen deswegen den gesamten Erstellungsprozess planen.
  • Eignung der Technischer Dokumentation (Suitability): Technische Dokumentation soll mit den Zielen und Zwecken, für die sie gedacht ist, übereinstimmen. Technische Redakteure müssen dafür die Ziele und Zwecke vor der eigentlichen Erstellung analysieren und z. B. die Adressaten, für die die Technische Dokumentation gedacht ist, bestimmen (Zielgruppenanalyse).
  • Dokumentzugänglichkeit (Accessibility): Technische Doku-mentation soll für die Anwender lesefreudlich organisiert sein, so dass sie die Informationen finden, die sie aktuell benötigen.
  • Lesbarkeit  (Readability) / Verständlichkeit (Comprehensibility): Technische Dokumentation soll für die jeweiligen Adressaten flüssig, einfach zu lesen und zu verstehen sein. Professi-onelles Erstellen von Texten und Bildern und Editieren
  • Vollständigkeit: Bei den meisten Dokumentationen vom Typ Nachschlageanleitung muss eine Vollständigkeit der Information gewährleistet sein, bei Kurz- und Lernanleitungen nicht.
  • Richtigkeit sollte eigentlich eine Selbstverständlichkeit in al-len Dokumentationsformen sein.
  • Sicherheit der Anwender bei der Nutzung eines Produktes ist oberstes Ziel der einschlägigen gesetzlichen und normativen Bestimmungen zur Technischen Dokumentation, Sicherheitshinweise und Warnungen sind ein wichtiger Beitrag dazu.
Damit diese Qualitätsanforderungen erfüllt werden können, müssen in einer Technischen Redaktion Entscheidungen getroffen werden, die einerseits abgesichert sein müssen, andererseits über den tagesaktuellen Dokumentationsfall hinaus Gültigkeit haben sollten. Um die einmal getroffenen Entscheidungen festzuhalten, ist ein Redaktionsleitfaden das geeignete Instrument.
Wenn es einen Redaktionsleitfaden gibt, ist außerdem besser zu gewährleisten, dass alle, die an dem Erstellungsprozess beteiligt sind, interne wie externe Mitarbeiter, eine einheitliche „Linie“ in der Dokumentation einhalten können.


    		 RSS of this page