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 ist …

  • Technische Erzeugnisse beschreibend
  • Systematisch aufbereitet
  • Strukturierter Inhalt
  • Zweckbestimmt
  • Vollständig
  • Immer verfügbar

Wenn ein Produkt mit der CE-Kennzeichnung versehen wird, wird von Rechtswegen her eine Technische Dokumentation gefordert. Die CE-Kennzeichnung ist dabei keine Kür, sondern 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 der Hersteller als finalen Schritt der Produtkherstellung, dass er die geforderten Schutzmaßnahmen für die Produktsicherheit umgesetzt und dokumentiert hat. Dabei können auch Normen helfen, die Lösungen zur Risikominimierung konkret nennen oder Anforderungen an die Produktdokumentation stellen.

Die Behörden dürfen jederzeit die 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, ob der Hersteller haftbar gemacht werden kann wegen eines Produkt- oder Instruktionsfehlers.

Was ist Technische Dokumentation?

Der Begriff "Technische Dokumentation" wird häufig synonym für Anleitungen genutzt. Dieser Teil der Technischen Dokumentation ist der externe Teil. Dazu gehört jegliche Benutzerinformation, oder auch Nutzungsinformation, wie jetzt in der Überarbeitung der DIN EN 82079-1:2021 herausgegeben. Hier geht es um Betriebsanleitung, Bedienungsanleitung und noch einiges mehr.

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, Marktforschungsdaten und der Suche nach rechtlichen Anforderungen und Gesetzen, die auf das Produkt zutreffen könnten. Die Dokumentation legt hieb- und stichfest dar, wie das Produkt so entwickelt und hergestellt wurde, dass es sicher ist – und nötigenfalls werden Warnungen am Produkt oder den Begleitdokumenten (= externe Dokumentation) wie Verpackung oder Betriebsanleitungen ausgesprochen, um den Produktnutzer und seine Umwelt nicht unnötig in Gefahr zu bringen.

Technische Dokumentation wird nicht nur in interne und externe Doku unterschieden

Wie bei den Begrifflichkeiten bereits erwähnt gibt es interne und externe Informationen, die das Produkt beschreiben.

Je nachdem, wie die Entwicklung des Produkts abläuft, sind diese Technischen Dokumente systematisch erstellt oder vielleicht manchmal auch nur in den Köpfen der jeweiligen Mitarbeiter.

Wichtig für eine belastbare Technische Dokumentation ist, dass sie schriftlich oder anderweitig dokumentiert vorhanden ist und die Informationen zum Produkt, den ausgehenden Gefahren und ihrer Minderung schnell aufzufinden sind und geeignet dargestellt werden können.

Interne Technische Dokumentation

Zur internen Dokumentation (= die Dokumente, die beim Hersteller als Nachweis bleiben) gehören unter anderem:

  • 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

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

Externe Technische Dokumentation

Zur externen Dokumentation (= alles, was die Produktkäufer erhalten) zählen beispielsweise:

  • Bedienungsanleitung
  • Installationsanleitung
  • Montageanleitung
  • Fehlersuche
  • Hilfe
  • FAQs (häufig gestellte Fragen)
  • Tutorials
  • Kataloge

Dabei ist unerheblich, mit welchen Medien die Technische Dokumentation am Ende die Informationen liefert. Besonders bei der externen Technischen Dokumentation wandelt sich inzwischen das Nutzerverhalten und die Vorzüge. Häufig werden Videos, Tutorials oder Apps genutzt, um Produktfunktionen besser kennenzulernen, als rein in eine simple Anleitung zu schauen.

Am Ende ist es wichtig, dass Ihr Kunde genau weiß, was er mit Ihrem Produkt machen kann, wie er damit sicher, effektiv und effizient umgeht – und was er tunlichst unterlassen sollte. Ob das immer als geschriebener Text sein muss, lässt sich hinterfragen – aber auch die reinen grafischen Anleitungen 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 die Maschinen, die dann Antworten in Form von z. B. Chatbots geben.

Wer erstellt Technische Dokumentation?

