Vom Stiefkind zum Musterknaben

Text: Manuel Schneider

In der internen Dokumentation sammeln sich alle Unterlagen, die eine Technische Redaktion für ihre Informationsprodukte benötigt. Abgelegt an zentraler Stelle, strukturiert und leicht zugänglich profitieren auch andere Abteilungen von diesem Wissen – so weit die Idee. Die Praxis sieht bislang anders aus.

Inhaltsübersicht

Lesedauer: 10:35 Minuten

Ein Unternehmer hatte mehrere Maschinen für seine Fertigung erworben. Er beschloss, dass die Maschinen die eine oder andere Optimierung vertragen könnten, und ließ sie dafür umbauen. Eines Tages tauchte die Berufsgenossenschaft auf und verlangte, Dokumente über die sicherheitskonforme Durchführung der Umbaumaßnahmen einzusehen. „Wieso das denn?“, wunderte sich der Unternehmer, „diese Maschinen verkaufe ich doch gar nicht?“ Das war die falsche Antwort, und der Mann konnte eine sofortige Betriebsschließung nur dadurch verhindern, dass er der Berufsgenossenschaft verzweifelt versprach, die notwendigen Unterlagen unverzüglich erstellen zu lassen. 

Was war passiert? Der Mann war einem häufigen Trugschluss aufgesessen, der da lautet: Eine „Dokumentation“ ist eine „Betriebsanleitung“. Und Punkt. Die Moral von der Geschichte: Eine Betriebsanleitung ist nur ein kleiner Bestandteil der Dokumentation. Wenn diese fehlt, dann kann guter Rat sehr teuer werden.

Wir Technischen Redakteure kennen das nur zu gut; sobald wir versuchen unseren Beruf zu beschreiben, landen wir über kurz oder lang bei diesem Bild: „Wir schreiben … nun ja … Bedienungsanleitungen.“ Das funktioniert immer, das versteht jeder. Dabei ist die Anleitung nur die Spitze des Eisberges. Der Berg selbst besteht aus der so genannten internen Dokumentation.

Nun kann man der Öffentlichkeit ein mangelndes Problembewusstsein kaum vorwerfen, wohl aber denjenigen Unternehmern, für die Technische Dokumentation „nur“ aus einer Betriebsanleitung besteht, also einem externen Informationsprodukt, und deren Erstellung im schlimmsten Fall als lästiger Posten wahrgenommen wird. Dass die interne Dokumentation sich auch auf Arbeitsmittel erstreckt und zudem der eigenen rechtlichen Absicherung dienen kann, war dem Unternehmer aus unserem Beispiel nicht bekannt.

Argumente für interne Dokumentation

Manche Chefs sind beim Thema interne Dokumentation, vorsichtig ausgedrückt, beratungsresistent. Dabei muss diese auf Anfrage vorgelegt werden, beispielsweise der Berufsgenossenschaft. Zudem bildet sie die Grundlage für die externe Technische Dokumentation; mehr dazu in den nächsten Absätzen.

Kurz gesagt, die interne Dokumentation belegt, dass die Maschine allen Gesetzen, Richtlinien und Normen entspricht, Stichwort Produktsicherheitsgesetz. Fehlt die Technische Dokumentation oder ist sie fehlerhaft und es kommt beispielsweise zu einem Arbeitsunfall, dann reiben sich die Anwälte schon die Hände. Denn dann wird es teuer und kann, im schlimmsten Fall, die Betriebsschließung nach sich ziehen. Ebenso, wenn die Unterlagen nicht lückenlos bei einer Prüfung durch die Berufsgenossenschaft vorgelegt werden können.

Abgrenzung externe Dokumentation

In der Technischen Dokumentation wird zwischen interner und externer Dokumentation unterschieden, dies legt die Richtlinie VDI 4500 fest.

Die interne Dokumentation umfasst alle relevanten Informationen zu einem Produkt: vom ersten Entwurf über Entwicklung, Vertrieb, Nutzung bis zur Entsorgung. Die interne Dokumentation ist wie ein ausführlicher Lebenslauf, in dem alle wichtigen Produktlebensphasen festgehalten sind.

