Technische Dokumentation

Die Technische Dokumentation ist eine Dokumentensammlung, die ein Hersteller zu einem technischen Produkt, System oder Verfahren bereitstellt. Ein Synonym für die Technische Dokumentation ist die Produktdokumentation. Sie enthält alle nötigen Informationen, die Verwender und andere Produktbeteiligte benötigen, um ein technisches Produkt sicher zu nutzen und Gefahren korrekt einzuschätzen – vom Entwurf des Produkts über die Herstellung bis zum Betrieb.

Aufbau der technischen Dokumentation

Bei der Technischen Dokumentation handelt es sich im Übrigen um keine lose Sammlung von Dokumenten. Alle technisch relevanten Nutzungsinformationen sind strukturiert und gesammelt für die jeweilige Zielgruppe in einer einheitlichen und sachgerechten Terminologie erfasst. Die Terminologie vereinheitlicht die Anforderungen an die Technische Dokumentation über alle Unterlagen hinweg – sie definiert die Dokumentationsstruktur, den Dokumentenaufbau sowie Redaktionsprozesse.

Kurz gesagt: Die Technische Dokumentation folgt einem einheitlichen Standard, der eindeutig, verständlich, konsistent und übersetzbar ist.

Arten von technischer Dokumentation

Allgemein unterscheidet sich die Technische Dokumentation in intern und extern.

Interne Technische Dokumentation

Mit der internen Technischen Dokumentation kommen Hersteller ihrer Nachweispflicht gegenüber dem Gesetzgeber nach. Sie beginnt mit der ersten Entwicklung eines Produkts und endet nach der Aufbewahrungsfrist. Intern dokumentieren Unternehmen das gesamte Wissen, das in Verbindung mit einem Produkt steht.

So setzt sich die interne Technische Dokumentation zum Beispiel aus Dokumenten zusammen, die für die (Weiter-)Entwicklung oder den Test eines Produktes relevant sind. Sie erfasst alle Versionen eines Produkts in seinem Produktlebenszyklus oder Anleitungen, wie die IT bekannte technische Störungen behebt.

Externe technische Dokumentation

Zur externen Technischen Dokumentation zählen alle Informationen, die ein Hersteller nach außen gibt. So stellt der Hersteller Endnutzern zum Beispiel Bedienungs- oder Installationsanleitungen, Wartungs- und Reparaturanleitungen sowie technische Spezifikationen und Datenblätter bereit.

Bestandteile einer technischen Dokumentation

Aus welchen technischen Unterlagen die Dokumentation besteht, hängt vom Produkt, System beziehungsweise Verfahren ab, das Sie dokumentieren möchten. Die Formen der Dokumentation sind dabei ganz unterschiedlich. Je nach Inhalt ist ein Bild, Text oder eine Zeichnung ideal, um diesen zu dokumentieren. Wichtig ist, dass das gewählte Format die Inhalte verständlich und korrekt transportiert.

Inhalte einer Technischen Dokumentation sind zum Beispiel:

• Einleitung und Produktbeschreibung

• Anleitungen zur Nutzung und Installation

• Sicherheitshinweise und Warnungen

• Technische Zeichnungen und Diagramme

• Risikobeurteilungen

• Protokolle und Prüfberichte

• Notfallhandbuch und Online-Hilfen

• Angewandte Normen

Die Erstellung einer Technischen Dokumentation übernimmt in der Regel ein technischer Redakteur. Dabei geht er Schritt für Schritt vor.

Bedarfs- und Anforderungsanalyse

Wie ein technischer Redakteur die Unterlagen erstellt, bestimmen gesetzliche Standards, Anforderungen von Stakeholdern wie Kunden und Anwendern sowie der Bedarf. Mit Bedarf ist in diesem Sinne gemeint, welche Dokumentationen notwendig sind, um über das Produkt vollständig und verständlich zu informieren.

Zum Beispiel ist eine Aufbauerklärung bei einem Möbelstück ein notwendiger Bedarf, um es zu montieren. Hingegen sind komplexe Installations- und Wartungsanleitungen bei ebenso komplexen Industriemaschinen ein Bedarf. Auf Basis aller Bedarfe plant der technische Redakteur dann den Inhalt – also welche Unterlagen in die Technische Dokumentation gehören.

Recherche und Umsetzung

