Wir kennen sie alle: die frechen Dokumentationslümmel, die sich in unsere Technische Dokumentation einschleichen wollen. Angefangen bei der falschen Sprache, über unzureichende Inhalte bis zum fehlenden Dokument kann alles dabei sein. Doch wie können wir solche fehlerhafte Technische Dokumentation erkennen oder vielleicht sogar im Vorfeld vermeiden?
Sowohl die Konstruktion als auch die Technische Redaktion benötigen für die Erstellung von interner und externer Dokumentation wie Risikobeurteilung und Betriebsanleitungen geeignete Fremddokumentation in Form von Konformitätserklärungen, Anleitungen und technischen Daten. Diese Schriftstücke müssen je nach Arbeitsschritt geprüft, abgelegt oder weiterverarbeitet werden. Sobald dies nicht möglich ist, haben wir es mit einem Dokumentationslümmel zu tun: Die fiesen Dokumente sind unbrauchbar, fehlerhaft oder unauffindbar. Was sich zunächst wie ein lustiger Streich kleiner niedlicher Blätterhaufen anhört, ist in der Realität nervig, teuer und kann am Ende sogar gefährlich werden.
Die Probleme von fehlenden oder fehlerhaften Dokumenten für die Technische Dokumentation
Eine unvollständige Maschine wird verbaut, ein Gesamt-CE-Kennzeichen soll vergeben werden. Doch die Einbauerklärung ist nicht geliefert und die Montageanleitung liegt in der falschen Sprache vor. Was wahrscheinlich keinen Unterschied macht, denn auf den ersten Blick schauen die drei gelieferten Seiten für die Technische Redakteurin unbrauchbar aus, – egal, in welcher Sprache. Ein dickes CE-Kennzeichen prangt trotzdem auf dem Produkt. Warum? Weiß keiner – kann auch keiner nachvollziehen, weil ja die Einbauerklärung mit den aufgeführten Richtlinien und Normen fehlt. Zum Mäusemelken, wenn die richtigen Dokumente zunächst mühsam eingefordert werden müssen. Noch ärgerlicher, wenn die endlich gelieferten Dokumente dann eintreffen und trotzdem nicht verwertbar sind.
Die Notwendigkeit der korrekten Zulieferdokumentation
Für die Konstruktion ist es relevant, ein sicheres Produkt zu entwerfen. Zu diesem Zwecke wird eine Risikobeurteilung erstellt. Erst wenn alle Risiken minimiert und alle Anforderungen der Richtlinien und Normen erfüllt werden, darf der Hersteller (falls von der Richtlinie gefordert) sein CE-Kennzeichen auf dem Produkt anbringen. Da ist es hilfreich, wenn auch die verbauten Komponenten den Richtlinien und Normen entsprechen. Denn dadurch wird dem Ersteller der Risikobeurteilung ein Stück Arbeit abgenommen. Er muss zum Beispiel nicht prüfen, welcher Laserklasse der verbaute Laser entspricht, wenn er diese Informationen aus der mitgelieferten Dokumentation entnehmen kann. Auch die Technische Redaktion muss sich für die Erstellung von Anleitungen auf die gelieferte Zulieferdokumentation verlassen können. Denn im Zweifel weiß der Laserhersteller am besten, in welchen Intervallen die produktgerechte Wartung durchgeführt werden muss – und die Redaktion übernimmt diese Angaben in die Betriebsanleitung der Gesamtmaschine. Zulieferdokumentation jeglicher Art ist für die Erstellung von Produkten relevant und kann für das Gelingen des Projekts ein wichtiger Faktor sein.
Technische Dokumentation: Dokumentationslümmel erkennen und vermeiden
Um die erwähnten Dokumentationslümmel zu erkennen, gibt es zahlreiche Ansätze. Ein Ansatz wäre das Einbinden der Einkaufsabteilung oder einer Hilfskraft. Sie kann die Dokumente ohne umfangreiche Vorkenntnisse anhand von Checklisten prüfen:
-
Sind alle geforderten Dokumente vorhanden?
-
Sind alle Dokumente in der geforderten Sprache geliefert?
-
Sind alle Dokumente im geforderten Format geliefert?
-
Passen die Dokumente zum gelieferten Produkt (hier hilft oft ein Abgleich mit vorhandenen Zeichnungen z. B. in der Anleitung und dem Produkt vor Ort)?
-
Sind die vereinbarten Lieferdaten eingehalten worden?
Nach der ersten Vorabprüfung sollten Profis der Technischen Redaktion einige weitere Eckpunkte prüfen. Für eine Betriebsanleitung können diese sein:
-
Sind alle relevanten Lebensphasen enthalten?
-
Wurde die Bestimmungsgemäße Verwendung beschrieben?
-
Sind Warn- und Sicherheitshinweise (in einem dem Produkt entsprechenden Maße) vorhanden?
-
Finden sich Handlungsaufforderungen in der Anleitung?
Je nach Produktart können auch weitere Prüfpunkte für die Konstruktion definiert werden. Für eingekaufte Maschinen z. B. sollten neben der Betriebsanleitung ein CE-Kennzeichen, ein Typenschild und eine Konformitätserklärung vorhanden sein. Fehlen wichtige Punkte, möchten sich Dokumentationslümmel ins Unternehmen schleichen. Dann sind eine genauere Prüfung und das Gespräch mit dem Zulieferer notwendig. Noch wichtiger an dieser Stelle ist, bereits zu Beginn des Kaufes auf ordentlich ausgearbeitete Verträge sowie vernünftige Lasten- und Pflichtenhefte zu achten. Dann kommen keine Streitfragen auf.
Keine Besserung bei der Erstellung der Technischen Dokumentation?
Sollten sich mit bestimmten Zulieferern die Probleme wiederholen oder häufen, wäre ein Wechsel im Zweifel die bessere Wahl. Denn während der Zulieferer vielleicht das günstigste Produkt anbietet, müssen Konstruktion und Technische Redaktion am Ende erhebliche Mehrarbeit leisten. Und ob sich das rechnet, ist in der Regel eine Milchmädchenrechnung.
