Technische Dokumentation ist die Grundlage für den Nachweis sicherer Produkte

Sie als Produkthersteller, Produktimporteur oder Produkthändler müssen all jene, mit Ihren Waren in Zusammenhang stehenden, Unterlagen, Belege, Materialien, etc. erstellen oder zusammenstellen.

Die Dokumente und Unterlagen müssen archiviert und dauerhaft (es gibt gesetzliche Vorgaben, wie lange) verfügbar gemacht werden.

Gute Technische Dokumentation

• beschreibt technische Erzeugnisse,
• ist systematisch aufbereitet,
• enthält strukturierten Inhalt,
• ist zweckbestimmt,
• ist vollständig und
• ist immer verfügbar.

Wenn ein Produkt mit der CE-Kennzeichnung versehen wird, ist die Dokumentation von Rechtswegen her erforderlich. Die CE-Kennzeichnung ist dabei keine Kür. Sie ist gesetzliche Pflicht.

Sollte Ihr Erzeugnis unter eine oder mehrere EU-Richtlinien und / oder EU-Verordnungen fallen, die eine CE-Kennzeichnung fordern, müssen die dort geforderten Schutzziele eingehalten werden.

Mit der Konformitätserklärung bestätigt das Unternehmen als finalen Schritt der Produktherstellung, dass es die geforderten Maßnahmen für die Produktsicherheit umgesetzt und dokumentiert hat. Hier sind Normen hilfreich, die Lösungen zur Risikominimierung konkret nennen und klare Anforderungen stellen. Aber auch Abweichungen von der Norm sind möglich, wenn das Produkt am Ende wenigstens genauso sicher ist.

Die Behörden dürfen jederzeit Einsicht in die gesamten Unterlagen zu einem konkreten Produkt verlangen. Im Schadensfall prüfen sie übrigens nicht nur auf formale Mängel (die z. B. die Zolleinfuhr unmöglich machen können, bis sie beseitigt sind), sondern auch auf inhaltliche Fehler. Das Unternehmen und dessen Mitarbeiter können wegen eines Produkt- oder Instruktionsfehlers haftbar gemacht werden.

Was bringt Technische Dokumentation?

Sie hilft, das hergestellte Objekt vollständig und umfassend zu beschreiben.

Dabei ist für Ihre Kunden besonders die Nutzungsinformation wichtig, damit sie lernen, wie mit dem erworbenen Gut umzugehen ist. Um das sicherzustellen, braucht die Bedienungsanleitung eine für die Zielgruppe verständliche Sprache.

Damit die Handbücher nicht in der Ecke verstauben, muss der Anwender sich gut in ihnen zurechtfinden. Eine geschickt gewählte Struktur ermöglicht dies, so dass die gesuchten Inhalte sofort gefunden werden können. Am Ende kann ein gutes Handbuch sogar helfen, die Kundenzufriedenheit zu erhöhen und damit mehr Geschäft zu generieren oder auch die Service-Anfragen zu reduzieren und damit bares Geld sparen.

Wer braucht Technische Dokumentation?

Sie wird von jedem benötigt, der eine Technologie nutzen oder entwickeln will. Dazu gehören Entwickler, Systemadministratoren, Endbenutzer und alle anderen, die verstehen wollen, wie eine Technologie funktioniert. Technische Dokumentation wird auch von Organisationen benötigt, die die Einhaltung von gesetzlichen Vorschriften oder Industriestandards sicherstellen wollen.

Hersteller

Unternehmen und Produkthersteller können mit der Technischen Dokumentation nachweisen, dass sie alles Notwendige bedacht haben, um ein sicheres Erzeugnis, besonders Maschinen und Anlagen, auf den Markt zu bringen.

Aber auch, um ihren Kunden bei der Produktnutzung bestmöglich zu unterstützen.

Dabei ist es unerheblich, ob es sich bei dem hergestellten Produkt um eine Maschine, Software, Waren für den Endverbraucher, Elektronikprodukte oder Medizinprodukte handelt.

Nutzer

Der Produktbenutzer braucht die Bedienungsanleitung, um zu lernen, was er mit der Ware machen kann und wie er es sicher und effizient benutzt.

Dabei ist es wichtig, dass er nicht nur die Sprache versteht, sondern anhand der Struktur auch schnell zum gewünschten Inhalt findet. Sonst wird die Dokumentation kurzerhand weggelegt und per Ausprobieren oder Nachfragen versucht, mit dem Objekt richtig umzugehen.