Bevor der technische Redakteur mit dem Schreiben beginnt, recherchiert er die Inhalte. Informationen holt er sich dafür aus verschiedenen Quellen: Entwickler, Ingenieure oder Produktmanager begleiten die Redaktion – entweder mit fachlichem Input oder durch Hilfe bei der Validierung der Inhalte.

Beispielsweise liefert der Entwickler Input zur Programmierung eines Softwareverfahrens, das der technische Redakteur anschließend gemeinsam mit einem Grafiker textlich und visuell aufbereitet. Im Anschluss prüft der Entwickler erneut, ob die Informationen korrekt wiedergegeben sind.

Unternehmen setzen auch gerne Nutzer ein, um die Informationsentwicklung im Hinblick auf die Benutzerfreundlichkeit zu überprüfen. So gehen Unternehmen sicher, dass die Menschen, die mit der Technischen Dokumentation am Ende arbeiten, sie verstehen.

Veröffentlichung und Aktualisierung

Sobald das Arbeitsergebnis validiert vorliegt, prüfen Führungskräfte wie Produktmanager die technischen Dokumente erneut. Sind alle Informationen korrekt, genehmigen sie die Technische Dokumentation und sie wird veröffentlicht.

Selten handelt es sich bei der Technischen Dokumentation um ein statisches Werk. Technische Redakteure ergänzen sie immer um weitere Unterlagen, sobald sich etwas an dem Informationsprodukt ändert – sei es ein neues Softwareupdate, ein festgestellter Fehler oder eine Erweiterung.

Für Hersteller ist die Technische Dokumentation Pflicht. Gleichermaßen schützt sie vor Haftungsrisiken, die in Bezug zu einem Produkt auftreten können. Denn die Technische Dokumentation ist klarer Bestandteil eines Produkts und so auch Teil der Produkthaftung.

Anders ausgedrückt: Die Technische Dokumentation ist ein Nachweis dafür, dass alle gesetzlichen Anforderungen von Herstellerseite für die Verwendung erfüllt sind. Deshalb darf ein technisches Produkt – wie zum Beispiel ein Gerät oder softwarebasiertes Medizinprodukt – erst am Markt erscheinen, wenn auch die Technische Dokumentation vorliegt. Sie ist die Grundlage dafür, dass ein Produkt sicher ist und alle gesetzlichen Anforderungen erfüllt.

Einhaltung von gesetzlichen Vorschriften

In der Europäischen Union ist es zum Beispiel so, dass alle Produkte, die Sie in der EU vermarkten, eine CE-Kennzeichnung benötigen, sofern dies die jeweilige Richtlinie voraussetzt. Das ist beispielsweise bei der Maschinenrichtlinie der Fall.

Allgemein gilt die CE-Kennzeichnungspflicht für jene Produkte, die der Anwendungsbereich der europäischen Richtlinie über Gesundheit, Sicherheit, elektromagnetische Verträglichkeit und Umweltschutz abdeckt. Für diese Produkte ist ein Hersteller verpflichtet, die geforderten Schutzziele einzuhalten und eine Risikoanalyse durchzuführen. Erst wenn die Schutzziele erfüllt sind und die Risiken den harmonisierten Normen der EU entsprechen, darf ein Unternehmen die Konformitätserklärung abgeben.

Haftungsfragen und Produkthaftung

Mit der EU/ EG-Konformitätserklärung bestätigt ein Unternehmen, dass das Produkt mit den gesetzlichen Normen und Richtlinien übereinstimmt. Meist handelt es sich dabei um den Hersteller selbst, den Importeur oder einen Händler. Es haftet der, der das Produkt auf den Markt bringt.

Schadensersatzansprüche oder andere Haftungsansprüche treten immer dann ein, wenn produktsicherheitsspezifische Vorgaben oder Vertragsgegenstände unerfüllt sind.

Wichtige Normen

Damit die technischen Dokumente nachvollziehbar und Informationen gesetzessicher erfasst sind, sind entsprechende Normen einzuhalten. Die bekanntesten Normen für die Technische Dokumentation sind:

• IEC/IEEE 82079-1: informiert über die allgemeinen Anforderungen an die Technische Dokumentation.

• DIN EN 82079-1: beschreibt, was Sie bei der Erstellung von Gebrauchsanleitungen beachten müssen.

• ANSI Z535.6: regelt, wie Sie Warn- und Sicherheitshinweise darstellen sollten.

