Was ist Technische Dokumentation?

Der Begriff Technische Dokumentation bezeichnet Informationsprodukte und Publikationen, in denen technische Sachverhalte, produktspezifische Daten oder Abläufe strukturiert und präzise für eine bestimmte Zielgruppe aufbereitet werden. Mit Hilfe von Technischer Dokumentation wird die Installation, Nutzung, Wartung oder Reparatur eines technischen Produktes oder einer Maschine detailliert beschrieben.

Den Prozess, bei dem technische Dokumentation von technischen Redakteuren definiert, erstellt und bereitgestellt werden, bezeichnet man als Technische Kommunikation oder auch als Informationsentwicklung.
Ein besonderes Merkmal dieser Dokumentationsform ist die Anwendung von spezialisierter Fachsprache (Terminologie), die meist nur für Experten innerhalb eines bestimmten Fachgebietes verständlich ist. Oft werden komplexe Inhalte zusätzlich durch verschiedene Arten von Visualisierungen veranschaulicht. Das vollständige Vorliegen der Technischen Dokumentation ist – ergänzt um die Konformitätserklärung – die Grundvoraussetzung, um eine Maschine in Verkehr zu bringen und in Betrieb zu nehmen. Bei Versäumnissen des Herstellers drohen Verkaufsverbot und Schadensersatzklagen.

Bereiche der Technischen Dokumentation?

Technische Dokumentation in einer etwas enger gefassten Bedeutung umfasst diejenigen Dokumente, welche spätestens dann benötigt werden, wenn eine Maschine in Verkehr gebracht werden soll. Rechtsgrundlage dafür ist die Maschinenrichtlinie (2006/42/EG). Sie besagt, dass ohne Vorliegen der technischen Unterlagen eine Maschine weder in Betrieb genommen noch in Verkehr gebracht werden darf.
Auch andere europäische Richtlinien wie z. B. die Niederspannungsrichtlinie (2014/35/EU), die Produktsicherheitsrichtlinie (2001/95/EG) oder die Druckgeräterichtlinie (2014/68/EU) stärken die Forderung nach der Technischen Dokumentation, genauso wie z. B. die nationalen Gesetze wie das Produkthaftungsgesetz (ProdhaftG) oder das Elektro- und Elektronikgerätegesetz (ElektroG).
Laut Maschinenrichtlinie (2006/42/EG) müssen Informationen zu Konstruktion, Bau und Funktionsweise der Maschine bzw. des Produkts umfassen. Dazu gehören z. B.:

eine allgemeine Beschreibung und Darstellung der Maschine bzw. des Produkts
Beschreibung der Funktionsweise
die Betriebsanleitung
technische Zeichnungen
Schaltpläne
Dokumente zur Risikobeurteilung
Prüfberichte
die Zusammenstellung der angewandten Normen
die EG-Konformitätserklärung
Zulieferdokumentation

Bei unvollständigen Maschinen muss zusätzlich eine Einbau- und/oder Montage-Erklärung vorliegen.

Weitere Anwendungsbereiche der Technischen Dokumentation ist nicht nur die Erstellung einer Betriebsanleitung, sondern auch die Erstellung von:

Serviceanleitungen
Bedienungsanleitungen
Gebrauchsanweisungen
Reparaturanleitungen
Montageanleitungen
Wartungsanleitungen
Installationshandbücher für Software
Datenblätter
Online-Hilfen
Software-Handbücher
e-Learnings
etc.

Wissenswertes über Technische Dokumentation

Die Technische Dokumentation soll es ermöglichen, zu prüfen, dass ein Produkt den Anforderungen der Maschinenrichtlinie entspricht. Aus der Technischen Dokumentation sollte daher hervorgehen, dass der Hersteller alle geltenden CE-spezifischen Anforderungen an Sicherheit und Gesundheitsschutz berücksichtigt hat. Diese muss in einer Amtssprache der EU sowie in der Sprache des Verwenderlandes abgefasst sein. Die Technische Dokumentation sollte eine Zielgruppengerechte Sprache enthalten, die dem Wissens- und Erfahrungsstand des Benutzers/Bedieners der Maschine angemessen ist.

