Was braucht eine gute Technische Dokumentation?

Pexels/ThisIsEngineering

Die Technische Dokumentation lässt sich unterteilen in die interne Technische Dokumentation und die externe Technische Dokumentation. Die interne Dokumentation betrifft vorrangig Beteiligte innerhalb eines Unternehmens. Doch auch für die Technische Redaktion spielt sie eine große Rolle. 

Interne Technische Dokumentation ist notwendig, um Unternehmenspflichten nachzukommen und rechtliche Anforderungen zu erfüllen. Sie begleitet ein Produkt entlang seines Lebenszyklus und umfasst beispielsweise Zeichnungen und Schaltpläne, Prüfberichte, Normen und Richtlinien sowie eine Risikobeurteilung.

Erlangt ein Produkt die Marktreife und wird in Verkehr gebracht, kommt die Frage nach der Externen Technischen Dokumentation ins Spiel. Entsprechend müssen Dokumente erstellt werden, die für die Kunden, Nutzer, den Vertrieb, die Instandhaltung und die Entsorgung relevant sind. Dabei ist es wichtig, dass sich die unterschiedlichen Dokumente nicht widersprechen, d. h. der Inhalt stets auf seine Richtigkeit hin geprüft wird.

Hier gibt es eine Verbindung zur internen Technischen Dokumentation. Denn den Grundstein für die externe Technische Dokumentation bilden interne Dokumente. Sie werden zurate gezogen, wenn es um die Ableitung von Nutzer- und Warnhinweisen geht oder als Input für Technische Daten für den Vertrieb. Aus diesen „Quelldaten“ leitet die Technische Redaktion nutzergerechte Informationsprodukte ab und entscheidet, welche Informationen für welche Zielgruppe relevant sind. Das Bedienpersonal benötigt womöglich andere oder weniger umfassende Informationen als das Wartungspersonal. Benutzerinformationen können sein:

• Produktbeschreibung
• Transporthinweise
• Bedienungsanleitung
• Betriebsanleitung
• Montageanleitung
• Wartungsanleitung

Ziel der externen Technischen Dokumentation ist es, dass die Benutzer und Benutzerinnen das Produkt gemäß seinem bestimmungsmäßigen Gebrauch verwenden. Den Grundstein für eine rechtskonforme und vollständige Dokumentation bildet also eine umfangreiche und gewissenhafte interne Dokumentation.