Überspringen zu Hauptinhalt

Extra #002 Technische Dokumentation – Was ist das eigentlich?

Extra #002 Technische Dokumentation – Was Ist Das Eigentlich?

Was ist eigentlich eine Technische Dokumentation? Und welche Wichtigkeit hat die Technische Dokumentation in Hinsicht auf die CE-Kennzeichnung?

Was ist das eigentlich Technische Dokumentation?

Technische Dokumentation ist ein weitfassender Oberbegriff und nicht immer ist klar, welche Unterlagen nun alles unter diesen Begriff fällt. Was gehört zu der Internen und was zu der Externen Dokumentation? Und wie unterscheiden sich diese beiden Kategorien? Und welche Wichtigkeit hat die Technische Dokumentation in Hinsicht auf die CE-Kennzeichnung? Klären wir zuerst mal ab, was unter Technischer Dokumentation zu verstehen ist.

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 Begriff Technische Dokumentation

Eine Technische Dokumentation umfasst alle Informationen, die zur Beschreibung eines technischen Erzeugnisses benötigt werden. Die Informationen sind systematisch strukturiert und leiten die Benutzer bezüglich der Nutzung, Wartung oder Reparatur eines technischen Erzeugnisses an.

Es zählen zu der Technischen Dokumentation alle Unterlagen dazu, die im Produktlebenszyklus eine Rolle spielen. Dabei gehören produktspezifische Informationen dazu, die bei Konstruktion, Herstellung, Qualitätssicherung, Beschreibung von Funktionen und Schnittstellen, sichere und korrekte Anwendung, Instandhaltung und Reparatur sowie Lagerung und Entsorgung eines technischen Produktes zum Einsatz kommen.

Unterscheidung Interne und externe Dokumentation

Die Technische Dokumentation unterscheidet sich in der internen und externen Dokumentation. Die interne Dokumentation verbleibt in der Regel beim Hersteller und wird nicht an externe Stellen herausgegeben. Manche Bestandteile der internen Dokumentation zählen häufig aber auch zur externen Dokumentation, wenn die Herausgabe an den Auftraggeber vertraglich geregelt ist. Da wären wir auch bei dem Unterschied zur externen Dokumentation. Hierzu gehören alle Unterlagen, die extern an den Betreiber bzw. Anwender des Produktes gehen.

Teile der Internen Dokumentation

Diese dient zur Archivierung von produktrelevanten Informationen, die vom Hersteller geführt wird.

Darin enthalten sind alle notwendigen Informationen zur Entwicklung, Fertigung und Prüfungen enthalten sind und welche beim Hersteller verbleiben. Ziel der Internen Dokumentation ist der Nachweis über ein Produkt und deren Eigenschaften. Ohne die Interne Dokumentation kann kein Produkt geplant, entwickelt, gefertigt oder vertrieben werden. Alle Entwicklungsschritte des Produktes sind durch die Interne Dokumentation nachvollziehbar und können für ähnliche Folgeprodukte wieder zur Rate gezogen werden.

Bestandteile der Internen Dokumentation sind die Risikobeurteilung, technische Zeichnungen, Berechnungsunterlagen, Versuchsberichte, Pflichtenhefte und Nachweise hinsichtlich Qualitätssicherungsmaßnahmen.

Im Falle eines Produkthaftungsfalles dient die Interne Dokumentation dazu, die Erfüllung der Herstellerpflichten nachzuweisen. Mit einer lückenlosen Dokumentation können Unternehmen nachweisen, dass Sie nicht gegen Ihre Konstruktions- und Fabrikationspflicht verstoßen haben.

Ebenfalls gehört die Dokumentation von eingesetzten Normen, Richtlinien und Gesetzen zu der Internen Dokumentation. In diesem Zusammenhang kann ich Ihnen auch den Podcast von meinem Kollegen Florian Schmider sehr empfehlen, der sich mit der Normenrecherche ausführlich befasst.

Teile der externen Dokumentation

Die externe Dokumentation sind hingegen Informationen für den Betreiber und Benutzer des Produktes, damit dieses bestimmungsgemäß verwendet werden kann. Hierzu zählen jegliche Dokumente, die vom Hersteller an den Benutzer bzw. Betreiber des Produktes weitergegeben werden. Eines der Kernelemente ist die Anleitung des Produktes. Je nach Anforderung an die Anleitung und vom Produkt abhängig spricht man von Montageanleitung, Installationsanleitung, Benutzerhandbuch, Kurzanleitung, Gebrauchsanleitung, Betriebsanleitung, usw.
Letztendlich jedes Dokument das dazu dient, die sichere und bestimmungsgemäße Nutzung eines Produktes darzustellen.

Dazu zählen auch Dokumente von Zulieferfirmen des technischen Produktes. Bei einem Gesamtwerk von Maschinen sind die Konformitätserklärungen der einzelnen Maschinen mit der externen Dokumentation beizulegen. Im Falle einer unvollständigen Maschine ist stattdessen die Einbauerklärung des Zulieferers beizufügen. Die jeweiligen Anleitungen des Zulieferers gehören ebenfalls als ein Teil zu der externen Dokumentation und müssen ebenfalls mitgeschickt werden.

Die externe Dokumentation hat hohe Anforderungen bezüglich der Verständlichkeit, sprachlicher Korrektheit, optische Aufmachung, Einhaltung von Gesetzen, Normen und Richtlinien. Ebenfalls beinhaltet die externe Dokumentation einen repräsentativen Charakter, da die Unterlagen ein Teil der Präsentation des Herstellers nach Außen ist und einem Teil der Öffentlichkeit zugänglich ist.

