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

Technische Dokumentation beschreibt Produkte von der technischen Seite her. Das heißt, es sind keine Marketing-Texte, sondern alles, was – beginnend bei der Ideenfindung – das Produkt beschreibt. Deshalb wird Technische Dokumentation häufig auch Produktdokumentation genannt.

Technische Dokumentation bedeutet, dass Sie als Produkthersteller, Produktimporteur oder Produkthändler all jene Dokumente, Belege, Materialien, etc. erstellen oder zusammenstellen, die Ihr Produkt beschreiben. Sie beschreibt also Produkte von der technischen Seite her.

Sie müssen die Dokumente der Technischen Dokumentation dauerhaft (es gibt gesetzliche Vorgaben, wie lange) verfügbar machen. Die Technische Dokumentation umfasst allerdings keine Marketing-Texte. Sie wird häufig auch Produktdokumentation genannt.

Technische Dokumentation

  • beschreibt technische Erzeugnisse
  • ist systematisch aufbereitet
  • ihr Inhalt ist strukturiert
  • ist zweckbestimmt
  • ist vollständig
  • ist immer verfügbar

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

Sollte das Produkt 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 in einer Technischen Dokumentation erfasst hat. Hier sind Normen hilfreich, die Lösungen zur Risikominimierung konkret nennen und Anforderungen an die Technische Dokumentation stellen.

Die Behörden dürfen jederzeit Einsicht in die gesamte Technische Dokumentation 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?

Technische Dokumentation hilft, das Produkt vollständig und umfassend zu beschreiben.

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

Und damit die Technische Dokumentation nicht in der Ecke verstaubt, muss der Nutzer sich gut in ihr zurechtfinden. Eine geschickt gewählte Struktur ermöglicht dies, so dass die gesuchten Inhalte sofort gefunden werden können.

Wer braucht Technische Dokumentation?

Zum einen das Unternehmen, das Produkte herstellt. Denn als Hersteller muss man nachweisen, dass das Produkt sicher ist. Beispielsweise brauchen Maschinen auch vom Gesetz her eine Betriebsanleitung.

Software sollte beschrieben werden, wenn die Zusammenhänge komplex sind und der Nutzer den gesamten Umfang der Software nicht intuitiv erfassen kann.

Hersteller

Unternehmen und Produkthersteller können mit der Technischen Dokumentation nachweisen, dass sie alles Notwendige bedacht haben, um ein sicheres Produkt 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, Elektronikprodukte oder Medizinprodukte handelt.

Nutzer

Der Produktbenutzer braucht die Technische Dokumentation, um zu lernen, was er mit dem Produkt 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 Produkt richtig umzugehen.

Interne und externe Technische Dokumentation

Generell lässt sich sagen: interne Technische Dokumentation beinhaltet alle Dokumente, die für die Produktenwicklung und Herstellung notwendig und / oder gesetzlich vorgeschrieben sind. Externe Technische Dokumentation ist dafür gedacht, dass sie an die Interessenten / Produktnutzer gegeben wird.

Dabei wird der Begriff "Technische Dokumentation" häufig synonym für Bedienungsanleitungen genutzt.

Interne Technische Dokumentation

Technische Dokumentation umfasst allerdings noch viel mehr. Hauptsächlich gehören dazu die internen Dokumente, die die Produktentwicklung und -herstellung festhalten. Das beginnt bei der Produktidee, den Marktforschungsdaten und der Suche nach rechtlichen Anforderungen und Gesetzen, die auf das Produkt zutreffen könnten.

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

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

Die interne Dokumentation hat häufig Auswirkungen auf die Erstellung der externen Dokumentation. So werden oft Normen angewendet, um die Produkte 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 des Produkts bereitgestellt werden müssen.

Wenn Sie Unterstützung für Ihre interne Technische Dokumentation möchten, finden Sie Informationen dazu bei unserem Service www.compliance.gmbh.

Beispiele für interne Technische 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
  • Risikoanalyse und Risikobeurteilung
  • Software-Code und -Tests
  • Technische Daten, Zeichnungen, Erläuterungen
  • Prüfberichte
  • Herstellungsunterlagen, wie z. B. Betriebsanweisungen zur Produktherstellung

Externe Technische Dokumentation

Dieser Teil der Technischen Dokumentation ist der externe Teil. Dazu gehört – wie in der DIN EN 82079-1:2021 definiert – jegliche Benutzerinformation oder Nutzungsinformation.

