Skip to content

Extra #024 Wie sollte man die interne Dokumentation aufbauen und pflegen?

Aufbau-interne-Dokumentation

Sie sehen gerade einen Platzhalterinhalt von Podigee. Um auf den eigentlichen Inhalt zuzugreifen, klicken Sie auf die Schaltfläche unten. Bitte beachten Sie, dass dabei Daten an Drittanbieter weitergegeben werden.

Mehr Informationen

Ein Geschäftsführer wird von der Marktaufsicht kontaktiert und zur Herausgabe der technischen Unterlagen für eine Maschine aufgefordert, deren Konformitätserklärung er unterzeichnet hat. Die Geschäftsführung wendet sich an den Konstrukteur und fragt diesen nach den Unterlagen. Doch der Konstrukteur ist erstmal ratlos und kann die Unterlagen nicht vollständig zur Verfügung stellen, da diese nicht vorhanden sind.

In der letzten Folge zur internen Dokumentation haben wir über den rechtlichen Hintergrund und die Bedeutung der internen Dokumentation gesprochen. Heute machen wir dort weiter, wo wir das letzte Mal aufgehört haben. Wir besprechen die richtige Aufbereitung der Unterlagen und wie Abläufe definiert sein sollten, um eine gute interne Dokumentation zu erhalten. Und welche Rolle der technische Redakteur dabei erfüllen kann.

Lückenlose und Nachvollziehbare Dokumentation

Aber zuerst möchte ich noch auf einen Punkt eingehen, der in der letzten Folge unter den Tisch gefallen ist. Einer der wichtigsten Gründe für die Erstellung der internen Dokumentation sind die Anforderungen des Gesetzgebers. Der Hersteller muss nachweisen können, dass er diese erfüllt und dieser Aufgabe kommt er mit der Erstellung der internen Dokumentation nach.

Nachweis der Normen

Darum ist es umso wichtiger, dass die interne Dokumentation lückenlos und nachvollziehbar ist. Im Kontext der CE-Kennzeichnung gehört auch der Nachweis der angewendeten Normen dazu. Es muss dokumentiert werden, welche Normen für das Produkt zutreffen und angewendet worden sind.

Ein häufiger Fehler dabei ist, dass die Normtitel in einer Liste zusammengefasst werden, ohne weitere Angaben. Ein Prüfer hätte keinerlei Informationen darüber, welche Ausgabe der Norm angewendet wurde und wie diese eingehalten wird. Insbesondere bei langlebigen Produkten ein großes Problem, wenn sich eine Norm während der Lebenszeit mehrfach ändern kann.

Entsprechend wichtig ist es, dass der Hersteller alle Informationen auflistet. Welche Version der Norm angewendet wurde, wie deren vollständiger Titel lautet und wann diese herausgegeben wurde. Außerdem muss begründet werden, welche Teile der Norm eingehalten wurden und wie dies überprüft werden kann.

Denn auch hier ist die Nachvollziehbarkeit wichtig. Insbesondere wenn es um harmonisierte Normen für EU-Richtlinien geht. Kommt es zu einem Haftungsfall, muss der Hersteller ausführlich begründen können, warum er die erprobte, harmonisierte Norm nicht angewendet hat und davon abgewichen ist.

Somit bekommen Normen und Richtlinien eine besondere Bedeutung für die interne Dokumentation. Hierzu gehören neben der EU-Richtlinien auch die harmonisierten Normen wie die DIN EN ISO 20607 für den Maschinenbau und die Normen, die den Stand der Technik repräsentieren. Zum Stand der Technik gehören Normen wie die DIN EN IEC/IEEE 82079-1 oder die VDI 4500.

Bußgelder und Strafrecht

Leider werden die interne Dokumentation sowie insbesondere die Anwendbarkeit von Normen häufig unterschätzt und als Formalie betrachtet. „Die Anwendung von Normen ist ja schließlich freiwillig.“ „Die Dokumentation liest ja eh keiner.“