Intern

Hauptsächlich gehören dazu die Unterlagen, die die Produktentwicklung und -herstellung festhalten. Das beginnt bei der Produktidee, den Marktforschungsdaten und der Suche nach rechtlichen Anforderungen und Gesetzen, die auf das Projekt zutreffen könnten.

Im Rahmen der Produktsicherheit sind Sie, wenn Sie Waren bereitstellen (unabhängig, ob Herstellung, Import oder reiner Handel), dazu gesetzlich angehalten, diese nur mit garantierter Sicherheit in Verkehr zu bringen.

Wenn Sie mehr zu Ihren Pflichten wissen möchten, bietet Ihnen unser Service zur rechtssicheren Dokumentation weitere Informationen und die passenden Dienstleistungen dazu.

Diese Art der Dokumentation hat häufig Auswirkungen auf das Erstellen der betriebsexternen Dokumentation. So werden oft Normen angewendet, um die Technikprojekte nach dem Stand der Technik systematisch zu gestalten. Oder es wird festgehalten, wie bestimmte gesetzliche Vorgaben erfüllt werden. Diese Normen und Vorgaben haben oftmals auch Anforderungen an die Informationen, die dem Benutzer bereitgestellt werden müssen.

Beispiele für betriebsinterne Dokumentation wären:

• Recherche nach Gesetzen, Richtlinien, Verordnungen
• Eingehaltene Normen (komplett, teilweise, absichtlich nicht eingehaltene Teile und wie die Sicherheit besser gewährleistet werden kann)
• Umsetzung von vertraglichen Anforderungen
• Spezifikationen und Konstruktionsunterlagen
• Risikoanalysen und Risikobeurteilungen
• Software-Code und -Tests
• Technische Daten, Zeichnungen, Erläuterungen
• Prüfberichte
• Herstellungsunterlagen, wie z. B. Betriebsanweisungen zur Produktherstellung

Wenn Sie Unterstützung hierfür möchten, finden Sie Informationen dazu bei unserem Service www.compliance.gmbh.

Extern

Dazu gehört – wie in der DIN EN 82079-1:2021 definiert – jegliche Benutzerinformation oder Nutzungsinformation.

Sie umfasst also das Handbuch, die Installationsanweisung / Montageanleitung, die Bedienungsanleitung, die Wartungsanleitung und die Beschreibung weiterer Fälle des Produktlebenszyklus. Genauso gehören alle verkaufsfördernden Unterlagen wie Produktwebsite, Kataloge, Flyer, etc. dazu.

Dabei ist es wichtig, dass alle Unterlagen die gleichen Informationen beinhalten. Denn es handelt sich bei allen verschiedenen technischen Beschreibungen, die an Kunden und Interessierte gerichtet sind, um das gleiche Erzeugnis.

Sorgen Sie stets dafür, dass die Informationen in allen Medien und Kanälen gleich sind. Das geht bis hin zu Produkt-FAQs auf Ihrer Website oder den Anweisungen für die Service-Hotline. Und ziehen Sie bei Bedarf die Informationen in allen Medien auf den gleichen Stand, z. B. wenn es Änderungen gibt – entweder an der Ware oder der Art und Weise, wie diese im Detail beschrieben wird.

Beispiele für betriebsexterne Dokumentation wären:

• Anleitungen,
• Bedienungsanleitungen,
• Betriebsanleitungen,
• Installationsanleitungen,
• Gebrauchsanleitungen,
• Handbücher,
• Kataloge,
• Montageanleitungen,
• Werbebroschüren,
• Flyer, etc.

Wer erstellt Technische Dokumentation?

Im Prinzip kann jeder eine solche zu einem Technikprojekt verfassen. Die Norm 82079‑1:2021 empfiehlt allerdings eindringlich, ebenso für das Dokumentieren wie beim Entwickeln des produzierten Guts Fachpersonal einzusetzen.

Technische Redakteure sind darin ausgebildet, gut nachvollziehbare Texte zu erstellen. Dafür müssen sie diverse Voraussetzungen kennen, die sie bereit sind, aus den verantwortlichen Produktentwicklern herauszukitzeln. Sie kennen die passenden Werkzeuge, mit denen nicht nur die Dokumentation, sondern auch verschiedene Versionen erstellt werden können.