Sobald ein Produkt das Haus verlässt, wird es von speziell erstellten Unterlagen begleitet, um die Lieferanten und die Kunden umfassend zu informieren. Ab hier sprechen wir von der externen Dokumentation (Abb. 01). Diese speist sich zwar aus der vorhandenen internen Dokumentation. Sie enthält allerdings nur die Informationen, die für den Kunden oder Lieferanten von Nutzen beziehungsweise relevant sind, damit das Produkt sicher und qualitätsgerecht ausgeliefert wird und vom Kunden sicher und komfortabel benutzt oder bedient werden kann. Dazu gehören neben der Bedienungsanleitung auch Montageanleitungen und Sicherheitsdatenblätter.

Darstellung eines Eisbergs zeigt Verhältnis von interner und externer Dokumentation.
Abb. 01 Bestandteile der externen und internen Dokumentation. Quelle Manuel Schneider

Bestandteile interner Dokumentation

Bevor ein Produkt das Licht der (Produkt-)Welt erblickt, bedarf es einer umfangreichen Datensammlung. Erst wenn alle Fakten und Eventualitäten zusammengetragen worden sind, kann an die reelle Umsetzung und Ausgestaltung des Produktes gedacht werden. Im Maschinenbau zum Beispiel beginnt der Lebenslauf einer jeden Maschine mit einem Auftrag. Oft werden die Kundenwünsche und Anforderungen an das Produkt in Pflichtenheften festgehalten, dazu gesellen sich weitere rechtliche Vorgaben zu den Themen Gesundheits-, Arbeits- und Umweltschutz. Um diese Vorgaben ordnungsgemäß umzusetzen, müssen Risikobeurteilungen erstellt, Versuche und Testreihen gefahren und protokolliert sowie Berechnungen angestellt und hinterlegt werden.

Wenn Arbeitsschritte ausgelagert und Material eingekauft werden muss, ergeben sich daraus weitere Vorgaben, die etwa in den Lieferantenunterlagen enthalten sind und somit in die hausinterne Dokumentation mit einfließen. Zu den weiteren externen Dokumenten von Zulieferern zählen auch Zertifikate, Prüfzeugnisse, Mess- und Testergebnisse, außerdem Qualitätssicherungsmaßnahmen, wie sie etwa bei Fertigungsprozessen anfallen können.

Für interne Einweisungen müssen zudem Schulungsunterlagen erstellt werden, die angepasst an Kundenschulungen verwendet werden können. Hierfür werden Informationen zum bestimmungsgemäßen Gebrauch, zur sicheren Bedienung, Instandhaltung und Verhalten im Störungsfall wie auch zur fachgerechten Entsorgung benötigt. All diese Informationen bilden die Grundlage für Betriebsanleitungen und Handbücher, die der externen Dokumentation zugerechnet werden. Allerdings sind sie als Informationsmaterialien, die zum Produkt gehören, ebenso Bestandteil der internen Dokumentation. Als solche müssen sie archiviert und auf Anfrage vorgelegt werden.

Wurde das Produkt in den Verkehr gebracht, ist der Hersteller verpflichtet, sein Produkt auf dem Markt zu beobachten. Insbesondere für Medizinprodukte gelten sehr hohe Anforderungen. Der Hersteller muss den Markt nicht nur beobachten, sondern aktiv und systematisch Informationen zur Verwendung seines Produkts sammeln, um dann bei Bedarf Korrekturmaßnahmen einzuleiten. Die Technische Dokumentation muss also auch nach der Markteinführung immer auf dem neuesten Stand gehalten werden. So können für ein Produkt in einem Unternehmen schnell die folgenden internen Dokumente zusammenkommen (Abb. 02):

  • Pflichtenheft
  • Risikobeurteilung
  • Technische Zeichnungen
  • Fertigungspläne
  • Material- und Stücklisten
  • Schalt-, Pneumatik- und Hydraulik­pläne
  • Steuerungspläne
  • Montage- und Installationspläne
  • Testergebnisse und Versuchsprotokolle
  • Daten zu Qualitätssicherungs­maßnahmen
  • Zertifikate und Prüfberichte
  • Zertifizierungsdokumentation zu CE-Kennzeichnung und GS-Zeichen
  • Übersicht über die angewandten Normen und Richtlinien
  • Externe Dokumentation von Zulieferern (zum Beispiel Lagerung und Umgang mit Materialien)
  • Schulungsunterlagen
  • Betriebsanleitungen und Handbücher
  • Dokumentation zu Marktbeobachtung und ggf. Korrekturmaßnahmen

