Technische Dokumentation, was ist das eigentlich?

Inhalte in diesem Artikel

• Anforderungen an die Übersetzung
• Risikobeurteilung
• Vorteile der Technischen Illustration
• Sicherheits- und Warnhinweise
• Informationsverwaltung
• Werkzeuge für die Erstellung
• Digitale Technische Dokumentation

Interne und externe Technische Dokumentation

Mit der internen Technischen Dokumentation erfüllen Sie als Hersteller ihre Nachweispflicht gegenüber dem Gesetzgeber. Zu dieser Art der Dokumentation zählen beispielsweise die Risikobeurteilung und die Gefährdungsbeurteilung.

Die interne Dokumentation geht über die Erfüllung der Nachweispflicht hinaus und bietet weitere Vorteile. Sie bildet die Grundlage für die externe Technische Dokumentation – mit ihr sammeln und archivieren Sie alle technischen und rechtlich relevanten Informationen zu Ihren Produkten.

Die externe Technische Dokumentation richtet sich an die Kunden, Anwender, Monteure und Installateure . Sie macht die Nutzer mit der Bedienung des Produktes vertraut. Daher wird die externe Dokumentation auch Anwenderdokumentation, Montage- bzw. Installationsanleitung oder Nutzerinformation genannt.

Zur externen Technischen Dokumentation gehören etwa Gebrauchsanweisungen und Betriebsanleitungen.

Vorteile für Hersteller und Kunden

Die Technische Dokumentation bietet Ihnen als Hersteller zwei große Vorteile:

1. Sie verringert Ihr Haftungsrisiko.
   Eine gründliche und verständlich verfasste Betriebs- oder Gebrauchsanleitung macht die Nutzer mit der Funktion des Produktes vertraut und sorgt so für höhere Sicherheit bei der Anwendung. Sicherheits- und Warnhinweise sorgen dafür, dass das Gefährdungsrisiko weiter abnimmt.
2. Mit einer hochwertigen Betriebsanleitung erhöhen Sie die Kundenbindung.
   Klar verständliche Anweisungen durch die Betriebsanleitung ermöglichen positive Nutzererfahrungen. Das erhöht die Zufriedenheit Ihrer Kunden und stärkt Ihre corporate identity.

Normative und rechtliche Anforderungen an die Technische Dokumentation

Je nachdem, ob es sich um die interne oder externe Dokumentation handelt, gelten verschiedene Normen und Gesetze, die bei der Erstellung der Technischen Dokumentation beachtet werden müssen.

Gesetzliche Vorgaben

Diese Vorgaben werden vom Gesetzgeber, etwa der Europäischen Union und Deutschland, verbindlich vorgeschrieben und müssen daher unbedingt eingehalten werden.

• Das Produktsicherheitsgesetz (ProdSG) ist in Deutschland das wichtigste Gesetz für das Bereitstellen und Inverkehrbringen von Produkten wie Geräten, Maschinen und Anlagen sowie Software. Es ist die Umsetzung der Europäischen Richtlinie 2001/95/EG (Richtlinie über die allgemeine Produktsicherheit) in deutsches Recht.

Das Produktsicherheitsgesetz ordnet zudem die Einhaltung weiterer Richtlinien für die verschiedenen Produktgruppen an. Dazu gehören:

• Maschinenrichtlinie (2006/42/EG)
• Niederspannungsrichtlinie (2014/35/EG)
• Medizinprodukte-Richtlinie / englisch: MDD (Medical Device Directive)

Normative Richtlinien (Normen)

Im Gegensatz zu gesetzlichen Anforderungen sind normative Richtlinien unverbindlich. Sie geben einheitliche Regeln und Empfehlungen für Abläufe und Prozesse vor.

Die Europäische Norm IEC/IEEE 82079-1 (Erstellung Gebrauchsanleitungen für Produkte) ist die wichtigste Norm für die Erstellung Technischer Dokumentation wie Gebrauchsanleitungen. Sie wird in der deutschen Norm DIN EN IEC/IEEE 82079-1 national umgesetzt.

Bei der konkreten Umsetzung der Technischen Dokumentation müssen viele unterschiedliche Normen eingehalten werden, die vorher ermittelt und auf Aktualität und Relevanz geprüft werden müssen.

midok® kann Sie bei der Dokumentationsanalyse unterstützen.

Usability (Benutzerfreundlichkeit)