Die Technische Dokumentation muss vollständig zur Verfügung stehen, bevor eine Maschine ausgeliefert oder gar in Betrieb genommen wird. Sie kann keinesfalls nachgereicht werden.

Die Technische Dokumentation kann zu jeder Zeit von den zuständigen Marktüberwachungsbehörden zur Einsicht verlangt werden. Die komplette Dokumentation muss mindestens zehn Jahre aufbewahrt werden. Dazu zählt der Tag, an dem eine Maschine letztmals hergestellt wurde.

Während der Bearbeitung und Erstellung der Technischen Dokumentationen stehen die Technischen Redakteur vor vielerlei Fragen. Welche Normen oder sprachlichen Vorgaben zu verwenden sind oder wie man einen technisch komplexen Ablauf möglichst einfach und Zielgruppengerecht darstellt.

Normen und Richtlinien

Der Bereich der Technischen Dokumentation stellt ein Spezialgebiet dar, da neben sprachlicher Regeln und Merkmale eine Reihe von Dingen beachtet werden müssen. Dazu zählen neben gewissen gesetzlichen Verpflichtung auch Normen und Richtlinien von Institutionen und Verbänden, die für die Technische Dokumentation einer bestimmten Maschine bzw. eines Produktes maßgeblich sind. Diese Normen und Richtlinien dienen vor allem der rechtlichen Absicherung der Hersteller, der Sicherheit der Nutzer und der Prävention.

Die Gesetze sind für Hersteller von Produkten bindend. Ohne Technische Dokumentation darf zum Beispiel keine Maschine verkauft und in Betrieb genommen werden.

Sprache

Die Sprache und Struktur Technischer Dokumentationen unterscheidet sich in vieler Hinsicht von Literatur oder journalistischen Texten, denn in puncto Verständlichkeit, Eindeutigkeit und Konsistenz müssen hohe Anforderungen erfüllt werden. Außerdem muss bereits bei der Erstellung eine gute Übersetzbarkeit der Texte gewährleistet sein.
Der Wortschatz ist in der Regel hoch spezialisiert und richtet sich an bestimmte Zielgruppen, die diese Art von Sprache und Fachvokabular verstehen können. Die angewendete Sprache zeichnet sich auch durch eine Vielzahl von Regelungen aus, die durch stilistische und grammatikalische Einschränkungen auffällt.

Grafische Darstellungsformen

Für die bessere Veranschaulichung von technischen Dokumentationen werden verschiedene Formen von Visualisierungen eingesetzt. Es gibt eine Reihe von Unternehmen, die sich speziell auf solche Visualisierungen spezialisiert haben. Sie konstruieren beispielsweise digitale 3D CAD Daten, erstellen technische Detailansichten oder animierte Video-Dokumentationen für verschiedene Zwecke.
Für Unternehmen ermöglicht der Einsatz neuer Medien eine große finanzielle Ersparnis, da teure Schulungskosten wegfallen oder zumindest deutlich reduziert werden können.

Im Vergleich zu traditionellen Printmedien ermöglichen virtuelle Bedienungsanleitungen und digitale Produktdokumentationen auch das ortsunabhängige Abrufen und das leichte Suchen und Finden von Informationen – mühsames Durchblättern langer Kataloge und Handbücher entfällt und wird durch wenige Klicks ersetzt.

Usability

Damit die Nutzerfreundlichkeit bzw. Usability von Technischer Dokumentation optimiert werden kann, greifen Unternehmen teilweise auch auf Tests zurück. Dabei kann erprobt werden, ob ein Nutzer tatsächlich die Informationen bekommt, die er braucht, um Zugang zu einem Produkt und dessen Bedienung zu erlangen. In speziellen Usability Tests kann genau dies geprüft werden. Die Kenntnisse, die bei solchen Tests gewonnen werden, können dann gezielt für die Verbesserung der Nutzerfreundlichkeit genutzt werden, um reibungslose, sichere und ordnungsgemäße Arbeitsabläufe zu gewährleisten.