Auf den ersten Blick enorm viele Dokumente, die erstellt, bearbeitet, archiviert und dazu noch auf dem aktuellen Stand gehalten werden müssen.

Schaubild über die Aufgaben von interner und externen Dokumentation.
Abb. 02 Im Vergleich zur externen Dokumentation umfasst die interne Dokumentation deutlich mehr Aufgaben, als es zunächst scheint. Quelle Manuel Schneider

Die Fachleute dahinter

In großen Firmen wird die interne Dokumentation in eigenen Abteilungen bearbeitet und aktualisiert. Hier werden die Unterlagen aus den verschiedenen Fachabteilungen (Entwicklung, Produktion, Einkauf, Vertrieb, Marketing) gesammelt und verwaltet. Diese Dokumente werden ausgewertet und für die Erarbeitung der externen Dokumentation verwendet. Will man qualitativ hochwertige Informationsprodukte mit einer hohen Rechtssicherheit erzeugen, ist der Einsatz von speziell ausgebildeten Fachkräften, den Technischen Redakteurinnen und Redakteuren, sinnvoll und üblich.

In kleineren Firmen bleibt die Erstellung der Technischen Dokumentation oft an den Mitarbeitern der Fachabteilungen „hängen“, die diese Aufgabe neben ihren eigentlichen Tätigkeiten ausführen sollen. Die fehlende fachliche Qualifikation führt leider dazu, dass wichtige, vor allem rechtliche Aspekte übersehen werden. Um solche Wissenslücken und eine naturgemäße Betriebsblindheit zu vermeiden, kann ein externer Dienstleister mit der Erstellung der Technischen Dokumentation beauftragt werden.

In Wikipedia steht übrigens unter dem Schlagwort „Technische Dokumentation – Erstellung Technischer Dokumentation“: Speziell die Erstellung externer Dokumentationen erfordert besondere Fachkenntnisse und Qualifikationen. Mit dieser Aufgabe werden Technische Redakteure betraut, die häufig in speziellen Fachabteilungen – Technischen Redaktionen – sowohl für die redaktionelle Bearbeitung von Benutzerinformationen als auch für die Koordination des abteilungsübergreifenden Dokumentationsprozesses verantwortlich sind. So weit der Auszug aus Wikipedia.

Das sind die Vorteile

In allen Dingen hängt der Erfolg von den Vorbereitungen ab – ein Zitat, das dem allwissenden Konfuzius zugeschrieben wird. Übertragen auf unser Thema würde er wohl sagen: Der beste Weg zu einer guten externen Dokumentation führt über eine gute interne Dokumentation. Da beide Dokumentationsarten vom Gesetzgeber gefordert werden, sollte jeder Hersteller sein Augenmerk zunächst auf eine vollständige und detaillierte interne Dokumentation richten.

Denn sind erst einmal alle Informationen zu einer fachgerechten und sicheren Nutzung des Produkts, zu Wartung, Reparatur und nicht zuletzt Entsorgung ausführlich erarbeitet und akribisch zusammengetragen, so bilden sie die notwendige Basis, um ein vollständiges und rechtssicheres externes Informationsprodukt erstellen zu können, das den Endabnehmer – und den Gesetzgeber – vollauf zufriedenstellt.

Gleichzeitig kann eine gut strukturierte interne Dokumentation wichtige Prozesse im Unternehmen sinnvoll unterstützen. Dazu gehören etwa die rechtssichere Ausgestaltung von Verträgen, die Rückverfolgung von Bestellungen und verwendeten Materialien, der Nachweis über die Einhaltung gesetzlicher Vorgaben, die Möglichkeit, ausgearbeitete Entwicklungsstrategien auf andere Produkte zu übertragen, die erneute Nutzung von Erkenntnissen aus den Prozessen rund um Fertigung und Produktion, die schnelle Weitergabe von wichtigen Informationen an alle involvierten Abteilungen und dadurch eine unschätzbare Verkürzung von Wegen und ein erheblicher Zeitgewinn. Dadurch lässt sich die Effektivität von Abläufen erheblich erhöhen. Weiterhin hat ein Unternehmen einen dokumentierten Beleg über erfolgte Maßnahmen zur Qualitätssicherung.

Mängel und ihre Konsequenzen