macht es Sinn, wenigstens einen Teil der Technischen Dokumentation von denjenigen verantworten zu lassen, die das Produkt entwickeln. Genausooft haben jedoch Produktentwickler und Bisher gibt es keine gesetzlichen Forderungen dafür, wer Technische Dokumentation erstellt. Prinzipiell darf das also jeder. Häufig -konstrukteure weder die Zeit noch die Lust, viel zu Schreiben.

Das ist der Moment, in dem Technische Redakteure zum Einsatz kommen. Diese sind ausgebildet darin, verständliche Texte zu erstellen. Dafür müssen sie diverse Voraussetzungen kennen, die sie bereit sind, aus den Verantwortlichen herauszukitzeln. Außerdem müssen sie sich mit den passenden Werkzeugen daran machen, die Technische Dokumentation nicht nur zu erstellen, sondern auch zu versionieren, ggf. fehlende Informationen zu ergänzen oder auch falsche Aussagen anzupassen. Die Erstellung der Technischen Dokumentation aus möglichst wenig verschiedenen Quellen funktioniert besonders gut mit Redaktionssystemen.

Interne Dokumentation

Die interne Dokumentation können technische Redakteure durchaus helfen zu dokumentieren, das Wissen dazu liegt aber meist bei den Produktentwicklern. Das bedeutet, eine fruchtbare Zusammenarbeit hilft beiden Seiten: Die Redakteure können mit ihrer Systematik und ihrem Dokumentationsgeschick die Inhalte aus den Köpfen der Entwickler zu Papier bringen. Manchmal vielleicht 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.

Externe Dokumentation

Die externen Dokumente sollte auf jeden Fall ein Technischer Redakteur erstellen, denn diesem ist klar, dass Zielgruppen-gerechtes Schreiben, einheitliche Terminologie und konsistentes Layout zu den "Basics" gehören, die für eine gute Anleitung sorgen.

Unsere Technischen Redakteure beschreiben für verschiedenste Produkte die Installation und Inbetriebnahme, Benutzung und Bedienung, Inspektion und Wartung, Entsorgung – und was sonst 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.

Sie möchten mit einem geeigneten Partner über Ihr Projekt sprechen?

Lassen Sie uns unsere Expertise für Sie gewinnbringend einsetzen.

Jetzt Angebot anfodern
oder unter +49 9126 2611-10 beraten lassen

Was bringt Technische Dokumentation?

Technische Dokumentation hilft, das Produkt vollständig und umfassend zu beschreiben. Dabei ist besonders für die Nutzungsinformation wichtig, dass der Produktnutzer lernt, wie er mit dem Produkt umgeht. Damit das geschehen kann, braucht die Anleitung eine Sprache, die der Nutzer versteht. Und um die Dokumentation nicht in der Ecke verstauben zu lassen, braucht der Nutzer einen guten Einstieg, der durch eine geschickte Struktur erleichtert wird, so dass die Inhalte sofort gefunden werden, die gerade gesucht sind.

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 hingegen wird häufig beschrieben, weil die Zusammenhänge komplex sind und der Nutzer den gesamten Umfang der Software nicht intutitiv 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 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 weg gelegt und per Ausprobieren oder Nachfragen versucht, mit dem Produkt richtig umzugehen.

Was bieten die Handbuch Experten

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 Ihrem Kunden, das Maximum aus Ihrem Produkt herauszuholen, so dass er lange daran Freude hat.

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

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

Im ersten Fall können wir Ihnen anbieten, 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 redaktionelle Grundlagen oder spezifische Anforderungen aus Normen und Richtlinien für die Doku an die Hand zu geben

Im zweiten Fall können wir die Erstellung der Dokumentation komplett übernehmen:

  • Analyse Ihrer bestehenden Dokumente
  • Konzeption
  • Schreiben der Benutzerinformation
  • Bis hin zur Automatisierung
  • Übersetzung
  • Erstellung von Schulungsunterlagen

Außerdem bieten wir zur internen Dokumentation unter dem Brand compliance.gmbh an:

  • Beratung zur CE-Kennzeichnung
  • Recherche zu den Marktanforderungen
  • Verwaltung der Dokumente
  • CE-Dossier
Entscheidend für uns ist, dass Sie Ihre Technische Dokumentation voranbringen wollen – gerne setzen wir uns für Sie und Ihre Produkte ein.
Jetzt Angebot anfordern
oder unter +49 9126 2611-10 beraten lassen