Eine Technische Redaktion versteht sich auch darauf, ggf. fehlende Informationen zu ergänzen oder auch falsche Aussagen zu erkennen und anzupassen. Das Erstellen der Dokumentation aus verschiedenen Quellen funktioniert besonders gut mit Redaktionssystemen.

Dabei ist unerheblich, in welchem Medium die Anleitung am Ende die Informationen liefert. Besonders bei der externen Dokumentation wandelt sich inzwischen das Nutzerverhalten. Mittlerweile werden häufig bevorzugt Videos, Tutorials oder Apps genutzt, um Produktfunktionen besser kennenzulernen.

Am Ende ist es wichtig, dass Ihre Kunden genau wissen, was sie mit Ihrer Ware machen können, wie sie damit sicher, effektiv und effizient umgehen – und was sie tunlichst unterlassen sollten.

Ob das immer als geschriebener Text sein muss, lässt sich hinterfragen. Die reinen grafischen Betriebsanleitungen werden aufgrund von häufigerem Einsatz künstlicher Intelligenz inzwischen wieder hinterfragt. Denn nicht nur der Mensch muss die Anleitung lesen können, teilweise auch Maschinen, die dann Antworten in Form von z. B. Chatbots geben.

Technische Redaktion: extern und intern

Das Wissen für betriebsinterne Arbeit liegt meist in der Produktentwicklung. Technische Redakteure benötigen Zugriff auf dieses, um Informationen korrekt abzubilden.

Das bedeutet, hier ist eine effektive Zusammenarbeit gefragt: Die Redakteure können mit ihrer Systematik und ihrem Dokumentationsgeschick die Inhalte aus den Köpfen der Entwickler aufs Papier bringen. Sie können auch mit dem Blick von außen die ein oder andere Frage stellen und ihre Meinung zur Risikominderung durch Information (Warnlabels, Sicherheits- und Warnhinweise in der Betriebsanleitung, auf der Verpackung, etc.) in den Ring werfen.

Die externe Technische Dokumentation sollte auf jeden Fall ein Redakteur erstellen. Er versteht sich auf das zielgruppengerechte Schreiben, einheitliche Terminologie und konsistentes Layout, die zu den "Basics" einer guten Bedienungsanleitung gehören.

Die Handbuch Experten – Ihr Dienstleister für die Erstellung Ihrer Technische Dokumentation

Die Technische Redaktion der Handbuch Experten beschreibt für verschiedenste Technikprojekte die Installation und Inbetriebnahme, Benutzung und Bedienung, Inspektion, Wartung oder Reparatur, Entsorgung – und was sonst noch Spezifisches für das jeweilige Objekt anfällt. Sie nehmen systematisch den Blick des Nutzers ein und fragen sich immer wieder kritisch, ob diese Information vom Benutzer verstanden wird und ob sie hilfreich aufbereitet und strukturiert ist.

Für uns ist Technische Dokumentation nicht nur eine nervige Aufgabe, die zur Produktherstellung dazu gehört, für uns ist sie etwas, die wir mit Begeisterung erschaffen. Wir helfen Ihnen, die Zusammenhänge Ihres Projekts verständlich aufzuzeigen und visuell aufzubereiten, damit Ihren Kunden, das Maximum aus Ihrem Produkt herauszuholen können und lange Freude daran haben.

Dabei lassen wir unsere Jahrzehnte-langes Know-How einfließen, durch die wir die Bearbeitung von Dokumentationsprojekten systematisiert haben.

Die entscheidende Frage, die Sie sich stellen sollten lautet: "Möchte ich diese bei uns im Hause erstellen oder soll ein Dienstleister für Technische Dokumentation diese Arbeit für uns übernehmen."

Im ersten Fall bieten wir Ihnen an, Ihre Mitarbeiter mit unserem Wissen zu unterstützen:

• Doku-Check für die EU
• Seminare und Workshops, um Ihren Mitarbeitern Grundlagen der Technischen Redaktion oder spezifische Anforderungen aus Normen und Richtlinien an die Hand zu geben

Im zweiten Fall übernehmen wir die Erstellung komplett:

• Analyse Ihrer bestehenden Dokumente
• Konzeption
• Schreiben der Benutzerinformation
• Automatisierung
• Lokalisierung
• Schulungsunterlagen

Außerdem bieten wir zur betriebsinternen Dokumentation mit unserem Service zur Product Compliance folgendes an:

• Beratung zur CE-Kennzeichnung
• Recherche zu den Marktanforderungen
• Verwaltung der Dokumente
• CE-Dossier