Bezüglich der Präsentation des Herstellers zählen natürlich auch technische Unterlagen für Marketing und Vertrieb zu der externen Dokumentation, welches potenzielle Kunden näher über die Eigenschaften und Funktionen des Produktes informieren sollen. Also Verpackungskennzeichnungen, Vertriebsunterlagen, Schulungsunterlagen oder Kennzeichnungen am Produkt. Dies zur Info am Rande dieser Folge.

Wichtigkeit der Technischen Dokumentation

Sowohl interne wie auch externe Technische Dokumentation ist bezüglich der Haftung des Herstellers von großer Wichtigkeit. Das Produkthaftungsgesetz sieht die Technische Dokumentation als Teil des Produktes an, was bedeutet, dass im Schadensfall eine fehlerhafte Technische Dokumentation zu einem Produkthaftungsfall für den Hersteller führt.

Daher sind für die Dokumente viele Vorgaben durch die nationale Gesetze und die europäischen Richtlinien festgelegt. So muss die externe Dokumentation wie die Betriebsanleitung in die jeweilige Amtssprache des Empfängerlandes des technischen Produktes übersetzt sein. Zudem müssen die Dokumente über einen längeren Zeitraum aufbewahrt werden. Eine Technische Dokumentation muss der Hersteller laut der Maschinenrichtlinie mindestens für 10 Jahre aufbewahren. Die Form der Technischen Dokumentation ist ebenfalls festgelegt. Die Externe Dokumentation wie die Betriebsanleitung ist laut der aktuellen Rechtsprechung in Papierform vorzulegen.

Hinsichtlich der Erlangung der CE-Kennzeichnung spielt die Technische Dokumentation auch eine große Rolle. Die jeweiligen europäischen Richtlinien die eine CE-Kennzeichnung fordern, haben auch klare Vorgaben was die technische Dokumentation betrifft. So gehört neben der Konformitätserklärung auch Konstruktionspläne, Schaltpläne und die jeweiligen Benutzerinformationen wie die Betriebsanleitung dazu.

Für nähere Informationen zu der CE-Kennzeichnung kann ich Ihnen auch die Podcast Folge Nummer 10 der Reihe Risikobeurteilung empfehlen. In dieser Episode gehe ich näher auf die Bedeutung der CE-Kennzeichnung im europäischen Warenverkehr ein.

Die Technische Dokumentation ist daher vorrangig für die haftungsrechtliche Absicherung des Herstellers gedacht. Ohne eine vollständige Technische Dokumentation darf der Hersteller die Maschine auch nicht in Verkehr bringen. Fehlen den Betreiber wichtige Informationen über Gefährdungen und notwendige Sicherheitsmaßnahme aus der externen Dokumentation, besteht an der Maschine die Gefahr von Unfällen mit Personen- oder Sachschäden. Zur Gewährung der Rechtssicherheit für den Hersteller und für die sichere Instruktion für den Maschinenbetreiber sind natürlich auch spezielle Feinheiten der Technischen Dokumentation zu beachten.

Feinheiten der Technischen Dokumentation beachten

Ein wichtiges Kriterium für die Technische Dokumentation ist neben der Vollständigkeit natürlich auch die Verständlichkeit. Ist die Anleitung unverständlich geschrieben, gilt diese ebenfalls als fehlerhaft.

Zur Erstellung einer Technischen Dokumentation sind daher auch besondere Fachkenntnisse und Qualifikationen notwendig. Technische Redakteure übernehmen diese Aufgabe, da diese mit den technischen und redaktionellen Feinheiten vertraut sind.

Technische Redakteure sind im Umgang mit den Werkzeugen zur Erstellung einer Technischen Dokumentation wie einem Redaktionssystem geschult. Zudem achten Redakteure auf die sprachlichen Feinheiten bei einer Dokumentation. Sie erarbeiten Terminologielisten, indem Fremdwörter einheitlich bezeichnet werden, um Unstimmigkeiten durch unterschiedliche Bezeichnungen zu vermeiden. Ein aufgestellter Redaktionsleitfaden erleichtert den Erstellungsprozess der technischen Unterlagen für alle Beteiligten.

Im Falle von international genutzten Unterlagen pflegen die Redakteure häufig auch die Übersetzungen ein und verwenden für widerkehrende Dokumente ein Translation-Memory-System, um bereits übersetzte Passagen wiederverwenden zu können.

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

Unsere Kernbereiche bezüglich Technische Dokumentation

Wir können Sie im Bereich Technische Dokumentation auf mehre Wege unterstützen.

Wir überprüfen Software gestützt Ihre Technische Dokumentation auf Herz und Nieren. Bei Bedarf können wir die Dokumentation direkt im Anschluss überarbeiten. Oder wir Erstellen Ihnen Ihre Betriebsanleitung, Gebrauchsanleitung, usw. in einem Redaktionssystem oder sonstigem Programm wie Word oder InDesign.

Ihre Technische Dokumentation in eine oder mehrere Sprachen zu übersetzten ist für uns ebenfalls kein Problem. Wir können Ihre Betriebsanleitung in jede gewünschte Sprache übersetzen und verwenden bei Bedarf sogar ein Translation-Memory-System.

Daneben können wir Ihnen auch im Prozess zur Erlangung einer CE-Kennzeichnung helfen und unterstützen Sie bei der Erstellung der Konformitätserklärung. Auch bei den Besonderheiten rund um die Risikobeurteilung können wir Sie gerne unterstützen. Schicken Sie uns einfach eine Anfrage über unser Kontaktformular zu oder Sie nehmen direkt Kontakt mit uns auf.

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

An den Anfang scrollen