Umso böser ist das Erwachen, wenn doch jemand die Dokumentation lesen möchte. Anwälte reiben sich in solchen Fällen sicherlich schon die Hände. Denn die interne Dokumentation ist in diesen Situationen eine wesentliche Entscheidungsgrundlage und Beweismittel. Die Marktaufsicht und/oder Richter entscheiden schließlich auf Basis der Beweise bzw. der Aktenlage.

Nicht nur für einen möglichen Haftungsfall ist die interne Dokumentation relevant. Denn eine der Aufgaben der Marktaufsicht ist auch die Kontrolle der Produkte auf dem Markt. Fehlt einem Hersteller die interne Dokumentation, kann er die Erfüllung der gesetzlichen Anforderungen nicht nachweisen. Das Produkt ist missbräuchlich gekennzeichnet und ein Bußgeld von 100.000 EUR für die Maschine wird fällig. Diesen Betrag können Sie im Produktsicherheitsrecht nachschlagen, dort gibt es auch noch weitere Abstufungen.

Kommen außerdem Faktoren wie grobe Fahrlässigkeit oder gar Vorsatz hinzu, haften die Geschäftsführung und Vorstände auch persönlich. Außerdem können noch strafrechtliche Maßnahmen hinzukommen, wie z. B. Haftstrafen.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Aufbewahrungsfristen für interne Dokumentation

Es ist also wichtig, diese technischen Unterlagen jederzeit zur Verfügung zu haben. Und damit kommen wir zur nächsten, spannenden Frage: Wie lange müssen diese Dokumente aufbewahrt werden? Der Gesetzgeber fordert hierbei eine Aufbewahrungsfrist von mindestens 10 Jahre nachdem das Produkt hergestellt wurde und vom Band gelaufen ist.

Aber das ist nicht alles. Auch Faktoren wie die Lebenszeit des Produktes sollten berücksichtigt werden. Kann ein Produkt wie ein Kraftwerk mehrere Jahrzehnte verwendet werden, so muss auch die Dokumentation in dieser gesamten Zeit zur Verfügung stehen. Gerade bei digitaler Speicherung der Unterlagen kann dies zu Problemen und Schwierigkeiten führen, wenn man sich die technische Entwicklung ansieht. Softwarelösungen werden nicht weiterentwickelt und können auf neueren Systemen nicht mehr verwendet werden. Oder Daten werden auf Speichermedien archiviert, die heute nicht mehr ohne weiteres zur Verfügung stehen. Schauen Sie sich dazu einfach nur den PC an. Bis Mitte der 90er waren Disketten der Standard. Dann kam die CD, welche von der DVD abgelöst wurde. Und diese ist inzwischen von der Blu-ray und dem USB-Stick abgelöst worden. Könnten Sie noch eine CD öffnen?

Änderungen und Produktweiterentwicklung

Aber nicht nur die Hardware ist eine Hürde für die Archivierung. Auch die andere Software-Seite kann Probleme verursachen. Denn hier werden häufig kostengünstige Programme verwendet und eingesetzt. Professionelle Software die Redaktionssysteme sind dagegen eher selten anzutreffen, insbesondere bei kleinen und mittelständischen Unternehmen.

Gerade diese Hürde treffe ich auch sehr häufig an. Da gibt es eine Maschine und die wird seit Jahren immer gleich gebaut. Jetzt hat ein Kunde einen Sonderwunsch und der Kunde ist schließlich König. Also wird dieser Sonderwunsch konstruktiv umgesetzt. Der Kunde ist zufrieden, alles ist gut. Oder etwa nicht? Nun leider häufig nicht. Denn der Kundenwunsch wird häufig in der Dokumentation vergessen. Er wird weder in der Risikobeurteilung noch in der Anleitung umgesetzt. Oder er wird umgesetzt und versehentlich das ursprüngliche Dokument überschrieben. Und so beginnt das Chaos.

Interne Dokumentation richtig aufbauen