Richtlinien für die Benutzerfreundlichkeit von Computer-Anwendungen werden durch die Europäische Norm DIN EN ISO 9241-110:2020-10 (Ergonomie der Mensch-System-Interaktion) festgelegt. Sie gehört zu den unverbindlichen Normen.

Eine hochwertige Betriebsanleitung, die einen verständlichen und zielgruppengerechten Schreibstil und eine konsistente Terminologie aufweist, trägt wesentlich zur Nutzerfreundlichkeit des Produkts bei. Hierbei leistet die Benutzerfreundlichkeit ihren Beitrag.

Fundorte von Anforderungen an die Technische Dokumentation

Für die Dokumentation der unterschiedlichen Produktgruppen gelten unterschiedliche Gesetze und Normen. Um Ihnen einen Überblick zu ermöglichen, stellen wir Ihnen im Folgenden die wichtigsten Richtlinien für die jeweilige Produktgruppe vor.

Maschinen und Anlagen

Für Maschinen und Anlagen gilt die Maschinenrichtlinie (2006/42/EG). Sie beschreibt unter anderem in Anhang I, Nr. 1.,7.4 die Anforderungen an den Inhalt der Betriebsanleitung. Dazu zählen etwa die Festlegung der Sprache der Originalbetriebsanleitung, die Auflistung der notwendigen Bestandteile der Betriebsanleitung und die Anforderungen bei der Beschreibung der bestimmungsgemäßen Verwendung.

Elektrogeräte

Die Niederspannungsrichtlinie (2014/35/EU) bestimmt grundlegende Sicherheitsanforderungen für Elektrogeräte. Sie gilt für Geräte mit einer Spannung von 50 bis 1000 V Wechselspannung oder 75 bis 1500 V Gleichspannung und stellt unter Kap.2, Artikel 6, Absatz 7 Vorgaben für der Betriebsanleitung auf.

Die EMV-Richtlinie (2014/30/EU) gibt unter Artikel 18 die Anforderungen an die Betriebsanleitung an.

Spielzeug

Unter die Spielzeug-Richtlinie (2009/48/EG) fallen viele Produkte, die man nicht sofort mit Spielzeug in Verbindung bringt. In diesen Fällen müssen die Vorgaben der Richtlinie bezüglich Schadstoffe und Verletzungsgefahr berücksichtigt werden.

Die Produktsicherheitsverordnung (ProdSV) stellt unter anderem genaue Anforderungen an die Technische Dokumentation von Spielzeug. Unter § 11 (2) 2. macht sie beispielsweise Vorgaben für die Anbringung von Warnhinweisen.

Medizintechnik

Für Medizintechnik gilt die Verordnung (EU) 2017/745 über Medizinprodukte (europäische Medizinprodukte-Verordnung oder Medical Device Regulation, kurz MDR). Die MDR bestimmt auch formale Kriterien wie Format, Medium und Lesbarkeit sowie die zielgruppengerechte Formulierung der Technischen Dokumentation.

Software

Bei der Dokumentation für Software hängt die relevante Richtlinie davon ab, wie die Software verwendet und eingesetzt wird. Als eigenständiges Produkt unterliegt Software den gesetzlichen Vorgaben der Produktsicherheits- und Produkthaftungsrichtlinien.

In Deutschland gilt für Software zudem das Bundesdatenschutzgesetz (BDSG). Je nachdem, mit welchem System die Software interagiert, gelten weitere Anforderungen für die Technische Dokumentation.

Anforderungen an den Ersteller der Technischen Dokumentation

Die Dokumentation wird von Technischen Redakteuren verfasst. Die Redakteure müssen komplexe Zusammenhänge, Prozesse und Funktionsweisen erfassen und verständlich und zielgruppengerecht vermitteln können. Zu den Aufgaben der Redakteure gehört auch die gründliche Recherche, in der alle für die Dokumentation notwendigen Informationen ermittelt werden.

Ausbildungsmöglichkeiten

In der Regel wird der Berufseinstieg als Technischer Redakteur durch das abgeschlossene Studium an einer Hochschule vorbereitet. Es gibt aber auch noch andere Wege der Qualifikation:

• Hochschulstudium der Technischen Kommunikation oder fachverwandter Studiengänge
• Weiterbildung in Vollzeit oder berufsbegleitend
• Quereinstieg mit abgeschlossenem Studium in technischem oder geisteswissenschaftlichem Bereich