Zeit ist bekanntlich Geld. Und wie viel Geld könnte eingespart werden, wenn nur ausreichend Zeit in die Erstellung einer guten internen Dokumentation investiert würde. Wichtige Informationen stünden allen Abteilungen zur Verfügung und müssten nicht aufwändig recherchiert oder besorgt oder, im schlimmsten Fall, von Neuem erstellt werden. Wie viel Zeit könnte eingespart werden, wenn jeder Mitarbeiter Zugriff auf das vorhandene Firmen-Know-how hätte und sich wichtige Fakten nicht mühsam zusammensuchen müsste. Die abteilungsübergreifende Kommunikation könnte sich um ein Vielfaches schneller gestalten, Arbeitsabläufe wären effektiver und Wissenslücken schlicht nicht mehr vorhanden.

Unwissenheit schützt vor Strafe nicht. Vielen Unternehmen ist nicht bewusst, dass die rechtlichen Konsequenzen, die sich aus einer lückenhaften internen Dokumentation ergeben, erheblich sein können. Wenn wie im eingangs genannten Beispiel die Erfüllung gesetzlicher Vorschriften nicht nachgewiesen werden kann, können nach dem Produktsicherheitsgesetz Bußgelder bis zu 100.000 Euro drohen; wird grobe Fahrlässigkeit oder gar Vorsatz unterstellt, sind die Geschäftsführung oder der Vorstand potenziell persönlich haftbar, möglicherweise mit einer strafrechtlichen Verfolgung.

Das Produkthaftungsgesetz kommt ins Spiel, wenn Fehler an einem Produkt nachgewiesen werden, die Sachschaden oder Personenschaden beim Endabnehmer verursacht haben. Schadensersatz wird zum Beispiel auch dann fällig, wenn in der Betriebsanleitung wichtige Informationen fehlen.

Weitere wichtige Rechtsgrundlagen sind EU-Richtlinien, etwa für Maschinen, Niederspannungsanlagen oder Anlagen mit explosionsgefährlicher Atmosphäre, und Normen, die den Stand der Technik abbilden. So gelten für die Erstellung Technischer Dokumentationen die DIN EN IEC/IEEE 82079-1, DIN EN ISO 20607 und die VDI 4500.

Die richtige Organisation

Die interne Dokumentation sollte gut strukturiert sein und sinnvoll abgelegt werden. Jede Änderung erfolgt idealerweise an zentraler Stelle, wird dokumentiert und ggf. einem festgelegten Verteiler mitgeteilt. Eine digitale Ablage gewährleistet den ortsunabhängigen Zugriff und spart zudem Papier. Die Dokumentation sollte so lange im Unternehmen aufbewahrt werden, wie das Produkt im Regelfall genutzt wird, mindestens aber zehn Jahre. Auf Anfrage muss der Hersteller die Unterlagen jederzeit vorlegen können.

Idealer Ablauf von Änderungen

Ein Konstrukteur erstellt eine neue Zeichnung, in der Änderungen eingezeichnet sind. Er leitet diese Information an die zuständige Stelle weiter und bittet um Freigabe. Sobald die Freigabe, etwa vom Projektleiter, erfolgt ist, wird die für die Technische Dokumentation verantwortliche Abteilung oder Person informiert. Die Änderung am Dokument wird durchgeführt und dokumentiert, zum Beispiel als Änderungsvermerk am Anfang des Dokuments oder in einer separaten Änderungsliste. Das geänderte Dokument wird idealerweise mit einem Schreibschutz versehen und an zentraler Stelle im System abgelegt, dann werden die am Produktprozess beteiligten Personen über einen festen Verteiler über die Änderung informiert.

Wenn ein externer Dienstleister für die Erstellung der Technischen Dokumentation beauftragt wird, ist es ein Vorteil, eine Ansprechpartnerin oder einen Ansprechpartner im Unternehmen zu definieren. Von dieser Person werden dann die Informationen und/oder Änderungswünsche gebündelt und koordiniert. Extrem wichtig ist, dass diese Person Entscheidungen treffen darf, damit es kein Kompetenzgerangel gibt.

Denn erfahrungsgemäß haben Informatiker einen anderen Blick auf ein technisches Dokument als Konstrukteure oder Elektriker. An dieser Stelle soll nicht ausgeschlossen werden, dass die unterschiedlichen Blickwinkel auch zu einem guten, konstruktiven Ergebnis führen können. Normalerweise ist aber meist das komplette Gegenteil der Fall.

Folgen schlechter Dokumentation