Die externe Dokumentation umfasst also das Handbuch, die Installationsanweisung / Montageanleitung, die Bedienungsanleitung, die Wartungsanleitung und die Beschreibung weiterer Fälle des Produkt-Lebenszyklus.

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

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 am Produkt oder der Art und Weise, wie das Produkt im Detail beschrieben wird.

Beispiele für externe Technische Dokumentation wären:

  • Anleitung,
  • Bedienungsanleitung,
  • Betriebsanleitung,
  • Installationsanleitung,
  • Handbuch,
  • Kataloge,
  • Montageanleitung,
  • Werbebroschüren,
  • Flyer, etc.
Ihr Kunde verlangt alle möglichen Dokumente und Sie möchten nur das gesetzlich vorgeschriebene liefern?

Gerne beraten wir Sie zum Unterschied zwischen interner und externer Dokumentation und was Sie weshalb an Ihre Kunden liefern müssen.

Angebot noch heute anfordern
oder unter +49 9126 2611-15 beraten lassen

Wer erstellt Technische Dokumentation?

Im Prinzip kann jeder die Technische Dokumentation zu einem Produkt verfassen. Die Norm 82079‑1:2021 empfiehlt allerdings eindringlich, ebenso für das Dokumentieren Fachpersonal einzusetzen, wie beim Entwickeln des Produkts.

Technische Redakteure sind darin ausgebildet, verständliche 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 Technische 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. Die Erstellung der Technischen Dokumentation aus verschiedenen Quellen funktioniert besonders gut mit Redaktionssystemen.

Dabei ist unerheblich, in welchem Medium die Technische Dokumentation am Ende die Informationen liefert. Besonders bei der externen Technischen 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 Ihrem Produkt 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 Bedienungsanleitungen 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 und die externe und interne Technische Dokumentation

Technische Redakteure können durchaus die interne Dokumentation dokumentieren, das Wissen dazu liegt aber meist in der Produktentwicklung.

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 auf‘s 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 Technischer Redakteur erstellen. Ein ausgebildeter Redakteur versteht sich auf das Zielgruppen-gerechte Schreiben, einheitliche Terminologie und konsistentes Layout, die zu den "Basics" einer guten Bedienungsanleitung gehören.

Die Handbuch Experten – Ihr Dienstleister für Technische Dokumentation

Die Technische Redaktion der Handbuch Experten beschreibt für verschiedenste Produkte die Installation und Inbetriebnahme, Benutzung und Bedienung, Inspektion und Wartung, Entsorgung – und was sonst noch Spezifisches für das jeweilige Produkt 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.

Wir bieten Ihnen an, Ihr Partner für Technische Dokumentation zu sein. Für uns ist Technische Dokumentation nicht nur eine nervige Aufgabe, die zur Produktherstellung dazu gehört, für uns ist Technische Dokumentation etwas, das wir mit Begeisterung erschaffen. Wir helfen Ihnen, die Zusammenhänge Ihres Produkts verständlich aufzuzeigen und Ihren Kunden, das Maximum aus Ihrem Produkt herauszuholen, so dass sie lange Freude daran haben.

Dabei lassen wir unsere Jahrzehnte-lange Erfahrung einfließen, durch die wir die Bearbeitung von Technischen Dokumentationsprojekten systematisiert haben.

Die entscheidende Frage, die Sie sich stellen sollten lautet: "Möchte ich die Technische Dokumentation 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 sowohl für die EU, als auch spezifisch für die USA
  • Seminare und Workshops, um Ihren Mitarbeitern Grundlagen der Technischen Redaktion oder spezifische Anforderungen aus Normen und Richtlinien für die Technische Dokumentation an die Hand zu geben

Im zweiten Fall übernehmen wir die Erstellung der Technischen Dokumentation komplett:

  • Analyse Ihrer bestehenden Dokumente
  • Konzeption der Technischen Dokumentation
  • Schreiben der Benutzerinformation
  • Automatisierung
  • Übersetzung
  • Erstellung von Schulungsunterlagen

Außerdem bieten wir zur internen Dokumentation mit unserem Service compliance.gmbh folgendes an:

  • Beratung zur CE-Kennzeichnung
  • Recherche zu den Marktanforderungen
  • Verwaltung der Dokumente
  • CE-Dossier
    Sie möchten Ihre Technische Dokumentation entscheidend voranbringen?

    Gerne setzen wir unsere Erfahrung und unser Wissen für Sie, Ihre Dokumentationsprozesse und Ihre Produkte ein.

    Angebot noch heute anfordern
    oder unter +49 9126 2611-15 beraten lassen