Externe und interne Dokumentation –
so kommen alle an die benötigten Informationen
Kennen Sie den kompletten Wissenstand in Ihrem Unternehmen? Entwicklung, Produktion und Betrieb von Maschinen beruhen auf einem reichen Schatz an Wissen und Erfahrungen. Das Problem: Diese Kenntnisse sind häufig unter den Mitarbeitern verteilt. Eine gute interne Dokumentation steht nun vor der Herausforderung, alle Informationen abteilungsübergreifend zur Verfügung zu stellen.
Und schon stellt sich die nächste Frage: Was wollen Sie davon Ihren Kunden und Lieferanten preisgeben? Das ist der Inhalt der externen Dokumentation. Zuguterletzt sind da schließlich noch die Forderungen des Gesetzgebers an das Produkt. Wie schnell können Sie nachweisen, alle Regeln berücksichtigt zu haben? Haben Sie alle drei Punkte umgesetzt, dann steht Ihre Technische Dokumentation auf einer guten Basis. Schauen wir uns nun an, wie dies im Einzelnen aussieht.
Was bedeutet externe und interne Dokumentation?
Alle Informationen, die den Lebensweg eines Erzeugnisses vom Entwurf über die Entstehung und die Nutzung bis zur Aussonderung beschreiben, sind Bestandteile der internen Dokumentation. In der Regel erarbeiten diese Inhalte die Mitarbeiter der Fachabteilungen, die für die Entwicklung und Fertigung der Erzeugnisse verantwortlich sind.
Die Unterlagen, die Sie Ihren Lieferanten und Kunden zur Verfügung stellen, bilden dagegen die externe Dokumentation. Die Erarbeitung der Spezifikationen für Bestellungen gehört in den meisten Firmen zu den Aufgaben des Einkaufes. Die Dokumente, die die Kunden für den sicheren Gebrauch der Produkte benötigen, entstehen häufig unter der Federführung des Vertriebs.
Der Einsatz erfahrener Technischer Redakteure für die Erarbeitung externer Dokumente zahlt sich besonders bei anspruchsvollen Erzeugnissen aus, denn die Autoren sind in der Lage, alle erforderlichen Informationen zielgruppengerecht und lückenlos aufzubereiten.
Welche Vorteile bietet die externe und interne Dokumentation?
Die sorgfältige Zusammenstellung aller Fakten im Rahmen der internen Dokumentation ist die Voraussetzung,
- vertragliche Vereinbarungen rechtssicher festzuhalten
- einmal ausgearbeitete Entwicklungsstrategien und Fertigungsprozesse wiederholt zu nutzen
- Materialeinsatz und Bestellungen nachzuvollziehen
- durchgeführte Qualitätssicherungsmaßnahmen und die Einhaltung zutreffender gesetzlicher Regelungen nachzuweisen
- benötigte Informationen schnell abteilungsübergreifend verfügbar zu machen und
- Kunden über die sichere, fachgerechte Nutzung, Instandhaltung und Entsorgung des Produktes zu informieren.
Welche Unterlagen enthält die interne Dokumentation?
Während der Entstehung eines Produktes wächst die interne Dokumentation stetig an. Der Werdegang einer Maschine oder Anlage beginnt in der Regel mit einem Auftrag, der die Anforderungen des Kunden an das Produkt festhält. Weitere Forderungen ergeben sich aus rechtlichen Vorgaben zum Gesundheits-, Arbeits- und Umweltschutz. Auf dieser Grundlage entstehen häufig Pflichtenhefte. Die Realisierung der Aufgaben aus dem Pflichtenheft oder dem Vertag bringt zunächst Risikobeurteilungen, Berechnungsunterlagen und Protokolle von Versuchen hervor. Die konkrete Gestaltung des Erzeugnisses beruht auf detaillierten Unterlagen. Dazu gehören zum Beispiel
- Technische Zeichnungen
- Technologische Schemen
- Stücklisten
- Pneumatik-, Hydraulik- und Stromlaufpläne
- Steuerungspläne
- Montagepläne
Die Herstellung des Produktes erfolgt auf der Grundlage von spezifischen Fertigungsplänen und Vorgaben für Werkstoffe, die Auslagerung von Arbeitsgängen sowie Komponenten, die eingekauft werden müssen. Die externe Dokumentation der Lieferanten erweitert die interne Dokumentation in Ihrer Firma.
Die Fertigung wird von Qualitätssicherungsmaßnahmen begleitet. Die Ergebnisse von Messungen und Funktionsproben fließen ebenso in die interne Dokumentation ein, wie beigestellte Prüfzeugnisse und Zertifikate der Lieferanten.
Betriebsanleitungen und Handbücher ermöglichen dem Kunden den sicheren Umgang mit dem Erzeugnis. Diese Unterlagen beschreiben den Verwendungszweck, die Bedienung, die Instandhaltung und das Verhalten bei Störungen sowie die fachgerechte Entsorgung.
Folgen lückenhafter interner Dokumentation
Eine unvollständige oder fehlerhafte interne Dokumentation führt zur Verringerung der Effektivität der Arbeitsabläufe. Vertrieb, Einkauf, Entwicklung und Fertigung sind zwingend auf entsprechende Informationen angewiesen. Sind diese nicht vorhanden, dann müssen Sie sie zunächst besorgen, wodurch Sie mitunterviel Zeit verlieren, die eine gute interne Dokumentation von vornherein vermeiden würde. Eine ebenso vermeidbare Zeitverschwendung ergibt sich, wenn Ihre Mitarbeiter jedes Projekt „bei null beginnen“ statt auf angesammeltes Wissen zurückzugreifen.
Außerdem können aus einer mangelhaften internen Dokumentation rechtliche Konsequenzen resultieren. Das ist dann der Fall, wenn Sie zum Beispiel wegen fehlender Unterlagen die Erfüllung von gesetzlichen Forderungen nicht nachweisen können oder wenn Kunden Schaden erlitten haben und Ersatz fordern, weil in der Betriebsanleitung wichtige Informationen fehlen.
Die betreffenden Rechtsgrundlagen sind unter anderem
- das Produkthaftungsgesetz
- das Produktsicherheitsgesetz und
- EU-Richtlinien für Maschinen, Druckgeräte, Anlagen mit explosionsgefährlicher Atmosphäre und Niederspannungsanlagen
Einige Vorschriften verweisen auf die Einhaltung von Normen, die den Stand der Technik widerspiegeln. Für die Gestaltung Technischer Dokumentationen werden zum Beispiel die EN 82079 und die VDI 4500 herangezogen.
Verteilung und Aufbewahrung der internen Dokumentation
Eine gut strukturierte interne Dokumentation mit festgelegtem Verteiler und Änderungsdienst erleichtert die Handhabung der Unterlagen. Zusätzlich ermöglicht eine mobile Dokumentation Ihren Anwendern, schnell und papiersparend, jederzeit und überall an die Informationen zu kommen. Die Dokumente sollten Sie mindestens so lange aufbewahren, wie das Erzeugnis im Normalfall genutzt wird. Richtwerte für Aufbewahrungsfristen betragen im Allgemeinen zehn Jahre.
Wer erstellt die interne Dokumentation?
In großen Unternehmen erarbeiten und aktualisieren spezielle Abteilungen die interne Dokumentation für die produzierten Erzeugnisse. Die Unterlagen aus den einzelnen Fachbereichen werden dort systematisch verwaltet und für die externe Dokumentation genutzt.
In kleineren Betrieben arbeiten die Fachabteilungen die Dokumente oft „nebenbei“ aus. Da die Kernkompetenzen der Mitarbeiter jedoch eher auf der fachlichen Ebene als auf der redaktionellen liegen, leider darunter mitunter die Qualität. Außerdem sind im betrieblichen Alltag viele Dinge so selbstverständlich, dass ihre Erwähnung überflüssig zu sein scheint. Externe Dienstleister der Technischen Dokumentation behalten dies jederzeit im Blick und erledigen für Sie alle Aufgaben.
Das Outsourcing bringt weitere Vorteile mit sich: Es entlastet Ihre Mitarbeiter und Sie profitieren überdies von den Erfahrungen und der Effizienz eines außenstehenden Dienstleisters, der sich bei der Arbeit ebenso mit den technischen Einzelheiten Ihres Erzeugnisses vertraut machen will wie Ihre Kunden. Wenn Sie sich um Ihre externe und interne Dokumentation immer selbst kümmern, laufen Sie außerdem Gefahr, „betriebsblind“ zu werden. Ein externer Dienstleister schafft Abhilfe und bringt gut und gerne auch mal etwas frischen Wind in Ihre Doku!
Bildquellen: Pixabay