Ein unzureichendes Management der internen Dokumentation kann dazu führen, dass die Risikobeurteilung plötzlich nicht mehr passt. Beispiel: Plötzlich taucht eine Überbrückung einer Sicherheitseinrichtung auf, die auf Wunsch eines Kunden hinzukonstruiert wurde. Diese erscheint aber nirgendwo in der Risikobeurteilung. Das fällt in der Regel erst dann auf, wenn die Unterlagen in der Technischen Redaktion liegen oder – im schlimmsten Fall – wenn etwas passiert.

Ein weiteres gutes Beispiel, warum eine Technische Redaktion wichtig ist, sind Normen. Denn diese ändern sich, zumindest gefühlt, ständig. Im Maschinenbau gibt es die Maschinenrichtlinie 2006/42/EG, die ein einheitliches Schutzniveau für Maschinen bestimmt. Die Risikobeurteilung ist übrigens ein Bestandteil der Maschinenrichtlinie.

Diese Richtlinie bringt eine lange Liste von harmonisierten Normen mit, die kontinuierlich von der EU aktualisiert werden. Über diese Aktualisierungen einen Überblick zu behalten, ist für einen Laien schwierig bis unmöglich. In der Technischen Redaktion arbeiten hingegen Profis, die sich mit Normen leichter tun.

Natürlich ist man nicht dazu verpflichtet, Normen auch anzuwenden. Aber entsprechend der Beweislastumkehr ist es sinnvoll, die vorgegebenen Normen umzusetzen. Sollte es nämlich doch zum Schadensfall kommen, muss der Hersteller nachweisen, dass sein nicht normgerechtes Vorgehen die Maschine sicher gemacht hat. Sind dagegen alle Normen umgesetzt worden, liegt die Beweispflicht bei der Staatsanwaltschaft.

So könnte es weitergehen

Die Zukunft wird digitaler. Machine Learning, KI und Industrie 4.0 werden längst umgesetzt. Auch das Internet of Things ist keine Science-Fiction mehr. Wird die Technische Redaktion überhaupt noch gebraucht? Die kurze Antwort: Ja. Wir sind auch in der Zukunft auf Menschen angewiesen, die technisches Wissen konzipieren und erstellen – und das aus gutem Grund. Trotzdem werden die Digitalisierung und das Machine Learning nicht spurlos an der Technischen Redaktion vorübergehen. Es ist durchaus möglich, dass Standardaufgaben zukünftig von Maschinen übernommen werden. Denn gerade was diesen Bereich betrifft, sind sie einfach effizienter. Etwas anders sieht es aus, wenn es um individuelle Lösungen geht.

Wir werden auch weiterhin mit Situationen konfrontiert sein, in denen es keine Lösung von der Stange gibt und in denen eine kreative Problemlösung gefragt ist. Maschinen können das nicht leisten. Mögen sie auch noch so intelligent sein.

Ein weiterer Punkt ist die digitale Transformation. Viele Tätigkeiten werden sich im Zuge der Transformation grundlegend verändern – auch einer Technischen Redakteurin oder eines Technischen Redakteurs. Die Produkte werden immer smarter und damit auch die Technische Dokumentation. Traditionelle Handbücher aus Papier wird es zukünftig nicht mehr geben.

Nur weil ein Produkt smarter ist, heißt das nicht automatisch, dass es einfacher zu bedienen oder weniger komplex ist. Die Kunden erwarten aber, dass sie nicht mehr in einer Bedienungsanleitung herumblättern müssen. Hier kommen Videotutorials oder animierte Gifs ins Spiel, in denen die einzelnen Schritte in einfacher oder leichter Sprache verständlich erklärt werden. Aber auch die Produktion in den Unternehmen wird zukünftig anders aussehen. Die gedruckte Technische Dokumentation stirbt langsam, aber sicher aus. Die digitalisierte Form, bereitgestellt auf einem Informationsportal, auf das von überall zugegriffen werden kann, enthält nicht nur Informationen beispielsweise zu Rüstvorgängen oder Fehlersuchen. Dort findet man ebenso FAQs, Informationen zu Ersatzteilen oder Schaltplänen. Es können Notizen hinterlegt werden, und auch Aufträge können eingespielt werden. Informationen sind über die Stichwortsuche viel schneller verfügbar. Die Technische Redaktion wird also eher mehr, sie wird nur anders aussehen. 

Titelseite von Ausgabe 03 2022 der technischen kommunikation.