Kompetenzen der Technischen Redakteure

Technische Redakteure müssen über die folgenden Kernkompetenzen verfügen:

• Muttersprachlichkeit in der Erstellungssprache
• Technisches Verständnis
• Organisationsfähigkeit
• Kommunikationsfähigkeit
• Gründliche und eigenverantwortliche Arbeitsweise

Informationsaustausch – der Schlüssel zu einer gelungenen Dokumentation

Für die erfolgreiche Zusammenarbeit zwischen Hersteller und Technischer Redaktion ist ein sorgfältiger Austausch von Informationen unerlässlich. Daher wird der Ablauf frühzeitig in der Projektplanung festgelegt. Hierbei müssen verschiedene Fragen geklärt werden, wie zum Beispiel:

• Welche Informationen kann der Hersteller bereitstellen?
• Wer sind die jeweiligen Ansprechpartner für den Informationsaustausch beim Hersteller und beim Dienstleister?
• Welche Kanäle werden für den Datenaustausch genutzt?
• Welche Eingangs- und Ausgangsformate werden beim Datenaustausch verwendet?
• Welche Sicherheitsstandards müssen beim Datenaustausch eingehalten werden?
• Gibt es bestimmte Fristen, die eingehalten werden müssen?
• Wie ist der Vorgang bei kurzfristigen Änderungen von Anforderungen und Reviewprozessen?
• Wie führen die Dienstleister Vor-Ort-Besuche (etwa um Produktfotos anzufertigen) am besten durch, ohne den laufenden Betrieb übermäßig zu stören?

Diese Fragen können Ihnen dabei helfen, alle notwendigen Informationen rechtzeitig zu sammeln, um eine hochwertige Technische Dokumentation zu erstellen.

Konformitätserklärung

Mit der EG-Konformitätserklärung versichern Sie als Hersteller oder Inverkehrbringer des Produkts, dass es allen Anforderungen an den Sicherheits- und Gesundheitsschutz entspricht.

Die Konformitätserklärung ist zudem eine Voraussetzung für die Erlangung der CE-Kennzeichnung  In der Konformitätserklärung sind alle Richtlinien und harmonisierten Normen, die für das Produkt gelten, angegeben. Die Hersteller müssen die Konformitätserklärung je nach relevanter Richtlinie gemeinsam mit dem Produkt zur Vorlage bereithalten.

Beim Konformitätsbewertungsverfahren wird die Einhaltung der relevanten Richtlinien und Normen sichergestellt. Die Hersteller können das Konformitätsbewertungsverfahren eigenverantwortlich durchführen, oder eine zugelassene Benannte Stelle damit beauftragen.

Wenn die Ersteller mehrere Konformitätserklärungen für ähnliche Produkte ausstellen müssen, können sie die Angaben in einer Erklärung zusammenfassen.

CE-Kennzeichnung

Produkte, die auf dem europäischen Markt in Verkehr gebracht werden sollen, benötigen die CE-Kennzeichnung. Mit ihr erklären Sie als Hersteller, dass Ihr Produkt den zutreffenden europäischen Richtlinien entspricht und Sie ein Konformitätsbewertungsverfahren durchgeführt haben.

Die Hersteller müssen die CE-Kennzeichnung klar erkennbar auf der Oberfläche des Produkts anbringen. Wo dies nicht möglich ist, muss die CE-Kennzeichnung auf der Verpackung oder den Begleitinformationen angebracht werden.

Erfahren Sie mehr über unseren CE-Kennzeichnungs-Service.

Anforderungen an die Übersetzung

Deutschland hat eine führende Rolle im globalen Maschinenbau, einer Branche, die sich besonders stark am Export orientiert. Und zu jeder Maschine und Anlage gehört die Technische Dokumentation wie z.B. die Bedienungsanleitung oder die Gebrauchsanweisung, die in die Amtssprache des Ziellandes übersetzt werden muss.

Um eine hochwertige Übersetzung zu produzieren, müssen folgende Punkte beachtet werden:

Dateiformate

Eine Software für computergestützte Übersetzung (CAT-Tools) kann beinahe alle Dateiformate verarbeiten. Um nur einige Beispiele zu nennen:

• MS Word
• MS Excel
• Adobe InDesign
• Adobe FrameMaker
• XML
• PDF

Terminologie