Womit wir bei unserem eigentlichen Hauptthema angekommen sind. Wie baut man eine interne Dokumentation richtig auf? Zu allererst sollte jedem Verantwortlichen bewusst gemacht werden, dass die interne Dokumentation keine Eintagsfliege sein sollte. Sie sollte richtig aufbereitet, strukturiert und prozessorientiert aufgebaut werden.

Damit eine interne Dokumentation die gesetzlichen Anforderungen erfüllen kann, sollten diese natürlich auch erst einmal bekannt sein. Es ist daher sehr hilfreich eine Matrix für alle Produkte zu erstellen. Und in dieser sollten auch die jeweiligen Vertriebsgebiete dokumentiert werden. Denn für verschiedene Gebiete kann es verschiedene Anforderungen geben.

Sobald dies definiert ist, können Überschneidungen gebündelt und analysiert werden. Ähnliche Produkte haben im selben Vertriebsgebiet häufig dieselben, gesetzlichen Anforderungen. Dasselbe kann auch für Wirtschaftsgebiete gelten. Innerhalb der EU gibt es aufgrund der CE-Kennzeichnungen eine ähnliche Basis für die Anforderungen. Dasselbe gilt auch in anderen Gebieten, wie beispielsweise der eurasischen Wirtschaftsunion.

Sammeln der Dokumente und Informationen

Sind die Anforderungen des Gesetzgebers bekannt, beginnt die Sammlung der Informationen. Diese werden aus allen Bereichen des Unternehmens zusammengetragen. Der Vertrieb kann das Lastenheft des Kunden zur Verfügung stellen, das Marketing Schulungs- und Werbeunterlagen. Aus der technischen Dokumentation kommen alle Arten von Anleitungen und aus der Konstruktion die Risikobeurteilung, Zeichnungen, Tests und andere Unterlagen. Die Produktion kann Informationen zur Fertigung beitragen und die Qualitätssicherung die Maßnahmen zur Qualitätssicherung.

Werden Komponenten oder Baugruppen eingekauft, kann auch der Einkauf samt der Lieferantendokumentation hinzukommen. Und gerade die Lieferantendokumentation kann ein Stolperstein sein, da der Einkauf häufig nicht weiß, welche Dokumente und in welcher Sprache diese benötigt werden. So habe ich schon häufig erlebt, wie zusätzliche Kosten entstanden sind. Einfach weil bei Bestellung der Artikel die Dokumentation vergessen wurde und diese nachträglich angefordert oder herausgesucht werden musste.

Auf diese Art und Weise werden sehr viele Dokumente und Informationen zusammengetragen. In großen Unternehmen gibt es daher eigene Abteilungen, die sich um die interne Dokumentation kümmern. In kleineren Unternehmen läuft diese Arbeit häufig nebenher und wird daher leider häufig auch schlecht durchgeführt. Insbesondere rechtliche Aspekte werden übersehen, meist einfach deshalb, weil es der entsprechenden Person nicht bewusst ist.

Wurden all diese Informationen zusammengetragen, müssen diese häufig strukturiert und aufbereitet werden. Dafür eignet sich häufig der technische Redakteur, da er bei diesen Tätigkeiten über Erfahrungen verfügt. Die Informationen sollten dabei alle sinnvoll und strukturiert abgelegt und archiviert werden. Kommen Änderungen hinzu, müssen diese ebenfalls dokumentiert werden. Betrifft die Änderung eine oder mehrere Abteilungen, so müssen diese auch darüber informiert werden. Die interne Dokumentation umfasst hier also nicht nur Dokumente, sondern auch ganze Unternehmensprozesse. Und da insbesondere bei der Produktentwicklung sehr schnell viele Informationen und Unterlagen entstehen können, empfiehlt es sich, alles digital zu pflegen. Den häufig veraltet der Ausdruck der Unterlagen viel zu schnell.

Beispielhafter Ablauf einer Änderung des Produktes

Da das alles sehr theoretisch zusammengefasst ist, machen wir dazu ein Beispiel. Es geht um die Anpassung eines Produktes auf Wunsch des Kunden. Zuerst wird der Vertrieb vom Kunden kontaktiert und beauftragt. Dieser erhält ein Lastenheft, das die genaue Spezifikation des Wunsches enthält.

