Allgemein >> Technische Dokumentation und ihr Nutzen

Technische Dokumentation und ihr Nutzen

Technische Dokumentation ist der Oberbegriff für alle Dokumente, die über ein technisches Produkt informieren. Sie gliedert sich in interne und externe Dokumentation, die wiederum verschiedene Dokumenttypen und Anwendungsbereiche beinhalten.

Der Nutzen für Anwender eines Produkts ist klar: Informationsvermittlung. Dem Hersteller dient die Dokumentation aber auch zur Produktbeobachtung und vor allem zur haftungsrechtlichen Absicherung. Bei Maschinen ist eine Anwenderdokumentation sogar gesetzlich vorgeschrieben. Gibt es keine oder ist sie mangelhaft, zählt dies im Streitfall als Produktmangel und der Hersteller haftet.

Daher ist es wichtig, dass alle Inhalte eine passende Struktur erhalten und so aufbereitet werden, dass der Leser eine gesuchte Information leicht findet, versteht und in der Folge ohne Gefährdung handeln kann. Eine geeignete Technische Dokumentation erschließt sich im Prinzip aus sich selbst heraus und ermöglicht, dass der Nutzer eine eigene Handlungskompetenz entwickelt.

Dazu muss sichergestellt sein, dass nur relevante und sichere Informationen herausgegeben werden, die zur Zielgruppe passen. Daher wollen wir uns zunächst einmal die Unterscheidung zwischen interner und externer technischer Dokumentation genauer anschauen.

 

Interne Dokumentation

Die interne Technische Dokumentation beinhaltet alle für das Produkt relevanten Dokumente, die beim Hersteller archiviert werden, und deckt den gesamten Produktlebenszyklus ab. Neben der gesamten externen Technischen Dokumentation fallen auch alle weiteren, produktrelevanten Dokumente wie Konstruktionsunterlagen unter die interne Dokumentation.

Dokumente aus dieser Kategorie werden üblicherweise nicht an Anwender herausgegeben. Grund dafür sind einerseits Geschäftsgeheimnisse, aber auch Risikovermeidung und fehlende Relevanz. Wer eine Stichsäge erworben hat, will sich wahrscheinlich nicht mit deren Konstruktionsdetails und einer detaillierten Risikobeurteilung auseinandersetzen, sondern einfach nur wissen, wie sie anzuwenden ist.

Externe Dokumentation

Genau an diesem Punkt setzt die externe Technische Dokumentation an. Sie beinhaltet alle beschreibenden Dokumente zum Produkt, die sich an Interessenten, Benutzer, Servicepersonal usw. richten, die nicht zum Herstellerunternehmen gehören. Idealerweise gliedert sie sich in eine Produkt- und eine Anwenderdokumentation. Es gibt zwar auch Mischformen, diese sollten aber vermieden werden (Näheres dazu weiter unten im Text).

Produktdokumentation

Der Inhalt einer Produktdokumentation lässt sich schon am Namen erkennen: Sie beschreibt das Produkt. Diese Art der Dokumentation eignet sich für die Kaufphase. Der zukünftige Besitzer des Produkts muss nicht alle Handlungsabläufe für die Verwendung kennen. Stattdessen will er sich möglichst detailliert über das Produkt informieren, um z. B. die richtige Variante wählen zu können. Beispiele für Produktdokumentation sind Kataloge, Datenblätter usw.

Anwenderdokumentation

Analog zur Produktdokumentation wird in der Anwenderdokumentation der Anwender beschrieben. Nein, natürlich nicht. Die Anwenderdokumentation richtet sich stattdessen an den Anwender und informiert über den sicheren und bestimmungsgemäßen Gebrauch, die Wartung und die Entsorgung eines bereits erworbenen Produkts. Bespiele sind Wartungs-, Montage-. Installations- und Bedienungsanleitungen.

Es kann für bestimmte Zielgruppen wie Bediener oder Wartungspersonal separate Dokumente geben, damit sie nur jeweils relevante Informationen erhalten. Eine solche Trennung erleichtert nicht nur die Suche nach der gewünschten Information, sondern steigert auch die Sicherheit bei der Verwendung des Produkts. Denn wenn der Bediener das Produkt z. B. nicht selbst warten darf, erfährt er im besten Fall überhaupt nicht, wie die Wartung durchzuführen ist.

 

Problematische Mischformen und ihre Vermeidung

In der Praxis gibt es oft Mischformen aus Produkt- und Anwenderdokumentation. Der häufigste Fall ist eine Anwenderdokumentation, die übermäßig viele Informationen über das Produkt enthält.

Der Grund ist hauptsächlich, dass die Zielgruppe nicht ausreichend beachtet wird: Entweder der Autor schreibt sein gesamtes Wissen über das Produkt ungefiltert auf oder er weiß nicht genug über die Zielgruppe und erfasst daher zu viele Informationen, um auf der sicheren Seite zu sein.

Beide Ursachen lassen sich durch eine genaue Zielgruppen- und Zweckanalyse umgehen. Die Inhaltsauswahl kann sich dann eng an den Analyse-Ergebnissen orientieren. Denn nur wenn der Autor sich bewusst damit auseinandersetzt, für wen er schreibt und zu welchem Zweck der Leser die Dokumentation später nutzt, wird die Anwenderdokumentation wirklich effizient.

Daher ist es oftmals sinnvoll, Technische Dokumentation nicht von Produktverantwortlichen schreiben zu lassen. Stattdessen werden Experten an Bord geholt, die den nötigen Abstand zum Produkt haben, die Zielgruppe im Blick behalten und die vorhandenen Informationen entsprechend filtern. Falls Ihr Unternehmen hier Bedarf hat, steht die dictaJet Ingenieurgesellschaft mbH Ihnen gerne mit Rat und Tat zur Seite.