Technische Dokumentation

Die Technische Dokumentation ist die Gesamtheit aller technischen Medien. Dabei ist zwischen interner und externer technischer Dokumentation zu unterscheiden. Die externe Technische Dokumentation erhält der Benutzer. Hierzu gehören Betriebsanleitungen, Bedienungsanleitungen, Wartungsanleitungen, Montageanleitungen, Schaltpläne, Stücklisten, Ersatzteillisten und Kataloge. Die interne Dokumentation besteht aus den Originaldokumenten der externen Dokumentation, Konstruktions- und Fertigungsunterlagen, Risikobeurteilungen, Pflichtenhefte, technische Zeichnungen, Berechnungen und Berichte. Die interne Dokumentation muss für eine vorgeschriebene Zeitspanne aufbewahrt werden.

Neben dem Nutzeffekt, welchen die Technische Dokumentation hat, gibt es auch eine Reihe von Vorschriften, die die Erstellung der technischen Dokumente fordern. Die Vorschriften können von Land zu Land verschieden sein und müssen entsprechend berücksichtigt werden, wenn ein Produkt in dem entsprechenden Land angeboten wird. Neben dem Hersteller kann auch der Importeur haftbar gemacht werden. Der Importeur muss deshalb sicherstellen, dass alle verlangten Dokumente in der vorgeschriebenen Form vorhanden sind.

Welche technischen Dokumente erstellt werden müssen, regeln die geltenden Normen und Richtlinien. Die Richtlinien sind zwingend einzuhalten. Normen sind eine Empfehlung, die im Schadensfall auch herangezogen werden. Welche Normen und Richtlinien für ein Produkt verwendet wurden, sind in Europa in der Konformitätserklärung gelistet. Ohne Konformitätserklärung darf ein technisches Produkt in der EU nicht verkauft werden. Nur für wenige Geräte gibt es Ausnahmeregelungen.

Die Technische Dokumentation muss verständlich strukturiert und unterteilt sein. Ein standardisierter strukturierter Aufbau erleichtert das Erstellen der Dokumente und das Lesen der Dokumente. Dokumente sind entweder produktbezogen gegliedert oder handlungsorientiert. Technische Dokumente vermitteln außer Sachverhalte auch Gefahren. Diese müssen besonders gekennzeichnet sein. Dies geschieht mit genormten Farben und Signalwörtern.

Technische Dokumente müssen verständlich sein. Je nach Verbreitung eines Produkts, ist das technische Dokument in die entsprechende Sprache zu übersetzen. Deshalb ist schon bei Erstellung in der Ausgangssprache die Übersetzbarkeit zu berücksichtigen. Eine Terminologieliste in mehreren Sprachen ist grundsätzlich hilfreich. Synonyme dürfen nicht verwendet werden. Sonst entstehen Irritationen. Schreiben mehrere Personen an einem Dokument, so müssen Sprachstil und Formatierungen vorher festgelegt sein. Der sogenannte Redaktionsleitfaden ist ein hilfreiches Instrument.

Konstruktions- und Fertigungsunterlagen, Pflichtenhefte und Risikobeurteilungen erstellen oft Entwicklungs- und Konstruktionsabteilungen. Der Technische Redakteur verwendet dann unter anderem diese Unterlagen für die Erstellung der Dokumente für den Benutzer.

Die Bedienungs- oder Gebrauchsanleitung beschreibt das Produkt und wie dieses zu verwenden ist. Für den Anwender ist die Bedienungsanleitung eine nützliche Informationsquelle. Produkte können sehr komplex sein und nicht selbsterklärend. Wenn der Anwender das Produkt nicht versteht, ist dieser unzufrieden oder kann sich oder dem Produkt schaden zufügen. Ein enttäuschter Anwender kauft keine neuen Produkte vom Hersteller und schickt das erworbene Produkt zurück.

Auf Grund geltender Richtlinien ist der Hersteller häufig verpflichtet, dem Produkt eine Bedienungsanleitung beizufügen. Fehlt die Bedienungsanleitung, ist der Hersteller im vollen Umfang haftbar. Aus diesem Grund ist eine den aktuellen Richtlinien und Normen gültige Bedienungsanleitung zwingend notwendig.

Für unterschiedliche Produktgruppen gibt es unterschiedliche Anforderungen an die Bedienungsanleitung. Nur wer sich daran hält, sitzt auf der sicheren Seite.

Bestimmte Produkte müssen über einen längeren Zeitraum gewartet werden, damit diese ordnungsgemäß funktionieren und keinen Schaden erleiden.

Einfache Wartungsarbeiten werden vom Eigentümer vorgenommen, umfangreiche Wartungsarbeiten werden von Fachpersonal durchgeführt. Nur wer weiß, wie ein Produkt zu warten ist, kann die nötigen Arbeiten ausführen. Eine korrekte Ausführung ist nur möglich, wenn alle Schritte entsprechend dokumentiert sind. So ist auch sichergestellt, dass keine Punkte bei der Wartung vergessen werden. Eine Einweisung alleine reicht oftmals nicht aus. Das Personal muss viele unterschiedliche Produkte warten und wenn einzelne Wartungsarbeiten mit größerem Abstand vorgenommen werden, ist die Gefahr sehr hoch, dass die Durchführung nicht ordnungsgemäß ist. Personen- oder Produktschäden sind dann die Folge. Eine vollständige Wartungsanleitung schafft Sicherheit.

Produkte gehen aufgrund von Verschleiß und falscher Handhabung kaputt. Billige Konsumerprodukte wandern auf den Müll, da eine Reparatur zu hohe Kosten im Vergleich zum Einkaufspreis verursacht. Für hochwertige und teure Produkte ist eine Reparatur lohnenswert.

Ein Produkt kann nur repariert werden, wenn die Werkstatt weiß, wie das möglich ist. Jedes Produkt ist unterschiedlich konstruiert und muss entsprechend unterschiedlich repariert werden. Teilweise ist auch spezielles Werkzeug nötig. Der Techniker kann die einzelnen Schritte nur fachgerecht ausführen, wenn dieser weiß, wie das Produkt zu reparieren ist und welches Werkzeug vorhanden sein muss. Unüberlegte Vorgehensweisen beschädigen das Gerät und bergen Verletzungsgefahr. Deswegen sollte für jedes hochwertige Produkt auch eine Reparaturanleitung erstellt werden.

Nicht jedes Produkt kommt beim Käufer zusammengebaut an. Je mehr Einzelteile zusammengefügt werden müssen, umso schwieriger wird die Montage. Kann der Käufer das Produkt nicht selber zusammenbauen, steigt die Unzufriedenheit.

Manche Produkte dürfen von vornherein nur von Fachkräften zusammengefügt werden, weil das Produkt zu komplex ist. Auch das Fachpersonal muss wissen, wie die Montage erfolgt. Ein falsch zusammengebautes Produkt wird beschädigt oder verletzt Personen. Eine genaue Montageanleitung minimiert die Gefahren.