Publikationen

Hier gibt es eine Vielzahl von Medien, die für die Publikation von Technischer Dokumentation in Frage kommt. Die klassische Veröffentlichung ist in Form von ausgedruckter Dokumentation, die in Ordnern abgeheftet sind. Diese Variante wird zwar zunehmend weniger, ist aber dennoch wichtiger Bestandteil, da diese in der Maschinenrichtlinie vorgeschrieben ist.
Neue Medien bringen auf der anderen Seite eine Vielzahl von Vorteilen mit, wie z. B. Einsparung hoher Druckkosten für Bücher und Hefte sowie der Transport von Informationen wird platzsparender und leichter. Des Weiteren ist Technische Dokumentation, die online auffindbar ist, jederzeit ortsunabhängig abrufbar.

Interne Vs. Externe technische Dokumentation

Was ist Technische Dokumentation?

In der Technischen Dokumentation unterscheidet man normalerweise zwei Bereiche: die interne und die externe Technische Dokumentation.
Erstere wird meistens durch die entsprechende Entwicklungsabteilung eines Herstellers geführt und soll sicherstellen, dass alle internen produktrelevanten Dokumente angefangen von der Planung bis zur Entwicklung und Markteinführung eines Produktes lückenlos und gemäß der Vorschriften archiviert werden. Auf diese weise wird der gesamte Produktlebenszyklus von den ersten Plänen, Entwürfen und Zeichnungen bis zur dokumentierten Risikobeurteilung, Versuchsberichten und dem anschließenden Vertrieb dokumentiert und ist später – zum Beispiel im Fall von Unfällen oder einem Rechtsstreit – nachvollziehbar. Das Ergebnis einer solchen Dokumentation ist ein Informationslebenszyklus.

Die externe Technische Dokumentation wiederum richtet sich an externe Nutzer, also die Personen, die das Produkt anwenden, installieren oder warten müssen. Die Sprache dieser Dokumentationen richtet sich meist gezielt an bestimmte Nutzergruppen.

Das Wichtigste im Überblick

Was ist Technische Dokumentation?

Beratung

Sie haben ein konkretes Problem oder das Bedürfnis, Ihre Prozesse und Methoden zu optimieren?
Wir beraten Sie gerne persönlich!

Was ist Technische Dokumentation?

Doku-Erstellung

Wir unterstützen Sie bei der Erstellung von norm­gerechten Dokumenten und benutzer­freundlichen Anleitungen.

Was ist Technische Dokumentation?

Konzeption

Wir erstellen für Sie ein individuell auf Ihr Produkt und Anforderungen zugeschnittenes Konzept.

, Was ist Technische Dokumentation?, schneiderdokumentation.de

Korrektorat & Lektorat

Mit dem besonderen Auge für beste Qualität holen wir das Maximum aus Ihren Dokumenten und Anleitungen heraus.

Was ist Technische Dokumentation?

Doku-Check

Gemeinsam stellen wir sicher, dass Ihre technische Produkt­­doku­mentation den gesetz­lichen Vorgaben entspricht.

Was ist Technische Dokumentation?

Übersetzung

Fachgerechte und technisch versierte Übersetzung der Dokumentation, zur Veröffentlichung in verschiedenen Sprachen.

Technische Dokumentation aus einer Hand. Von der Problemanalyse bis zur Publikation.

Unser Prozess

Nachfolgend finden Sie unseren Prozess, den wir intern und extern mit unseren Kunden während dessen Produktlebenszyklus leben.

Was ist Technische Dokumentation?
Menü

Wir verwenden Cookies, um Ihnen die beste Online-Erfahrung zu bieten. Mit Ihrer Zustimmung akzeptieren Sie die Verwendung von Cookies in Übereinstimmung mit unseren Cookie-Richtlinien. Datenschutz