• DIN EN ISO 17100: gibt an, worauf Sie bei der Übersetzung von Technischen Dokumentationen achten müssen und gibt Tipps zwecks Übersetzungssoftwares.

Aufbewahrungsfrist und Langzeitarchivierung

Gegenstand der Technischen Dokumentation ist nicht nur der Inhalt der Dokumente – auch jedes einzelne Dokument selbst ist Teil der Technischen Dokumentation. So müssen Unternehmen innerhalb der Technischen Dokumentation erfassen, wie und wo sie die Dokumente verwalten und archivieren.

Denn technische Dokumente zählen zur Langzeitarchivierung. Im Langzeitarchiv liegen übliche Aufbewahrungsfristen zwischen sechs und zehn Jahren. Für die Technische Dokumentation gilt die Aufbewahrungszeit von zehn Jahren. In dieser Zeit verwahren Unternehmen die Technische Dokumentation in einem Archiv.

Zu beachten bei der Archivierung: Zu jeder Zeit muss gewährleistet sein, dass die Dokumente revisionssicher verwahrt sind und gleichzeitig schnell auf sie zugegriffen werden kann.

Technische Dokumentationen sind komplex. Sie regeln gesetzliche Aspekte, dokumentieren Produktprozesse, informieren Nutzer und Anwender und sind Grundlage dafür, dass ein Produkt überhaupt auf den Markt darf. Gleichzeitig entwickeln sich Technische Dokumentationen mit der Zeit weiter. Anders als früher ist ein Produkt nicht mehr einmalig aufgesetzt und besteht dann fort. Ein Produkt entwickelt sich und mit ihm die Dokumentation.

Auch die Internationalisierung der Wirtschaft ist im Rahmen der Technischen Dokumentation herausfordernd: Unterlagen in einer Sprache zu erstellen, genügt nicht. Technische Redakteure übersetzen sie in alle Landessprachen, in deren Länder das Produkt vertrieben wird.

Das sind die Herausforderungen der Technischen Dokumentation auf einen Blick:

• Sich verändernde gesetzliche Anforderungen immer einhalten

• Dokumente in alle Sprachen übersetzen

• Mit dem Produkt auch die Technische Dokumentation aktuell halten

• Benutzerfreundliche Inhalte kreieren  

• Langzeitarchivobjekte mindestens zehn Jahre revisionssicher archivieren

Standardisierte Prozesse helfen Unternehmen dabei, die einhergehenden Herausforderungen zu stemmen. Vor allem das Dokumentenmanagement nimmt in Unternehmen viel Zeit im Rahmen der Technischen Dokumentation ein. Effiziente Prozesse innerhalb eines Dokumentenmanagement-Systems (DMS) automatisieren und beschleunigen Arbeits- und Archivierungsprozesse.

Was ist Doxis?

Doxis ist eine Content-Services-Plattform, die unter anderem Dokumente, Geschäftsprozesse und Collaboration vereinheitlicht. Als DMS verwaltet Doxis Informationen systemübergreifend. So ergänzt Doxis beispielsweise Ihr Product Information Management System (PIM), indem es produktrelevante Dokumente archiviert.

Dafür besitzt Doxis übrigens auch Integrationen, die beide Softwares ohne Medienbrüche miteinander verbinden. So arbeitet Doxis im Hintergrund, wenn Sie Ihr PIM wie gewohnt nutzen, und beschleunigt die Prozesse.

Technische Unterlagen in Doxis Schritt für Schritt archivieren

Hey Doxi, wie funktioniert Doxis als Software für die Technische Dokumentation?

Die Technische Dokumentation hält alles fest, was ein Produkt vom Entwurf bis zum Betrieb technisch ausmacht. Mit Bedienungsanleitungen, Montagehinweisen, sonstigen Nutzungsinformationen und Sicherheitshinweisen informieren Unternehmen intern wie extern, dass sie die Anforderungen für die Nutzung erfüllt haben.

Damit ist die Technische Dokumentation eine rechtliche Grundlage für den Vertrieb des Produkts und gleichermaßen ein Informationsprodukt, das jeden, der mit dem Produkt in Berührung kommt, vollständig informiert. Mit Doxis verwalten Sie Ihre technischen Dokumente sicher und effizient – von der Entwicklung bis zur Löschung nach Ablauf der Aufbewahrungsfrist.