Die verwendete Terminologie wird am Anfang der Übersetzung bestimmt. Eine konsistente Verwendung der Fachbegriffe wird dabei durch den Einsatz von muttersprachlichen Fachübersetzern und Techniken wie Terminologiedatenbanken sichergestellt.

Dateiverwaltung

Modularität erleichtert die Technische Übersetzung und spart unnötige Dopplungen und damit Übersetzungskosten. Eine gut geplante Datei- und Ablagestruktur sichert besonders im Umgang mit modular aufgebauten Dokumentationen den reibungslosen Ablauf der Übersetzung.

Formatierung bzw. Layouting

Das Dokument muss von leeren Absätzen und erzwungenen Umbrüchen durch manuelle Formatierung bereinigt werden. So kann es besser vom CAT-Tool verarbeitet werden.

Bevor die Technische Übersetzung final dem Auftraggeber übergeben wird, wird ein letztes Layouting durchgeführt, so dass alle Technischen Illustrationen, Zahlen und Beschriftungen optimal sitzen.

Erfahren Sie mehr über die Notwendigkeit Technischer Übersetzungen. Sie könne sich auch direkt mit Konkreten Fragen an unseren Translation-Service richten und ein Angebot anfordern:

Der Zweck der Risikobeurteilung und ihre Bedeutung für die Technische Dokumentation

Die Norm DIN EN ISO 12100 (Sicherheit von Maschinen) definiert die Risikobeurteilung als die Gesamtheit der Verfahren, mit denen die Risikoanalyse und Risikobewertung durchgeführt werden. Die Risikobeurteilung gehört zur internen Dokumentation, sie muss also weder Ihren Kunden noch den Anwendern zugängig gemacht werden. Sie bildet aber die Grundlage der sicherheitsbezogenen externen Dokumentationen, die Sie den Nutzern bereitstellen müssen.

Die Kriterien, nach denen die Risikobeurteilung sicherheitsbezogene Informationen ermittelt, umfassen unter anderem:

• Eintrittswahrscheinlichkeit von Schädigungen
• Schwere der beim Eintreten zu erwartenden Schäden
• Möglichkeiten zur Vermeidung der ermittelten Gefährdungen

Es kann Restrisiken geben, die Sie als Hersteller nicht durch zusätzliche Sicherheitseinrichtungen beseitigen können. In diesem Fall geht dies durch Sicherheits- und Warnhinweise in die Nutzerinformation ein.

midok® kann Ihr Unternehmen bei der Gefährdungsbeurteilung unterstützen.

Vorteile der Technischen Illustration

Abbildungen erleichtern das Verständnis und die Vermittlung komplexer technischer Zusammenhänge. Durch Technische Illustrationen können bestimmte Elemente hervorgehoben werden, so dass etwa Anleitungen klarer werden. Speziell im Bereich Maschinen und Anlagen können Sie so die Verständlichkeit der Betriebsanleitung erhöhen.

Durch den Einsatz Technischer Illustrationen können zudem textliche Erläuterungen kürzer gefasst werden. Dies hat für die Kunden den Vorteil geringerer Kosten für die Technische Übersetzung.

Erfahren Sie mehr über den midok®-Service für Technische Illustrationen.

Der Nutzen von Sicherheits- und Warnhinweisen

Durch Sicherheits- und Warnhinweise werden Nutzer vor gefährlichen Situationen im Umgang mit dem Produkt gewarnt. Sie geben den Anwendern zudem Hinweise, wie sie Gefährdungen vermeiden oder bewältigen können.

Sicherheitshinweise

Mit Sicherheitshinweisen wird das Bewusstsein für Gefahrensituationen erzeugt oder gestärkt. Sie sind auch die Grundlage für Sicherheitsunterweisungen in Unternehmen. Sicherheitshinweise werden oft ohne Signalfarbe oder –Wort in einem eigenen Kapitel der Betriebsanleitung angeführt. Zu den Mitteln der Sicherheitshinweise gehören auch Beispiele und Erläuterungen zu Hintergrundwissen.

Warnhinweise

Durch Warnhinweise wird vor einzelnen Gefährdungssituationen gewarnt. Die Risikobeurteilung wird dabei durch Warnstufen mit Signalfarben und –Worten veranschaulicht. Der Aufbau und die Gestaltungsart der Warnhinweise wird durch verschiedene Normen bestimmt:

• EU: IEC/IEEE 82079-1 (Erstellung von Nutzungsinformation (Gebrauchsanleitungen) für Produkte – Teil 1 Grundsätze und allgemeine Anforderungen).
  Gibt an, wie Warnhinweise in die Technische Dokumentation eingebunden werden sollen.
• Außerhalb der EU: ANSI Z535 (Standard für Sicherheits- und Unfallverhütungsinformationen).
  Gilt international und stellt das Pendant zur Norm ISO 3864 (Gestaltungsgrundlagen für Sicherheitszeichen und Sicherheitsmarkierungen) dar. Sie ist im engeren Sinne für den amerikanischen Raum bedeutend.

Informationsverwaltung

Besonders bei der Technischen Dokumentation komplexer Produkte und solchen mit vielen Varianten wie Maschinen und Anlagen kommt es auf eine gute Informationsverwaltung an, um eine geordnete und übersichtliche Dokumentation zu sichern.

Um eine gute Informationsverwaltung zu gewährleisten, werden Redaktionssysteme (Content Management Systems) eingesetzt, die die Technische Redaktion insgesamt erleichtern und geordneter gestalten.

Werkzeuge für die Erstellung der Technischen Dokumentation

Welche Werkzeuge für die Erstellung der Technischen Dokumentation verwendet werden, richtet sich nach den Anforderungen an die Benutzerfreundlichkeit, Publikationskanäle und Skalierbarkeit.

Es gibt eine breite Auswahl von Werkzeugen, von denen wir Ihnen im Folgenden einige vorstellen:

Redaktionssystem (Content Management Systems, CMS)

Diese Werkzeuge fungieren als Single-Source Publishing Systeme. Wir setzen sie bei der Erstellung von Betriebsanleitungen ein und um Inhalte gemeinschaftlich zu verwalten, zu bearbeiten, zu optimieren und darzustellen. Besonders bei großen Datenmengen vereinfachen und beschleunigen Redaktionssysteme unsere Arbeitsabläufe und Redaktionsprozesse. CMS bieten Funktionen wie:

• Gemeinschaftliches Arbeiten
• Organisierung der Workflows
• Modularität
• Versionierung
• Optimierte Erstellung eines einheitlichen Layouts

Adobe FrameMaker

Hierbei handelt es sich um ein Autorenwerkzeug, das auf die Anforderungen der Technischen Redaktion spezialisiert ist. Mit Adobe FrameMaker können hunderte- oder gar tausendseitige Dokumente bearbeitet werden.

Das Werkzeug stellt eigene Skripte und Plugins zur Verfügung, mit denen Redakteure das Programm individuell anpassen können, um es den jeweils eigenen Anforderungen der Technischen Dokumentation gemäß zu machen.

Microsoft Word

Dieses Programm gehört nach wie vor zu den am meisten verwendeten Werkzeugen für die Erstellung aller Arten von Dokumenten.

Durch integrierte Vorlagen und Designs ermöglicht MS Word eine schnelle und effiziente Handhabung. Besonders für kleine Redaktionen, die Dokumentation für weniger variantenreiche und einfachere Produkte erstellen, genügt dieses Werkzeug.

Adobe InDesign

Der Desktop-Publisher wird besonders für die Erstellung optisch ansprechender Dokumente von Werbe- und Marketingabteilungen eingesetzt.

InDesign verfügt über eine große Bandbreite von Werkzeugen und Textbearbeitungsoptionen, die eine starke individuelle Anpassung erlauben. Das Tool lässt sich zudem mit weiteren Redaktionsprogrammen kombinieren, um professionelle Magazine, Broschüren und Flyer zu verfassen.

Digitale Technische Dokumentation

Die digitale Bereitstellung der Produktdokumentation eröffnet neue Vorteile, die die Möglichkeiten der Dokumentation in Druckform übersteigen. Die Inhalte der Dokumentation können digital etwa schneller abgerufen und leichter nach bestimmten Inhalten durchsucht werden.

Vorteile digitaler Dokumentation zusammengefasst:

• Übergreifende Verfügbarkeit auf Smartphone, PC und Tablet
• Schnelle und einfache Aktualisierung
• Schneller Informationszugriff durch Suchfunktion und Links
• Einbindungsmöglichkeit interaktiver Inhalte wie Animationen 3D-Modelle und Hover-Effekte
• Möglichkeit direkter Bereitstellung der Dokumentation über ein Nutzer-Interface am Produkt