Das Lastenheft wird archiviert und zeitgleich an die Konstruktion zur Prüfung weitergegeben. Die Konstruktion bestätigt den Wunsch und macht sich an die Umsetzung. Es wird die bestehende Zeichnung dupliziert und um den Kundenwunsch ergänzt. Im Änderungsvermerk wird der Vorgang protokolliert und die Änderungen hervorgehoben. Die Zeichnung wird an den Projektleiter zur Prüfung und Freigabe weitergeleitet. Dieser prüft die Zeichnung und gibt diese frei. Auch die Freigabe wird in der internen Dokumentation protokolliert.

Die Informationen werden nun an die betroffenen Personen und/oder Abteilungen weitergeleitet. Die Fertigung wird über die neue Zeichnung für den Kunden informiert, die Technische Dokumentation über die anstehende Änderung der Betriebsanleitung. Alle Dokumente und Änderungen werden jeweils dokumentiert und gespeichert. Durch einen Schreibschutz wird eine weitere Änderung der Daten verhindert. Alle Informationen werden zentral in der internen Dokumentation abgelegt und archiviert.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Der Aufwand lohnt sich!

Wie an diesem Beispiel erkennbar ist, ist die interne Dokumentation aufwändig. Aber sie lohnt sich! Denn eine gute interne Dokumentation hat verschiedene Vorteile. Zum einen kann eine externe Dokumentation immer nur so gut sein, wie die interne Dokumentation. Denn sie ist ein Teil davon. Eine schlechte interne Dokumentation führt häufig zu einer schlechten externen Dokumentation und einer schlechten Betriebsanleitung. Allein deshalb, weil nicht alle Informationen vorhanden sind.

Aber es gibt noch mehr Vorteile, die für eine gute, interne Dokumentation sprechen. Denn mit einer guten internen Dokumentation sind die Prozesse im Unternehmen klar definiert. Es ist nachverfolgbar, wann eine Bestellung auf welche Art und Weise eingegangen ist. Die dazugehörenden Verträge sind einsehbar, genauso welche Materialien und Zukaufteile verwendet wurden. Außerdem können die Unterlagen als Basis für weitere Entwicklungsvorgänge verwendet oder adaptiert werden. Dasselbe gilt für die Fertigung und Produktion.

Informationen im Unternehmen zu den Produkten kann schnell weitergegeben werden, wenn eine Abteilung diese benötigt. Der Weggang von Mitarbeitern und der damit verbundene Verlust von Knowhow kann verringert werden. Informationen werden schnell gefunden, Wege der Informationsbeschaffung verkürzt. Oder einfach gesagt: Es wird massiv Zeit eingespart und eine hohe Effektivität erreicht.

Denn am Ende des Tages gilt: „Zeit ist Geld“. Und wer schon einmal solche Informationen recherchieren musste, weiß wie nervend es sein kann, von einem Kollegen zum nächsten geschickt zu werden, um die gewünschten Informationen zu bekommen. Vor allem, wenn im Schlimmsten Fall die Informationen nicht mehr vorhanden sind und neu erstellt werden müssen. Dann vergeht viel Zeit und geht Geld unnötig verloren.

Die Rolle des Redakteurs

Zum Schluss möchte ich nochmals kurz auf die Rolle des technischen Redakteurs eingehen. Denn dieser kann die interne Dokumentation nicht alleine aufbauen. Der Gesetzgeber gibt nicht vor, wie die interne Dokumentation zu erstellen ist oder durch wen dies zu erfolgen hat. Ein technischer Redakteur allein kann es aber nicht schaffen. Er benötigt die Mitarbeit der Fachabteilungen, da er deren Knowhow und Mitarbeit benötigt. Aber der technische Redakteur ist perfekt für die Aufarbeitung und Strukturierung geeignet, weil er weiß, worauf es ankommt.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen