Die technische Dokumentation: ihre Aufgaben, Anforderungen & Bestandteile
Wichtige Informationen zur sicheren Handhabung und rechtlichen Absicherung
Eine technische Dokumentation beinhaltet Informationen für den Hersteller und Maschinenbetreiber und wird anhand streng definierter Richtlinien erstellt. Sie bildet also ein wichtiges Bindeglied zwischen Hersteller und Anwender und kommt im Gesamtbereich industrieller Erzeugnisse zum Einsatz. Gleichzeitig dient sie der haftungsrechtlichen Absicherung im Unfall- oder Schadensfall.
Eine technische Dokumentation muss verschiedene Anforderungen erfüllen. Sie enthält klare Anweisungen zur Inbetriebnahme, Bedienung, Wartung und Reinigung einer Anlage, bis hin zu deren Entsorgung. Gleichzeitig hat sie die Aufgabe, über Gefahren und Risiken aufzuklären und Schutzmaßnahmen sowie Sicherheitsregeln zu benennen. Neben der externen technischen Dokumentation für den Betreiber gibt es noch die betriebsinterne technische Dokumentation, die beim Hersteller verbleibt. Beide beinhalten unterschiedliche Bestandteile. Bei der Menger Group erfahren Sie mehr darüber.
Aufgaben der technischen Dokumentation: informieren, rechtlich absichern und mehr
Technische Dokumentationen dienen zum einen als Informationsprodukte für die Nutzer einer Maschine oder Anlage. Sie umfassen alle Dokumente, die im Laufe eines Produktlebens entstehen – Entwicklungspläne, Protokolle, Bedienungsanleitungen und Anweisungen. Neben Produktbeschreibungen geben sie Anleitungen zur Wartung, Nutzung, Reinigung, Reparatur und Entsorgung einer Maschine oder Anlage. Eine zweite wichtige Aufgabe der technischen Dokumentation ist die haftungsrechtliche Absicherung des Herstellers. Denn Sie dürfen eine Anlage nur dann in Verkehr bringen, wenn die technische Dokumentation vollständig ist und Sie diese dem Betreiber zusammen mit dem Produkt zur Verfügung stellen.
Das soll garantieren, dass die Anlage erst dann in Betrieb geht, wenn die Verantwortlichen über Gefährdungen und notwendige Sicherheitsmaßnahmen informiert sind. Ist eine technische Dokumentation fehlerhaft, unvollständig oder liegt vielleicht überhaupt nicht vor, haften Sie als Hersteller dafür. Der Nutzen einer professionellen Dokumentation geht aber noch darüber hinaus: Kundenreklamationen, Garantie- und Kulanzleistungen lassen sich reduzieren, Anwenderschulungen und die Produktnutzung werden erleichtert. Das verbessert Ihren Workflow entscheidend und hat hohes Einsparpotenzial für Ihr Unternehmen.
Anforderungen an eine technische Dokumentation: Struktur, Sprache und Normen
Verschiedene Gesetze und Vorschriften geben Herstellern von technischen Anlagen bestimmte verpflichtende Richtlinien vor. Denn laut Produkthaftungsgesetz (ProdHaftG) und Bürgerlichem Gesetzbuch (BGB) haftet der Hersteller im Schadensfall, wenn die technische Dokumentation mangelhaft ist. Überdies unterliegt die Dokumentation diversen Normen und Standards, beispielsweise der EN 82079, der VDI 4500 oder EN 61355. So regelt letztgenannte Norm etwa die Kennzeichnung und Klassifikation von Dokumenten für Anlagen, Systeme und Einrichtungen. Auch die Struktur von technischen Dokumentationen folgt klaren Vorgaben.
Vor allem bei Benutzerinformationen sind Sie an hohe Anforderungen gebunden. Hierbei stellen Information-Mapping und Funktionsdesign zwei gängige Strukturierungsmethoden dar. Bei erstgenannter bereiten Sie die Information in Maps (Abbildungen) und Blöcken auf. So entstehen kleinstmögliche „Informationshäppchen“, die vom Anwender leicht erfasst werden können. Ein weiteres unterstützendes Instrument für die Erstellung, Verwaltung und Verwendung von technischen Dokumentationen sind Redaktionssysteme. Hier können Sie zum Beispiel durch die Nutzung definierter Farben Gebote und Verbote unterstreichen. Nicht zuletzt unterliegt auch die Sprache in technischen Dokumentationen klaren Anforderungen: Achten Sie auf Verständlichkeit, Eindeutigkeit, Konsistenz und Übersetzbarkeit.
Die Terminologie in einem Redaktionsleitfaden kann Sie beim Erstellen unterstützen. Der Redaktionsleitfaden gilt als „Gesetzbuch“ der technischen Redaktion. Er enthält in der Regel folgende Inhalte:
- Definition der Dokumentationsstruktur
- Dokumentarten mit innerer Struktur
- Standardstrukturen und Strukturmuster
- Vorgehensmodell zur Definition der Inhalte
- Zielgruppen- und Zweckbeschreibung
- Inhaltsvorlagen und Muster
- Aufgaben- und Kenntnisanalyse, normative Vorgaben
- Definitionen für die Gestaltung der Dokumente
- Gestaltungsregeln
- Muster für Dokumentarten und Grafiken
- Definition des Grafikstils
- Beschreibung der Redaktionsorganisation
- Interne Organisation
- Einbettung in die Unternehmensorganisation
- Interne Organisation
- Beschreibung der Redaktionsprozesse
- Recherche
- Erstellung und Übersetzung
- Produktion und Qualitätssicherung
- Arbeitsmittel für die Redaktion
- Anwendung der eingesetzten Systeme und Tools beschreiben
- Arbeitsanleitungen für Redakteure für den Umgang mit der Redaktionssoftware
Interner oder externer Gebrauch – die Bestandteile der technischen Dokumentation
Bei der technischen Dokumentation wird nach VDI 4500-Norm zwischen interner und externer technischer Dokumentation unterschieden. Die interne technische Dokumentation enthält alle technischen Informationen über Maschinen und Anlagen – ausgehend von der Produktplanung über die Entwicklung und Markteinführung bis hin zur Produktbeobachtung und schließlich der Stilllegung. Diese Informationen sind betriebsintern, verbleiben also beim Hersteller. Zu den typischen Bestandteilen interner Dokumentation zählen: technische Zeichnungen, Schaltpläne, Berechnungs- und Fertigungsunterlagen, Pflichtenhefte, Versuchsberichte und Nachweise zur Qualitätssicherung. Die interne technische Dokumentation erstellt in der Regel die Entwicklungs- und Konstruktionsabteilung des Herstellers. Sie stellt sicher, dass Maschinen und Anlagen qualitätsgerecht, umweltbewusst und ökonomisch gefertigt werden.
Für den Betreiber und Benutzer ist die externe technische Dokumentation entscheidend. Diese muss bestimmte länderspezifische Normen und Richtlinien befolgen. Zu den klassischen Bestandteilen einer externen technischen Dokumentation gehören Bedienungsanleitungen, Montageanleitungen, Benutzerhandbücher, Sicherheitsdatenblätter und Warnhinweise. Die Erstellung der externen Dokumentation übernimmt für gewöhnlich der Technische Redakteur in Ihrem Unternehmen.
Eine Bedienungsanleitung, die als der Standard aller technischen Dokumentationen gilt, sollte folgende Qualitätskriterien erfüllen:
- eine definierte Zielgruppe ansprechen
- eine klare Gliederung aufweisen, damit der Nutzer sich gut und schnell zurechtfindet
- ein übersichtliches Layout besitzen, das keine „Textwüsten“ enthält und mit vielen anschaulichen Grafiken und Bildern aufwartet
- gut erkennbare Sicherheitshinweise enthalten
- eindeutige Handlungsanweisungen in der richtigen Reihenfolge beinhalten
- kurze, verständliche Sätze ohne Füllwörter verwenden
- konsistente Begriffe benutzen