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.
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.