Was ist Technische Dokumentation?

Hier erfahren Sie alles rund um das Thema technische Dokumentation

Technische Dokumentation

Die technische Dokumentation ist ein sehr vielseitiges und komplexes Thema, das hohe Anforderungen an einen technischen Redakteur stellt. Unternehmen, die keinen technischen Redakteur haben, sollten auf jeden Fall einen engagierten Dienstleister zu Rate ziehen.

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.

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.

Unsere Leistungen

Doku-Erstellung

Wir erstellen die verschiedensten Arten von Anleitungen, Datenblättern und vielem mehr. Weitere Dokumente auf Anfrage.

Doku-
Check

Mit dem Doku-Check überprüfen unsere Experten anhand geltender Normen- und Richtlinien bestehende Dokumente.

Technische Illustration

Durch Verabreitung der CAD-Daten erstellen wir einfache sowie umfangreiche Illustrationen.

Technische Übersetzung

Wir übersetzen nach DIN EN ISO 17100 ihre Dokumente. Dabei setzen wir nur fachbezogene Übersetzer ein.

5 Facts für eine gute Technische Dokumentation

Durch festgelegte Workflows sowie unserer Fachexpertise liefern wir Ihnen nach dem 4-Augen-Prinzip rechtsichere Technische Dokumentationen.

Die Dokumentation orientiert sich am Nutzungsverhalten und der Erwartungshaltung der Anwender. Durch klar Handlungsanweisungen, Querverweise, multimediale Inhalte sowie aussagekräftige Grafiken wird dies unterstützt.

Die kürzeren Produktentwicklungs- und -lebenszyklen sowie die weltweite unmittelbare Verfügbarkeit via Internet erfordern die kontinuierliche Aktualisierung einer Technischen Dokumentation.

Eine gute Technische Dokumentation ist die Verbindung zwischen Menschen und dem technischen Produkt bzw. der Maschine. Sie ist klar strukturiert und verständlich, so dass sich der Anwender schnell zurechtfindet.

Bei der Übersetzung achten wir auf landestypische und kulturelle Besonderheiten, damit das Produkt bzw. die Maschine international korrekt verstanden wird.

Doku-Erstellung

Produkt Anleitung 300x200

Produkt- und ziel­gruppen­­orientierte Dokumentation

Unverständliche technische Dokumentationen führen zu zahlreichen Problemen. Denn was nutzen die besten Funktionen und die beste Technik, wenn der Anwender gar nicht erfährt, dass es sie überhaupt gibt oder wie man sie richtig verwendet? Die Folge sind unzufriedene Kunden und Absatzrückgänge. Um Sie davor zu bewahren, machen wir uns zunächst ein Bild von der Zielgruppe Ihres Produktes. Wenn wir technische Dokumentationen erstellen, orientieren wir uns immer an den Anwendern mit den geringsten Kenntnissen.

Dokumentenart

Branchen

Was ist bei der Erstellung einer haftungssicheren technischen Dokumentation wichtig?

  1. Der Redakteur arbeitet mit dem Konstrukteur der Maschine frühzeitig zusammen, da der Konstrukteur unter anderem für die Vermeidung von Risiken verantwortlich ist.
  2. Konzeption der Betriebsanleitung nach z. B. Maschinenrichtlinie oder EMV-Richtlinie.
  3. Risikobeurteilung der Maschine oder Anlage sowie Umsetzung der festgelegten Sicherheitskonzepte.
  4. Erstellung und Weitergabe der Konstruktions- und CAD-Daten an die technische Redaktion zum Erstellen der Betriebsanleitung.
  5. Datensammlung und Einbindung vorhandener Textmodule, wie z. B. Sicherheitshinweise zur Erstellung der Betriebsanleitung.
  6. Erstellen der Betriebsanleitung in einem Programm wie Word, InDesign, FrameMaker oder einem Redaktionssystem.
  7. Überarbeitung oder Anpassung von vorhandenen Texten oder Grafiken in der „haftungssichere technische Dokumentation / Betriebsanleitung erstellen“.
  8. Zusammenfügen und Fertigstellen der Originalbetriebsanleitung („haftungssichere technische Dokumentation / Betriebsanleitung erstellen“).
  9. Korrekturlauf und Qualitätskontrolle der Originalbetriebsanleitung.
  10. Übersetzung mit einem Translation Memory System in die festgelegten Zielsprachen.
  11. Layout und Fertigstellung der haftungssicheren technischen Dokumentation bzw. der Betriebsanleitung.
  12. Qualitätskontrolle der Betriebsanleitung.
  13. Druck und Auslieferung der haftungssicheren technischen Dokumentation bzw. Betriebsanleitung an den Kunden zusammen mit der Maschine oder Anlage.
  1. Wenn kundenindividuelle Änderungen in letzter Minute erfolgen, manchmal sogar erst während der Montage und Inbetriebnahme beim Kunden.
  2. Kurzfristige Änderungen und Ergänzungen müssen nachträglich aufwendig (wie CAD-Daten, Ersatzteillisten und Schaltpläne) eingearbeitet werden, damit der Stand der technische Dokumentation dem Stand der ausgelieferten Maschine / Anlage entspricht.
  3. Wenn es verschiedene Zielgruppen (Kunde / Bediener / Wartung / Installation / Montage / Schulung) für das Thema „haftungssichere technische Dokumentation / Betriebsanleitung erstellen“ gibt.
  4. Wenn die Risikobeurteilung erst nach der Konstruktion und Fertigung der Maschine erstellt wird.
  5. Wenn unklar ist, welche Inhalte in die haftungssichere Betriebsanleitung gehören.
  6. Wenn unklar ist, in welches Land die Maschine transportiert wird bzw. welche Normen, Gesetze und Richtlinien dort beachtet werden müssen.
  7. Wenn unklar ist, ob eine CE-Kennzeichnung notwendig ist.
  1. Zusammentragen aller Informationen in der zu Projektbeginn und Erstellung eines Zeitplanes.
  2. Wenn bereits Informationen feststehen, können diese in in der verwendeten Software vorab angelegt und vorbereitet werden.
  3. Es werden Meilensteine festgelegt, an denen alle Informationen zur Verfügung stehen müssen und nach denen keine Änderungen an der Maschine mehr durchgeführt werden.
  4. In der Projektplanung wird die Zeit für die Übersetzung und für Korrekturläufe mit eingeplant.
  5. Wenn die Maschine weitgehend einen endgültigen Stand hat, wird die haftungssichere technische Dokumentation  fertiggestellt.
  6. Eine kontinuierlicher Austausch mit den Projektmitarbeitern erleichtert und beschleunigt die Fertigstellung der haftungssicheren Betriebsanleitung.
  7. Falls notwendig kann eine vorläufige haftungssichere technische Dokumentation – Betriebsanleitung mit ausgeliefert werden, falls noch Änderungen bei der Montage beim Kunden nötig sind. Die nachträglichen Änderungen werden dokumentiert, eingearbeitet und dem Kunden in aktualisierter Form übergeben.
  8. Zusammenarbeit mit einem Dienstleister zur Erstellung und Fertigstellung der haftungssicheren technische Dokumentation – Betriebsanleitung nach aktuellen Normen und Richtlinien.
  9. Fertigstellung der Übersetzung in Abstimmung mit dem Übersetzungsdienstleister.
  10. Ein redaktioneller Leitfaden erhöht die Qualität und reduziert Rückfragen, Korrekturen und vereinheitlicht die Struktur der technischen Dokumentation.
  11. Das Lektorat extern durchführen lassen, da die Kapazitäten intern oft nicht gegeben sind. Durch ein externes Lektorat wird zudem der Betriebsblindheit vorgebeugt und eine hohe Qualität gewährleistet.
Richten Sie technische Dokumentationen ausschließlich an Fachpersonal, brauchen Informationen, die für diese Zielgruppe selbst­verständlich sind, nicht in der Dokumentation enthalten sein.

FAQ

Bei Projektstart sollten Informationen wie z. B.: Ablauf- und Funktionsbeschreibung, Risikobeurteilung, CAD-Daten, CI-Angaben, Pflichten- und Lastenheft (falls vorhanden) vorliegen.

  • Die Entscheidung hinsichtlich welcher Norm für die Technische Dokumentation zu wählen ist, hängt in erster Linie davon ab, was der jeweilige Hersteller produziert. Ein Hersteller von Haushaltsgeräten interessiert sich für die DIN EN ISO 20607 nur bedingt. Seine Geräte fallen häufig unter die Niederspannungsrichtlinie und unter dieser ist die DIN EN ISO 20607 nicht harmonisiert. Dieser Hersteller sollte sich daher mit der Dokumentationsnorm IEC/IEEE 82079-1 befassen, damit seine Technische Dokumentation dem Stand der Technik entspricht.
  • Für einen Hersteller von Produkten, welche unter die Maschinenrichtlinie fallen, ist die DIN EN ISO 20607 wesentlich interessanter. Die DIN EN ISO 20607 ist eine harmonisierte Norm für die Maschinenrichtlinie und kann eine Konformitätsvermutung auslösen. Aufgrund dieser Bedeutung werden Hersteller und deren Betriebsanleitungen an den Vorgaben der Norm gemessen. Ein Verstoß gegen die Norm wirkt sich nachteilig für den Hersteller aus.
  • Um den Stand der Technik vollständig zu entsprechen, muss jedoch auch Maschinenbauer die IEC/IEEE 82079-1 umsetzen. Denn diese Norm behandelt die Themen Informationsmanagement und Informationserstellung umfassender als die DIN EN ISO 20607.

Die Informationen in der Technischen Dokumentation und an der Maschine müssen wichtige Hinweise zum Gebrauch des Produktes liefern. Auf dem Typenschild sind unter Umständen Angaben zu Betriebsmitteln zu finden, die Aufschluss über Menge und Klassifizierung des Betriebsmittels geben. Sollten im Falle von Reparaturen Ergänzungen oder ein Austausch dieser Betriebsmittel nötig sein und die Spezifikationen der Betriebsmittel haben sich geändert, so gilt es die geänderten Sachinformationen auf dem Typenschild zu aktualisieren. Dies ist wichtig, damit die Informationen den aktuellen Stand wiedergeben. Hierfür kann man die Ergänzung beispielsweise handschriftlich auf einem Aufkleber eintragen. Der Stift sollte dazu aber die Dauer der Lesbarkeit der handschriftlichen Ergänzung sicherstellen.

Die Technische Dokumentation muss vor dem Inverkehrbringen des Produktes abgeschlossen sein. Daher ist es sinnvoll die Technische Redaktion frühzeitig im Konstruktionsprozess mit einzubinden. Spätestens dann, wenn das Lastenheft für das Produkt vorliegt. Aus den Anforderungen an das Produkt im Lastenheft kann der Technische Redakteur viele Informationen gewinnen und mit der groben Gliederung der Technischen Dokumentation beginnen.

Die Aufteilung der Technischen Dokumentation und auch der Betriebsanleitung in einzelne Dokumente ist durchaus sinnvoll und auch häufig gängige Praxis. Falls verschiedene Inhalte für unterschiedliche Zielgruppe vorgesehen sind, ist es übersichtlicher diese jeweiligen Inhalte in getrennten Dokumenten aufzuführen. Die Aufteilung verdeutlicht, dass die Dokumententeile für unterschiedliche Benutzer mit bestimmten Qualifikationen bestimmt sind. Ebenfalls bleibt eine komplexe und umfangreiche Dokumentation durch eine Aufteilung übersichtlich. Beispielsweise könnte der Teil des Einrichtens der Maschine ein eigenständiges Dokument sein und ist trotzdem ein Bestandteil der gesamten Betriebsanleitung. Der Ersteller der Dokumentation muss dabei darauf achten, dass der Zusammenhang der Einzeldokumente klar erkennbar ist.

Doku-Check

Dokumentenprüfung

360°-Überprüfung ihrer Betriebsanleitung

Sie wünschen eine umfassende und unabhängige Prüfung dokumentationsrelevanter Unterlagen? Wir nehmen Ihre Bedienungsanleitungen und Dokumente unter die Lupe und machen sie hieb- und stichfest. Außerdem helfen wir mit Tipps, Handlungshilfen und Vorlagen, den Doku-Prozess zu vereinfachen und zu beschleunigen

Unser Doku-Check ist die unabhängige Prüfung ihrer Betriebsanleitung oder vergleichbarer Dokumente auf der Basis von Richtlinien, Normen und anderer Grundlagendokumente – und langjähriger, praxisorientierter Erfahrung. Nachfolgend zeigen nach welchen Kriterien wir prüfen und wie dabei die Vorgehensweise ist.

Was wird im kostenlosen Doku-Check überprüft?

  • Usability
  • Gliederung & Aufbau
  • Corporate Design
  • Übersetzungsgerecht erstellt
  • Zielgruppen
  • Risikobeurteilung
  • Restrisiko
  • CE-Konformitätserklärung
  • Aufbau (SAFE-Standard)
  • Struktur
  • Farbe
  • Piktogramm
  • Signalwort
  • Text
  • Anwendung welcher Norm (DIN, ANSI)
  • Anwendung der Normen, wie z. B. Maschinenrichtlinie, EMV-Richtlinie uvm.
  • Anwendung produktspezifischer Normen und Richtlinien
  • Darstellung
  • Aufbau
  • Struktur
  • Anzahl an Abbildungen
  • Erkennbarkeit der beschriebenen Bauteile
  • Grammatik
  • Rechtschreibung
  • Füllwörter
  • Ansprache
  • Einheitliche Terminologie
Template 021 1024x1024

Jetzt kostenloses Checklisten-Bundle anfordern!

Mit diesen Checklisten haben wir unsere Arbeitsweise standardisiert und die Sicherheit für Anwender und Hersteller um ein vielfaches gesteigert.

Technische Illustration

Turbo Blower 1545281 1920 300x300

Dass ein Bild mehr als tausend Worte sagt, trifft besonders auf die Vermittlung technischer Inhalte zu. Neben einer korrekten Darstellung von Geräten und Anlagen ist die didaktisch sinnvolle Visualisierung von Funktionen und Handlungsabläufen ein unverzichtbares Mittel für die technische Dokumentation.

Unsere Mitarbeiter sind sich dieser Anforderung bewusst, haben bereits unzählige Grafiken für weltweit erfolgreiche Anlagen, Maschinen und Produkte erstellt und wissen, was zu tun ist!

Komplexe Technik aufs Wesentliche reduziert​

Die Basis einer verständlichen Dokumentation sind übersichtliche Zeichnungen. Hier finden Sie eine Auswahl von Technischen Illustrationen, die wir für Sie fachgebietsübergreifend erstellen:

FAQ

Eine Technische Dokumentation beinhaltet unterschiedliche Abbildungen wie Fotografien von Bauteilen oder von Maschinen, aber auch 3D-Abbildungen oder Schemazeichnungen. Schnittansichten und Explosionsdarstellungen eignen sich für die Darstellung von komplexen Sachverhalten. Schemazeichnungen oder auch Strichzeichnungen bieten sich an, da diese Informationen einfacher darstellen können als reale Fotos. Eine Illustration lässt sich zudem leicht verändern, um bestimmte Details im Bild hervorzuheben.

Von einem Redaktionsleitfaden in der Technischen Dokumentation können mehrere Beteiligten profitieren. Das können neben den Technischen Redakteuren auch Konstrukteure, Entwickler oder externe Dienstleister sein. Grafiker und Illustratoren, die neben den Redakteuren separat arbeiten, zählen ebenfalls dazu. Aber auch andere Abteilungen wie Marketing, technischer Kundendienst oder die Unternehmensleitung können von einem Redaktionsleitfaden in der Technischen Dokumentation profitieren. Neue Mitarbeiter in den Abteilungen profitieren von dem Redaktionsleitfaden als ein Hilfsmittel zur Einarbeitung in die organisatorischen und arbeitstechnischen Prozesse.

Jetzt Termin vereinbaren

Technische Übersetzung & Lokalisierung

übersetzung

Übersetzungen – Verständlich für jeden

Als Dienstleister im Bereich der technischen Dokumentation betreuen wir unsere Kunden aus den Bereichen des Sonder-/Maschinenbaus, der Medizintechnik und der Konsumgüter in allen Belangen rund um die Übersetzung Ihrer Technischen Dokumentationen. Wenn Ihre Dokumentationen in einem Redaktionssystem verwaltet werden, führen wir die Übersetzungsprozesse im Redaktionssystems durch. Auch für nicht in einem Redaktionssystem gepflegte Dokumente übernehmen wir die Übersetzung.

Full-Serivce

Erstellung, Übersetzung und Lokalisierung Ihrer Technischen Dokumentation in die jeweilige Sprache durch einen zertifizierten Muttersprachler.

Stand der Technik

Verwendung modernster Softwaretools, Machine Translation, Translation-Memory- und Terminologiemanagement-Systemen.

Volle Transparenz

Kostensensitiv durch Verwendung bereits übersetzter Inhalte, praxiserprobten Workflows und unserem Knowhow.

Übersetzungs-management

Wir arbeiten dabei mit einem zertifizierten Übersetzungsdienstleister zusammen. Professionelle Übersetzungsdienstleister setzen ein Translation-Memory-System (TMS) ein. Das TMS verwaltet die Terminologie und erkennt bereits übersetzte Sätze. Die Übersetzung der vorhandenen Sätze ist nicht notwendig, weil die Übersetzung in einer Datenbank liegt und wiederverwendet wird. Damit ist sichergestellt, dass gleiche Sätze immer gleich übersetzt werden. Das TMS ist also ein Beitrag der Übersetzung zur Qualitätssicherung Ihrer Dokumente.

Mit einer bloßen Wort-für-Wort-Übersetzung ist es nicht getan, vielmehr ist auch eine Anpassung an die Normen und Gesetze unterschiedlicher Märkte ebenso zwingend erforderlich wie eine zielgruppengerechte Sprache, damit die Informationen auch beim Benutzer ankommen.

Übersetzungsprozess

Die Terminologiearbeit ist schon bei der Erstellung der Technischen Dokumentation sehr wichtig. Während des Erstellungsprozesses übernehmen wir die Optimierung Ihrer Terminologie. Damit ist die Qualität des Textes in der Quellsprache sichergestellt. Die Zielsprache werden wir mit unseren zertifizierten Übersetzern in den Zielländern abstimmen. Das TMS sichert die übersetzten Wörter und Sätze. Wir erleichtern den Übersetzern ihre Aufgaben und senken Übersetzungskosten.

FAQ

Es ist für den Hersteller einer Maschine nicht möglich seine Haftung auf die Technische Übersetzung seiner Betriebsanleitung auszuschließen. Der Hersteller muss die Übersetzung seiner Anleitung auf Fehler überprüfen. Tut er das nicht und es verletzten sich Personen aufgrund einer fehlerhaften Anleitung, haftet der Hersteller für den Schaden. Ist die Anleitung mangelhaft, unvollständig oder unleserlich, gilt das Produkt im juristischen Sinne als Sachmangel. Dies gilt auch für eine mangelhafte Technische Übersetzung der Betriebsanleitung. Die Verständlichkeit einer jeden Betriebsanleitung für Maschine ist zudem eine elementare Anforderung aus der Maschinenrichtlinie, welche die Hersteller einhalten müssen.

  • Nein, dies ist rechtlich nicht möglich. Die Maschinenrichtlinie fordert, dass die Betriebsanleitung in der Amtssprache des Landes verfasst ist, in der das Produkt in Verkehr ging. Zudem muss die Betriebsanleitung im Original vorliegen oder als Übersetzung gemeinsam mit dem Original. Beide müssen entsprechend gekennzeichnet sein.
  • Weiterhin fordert auch das Produktsicherheitsgesetzt nach §3 Absatz 4 folgendes:
  • „Sind bei der Verwendung, Ergänzung oder Instandhaltung eines Produkts bestimmte Regeln zu beachten, um den Schutz von Sicherheit und Gesundheit zu gewährleisten, ist bei der Bereitstellung auf dem Markt hierfür eine Gebrauchsanleitung in deutscher Sprache mitzuliefern, sofern in den Rechtsverordnungen nach § 8 keine anderen Regelungen vorgesehen sind.“
  • Eine Betriebsanleitung für eine Maschine darf im deutschen Markt also nicht nur in englischer Sprache vorliegen.
  • Die Technische Übersetzung einer umfangreichen Betriebsanleitung kann schon mal recht kostspielig sein. Die Kosten dafür müssen Sie nicht allein tragen. Es ist ratsam, die Kosten für die Übersetzung schon in der Kalkulation für den Verkaufswert der Maschine einzurechnen.
  • Eine nachträgliche Berechnung der Übersetzungskosten ist möglicherweise nicht mehr möglich. Durch die EU-Maschinenrichtlinie ist ein Hersteller dazu verpflichtet die Betriebsanleitung in der Amtssprache des Verwenderlandes vorzulegen. Ist nun das Verwendungsland beim Verkauf der Maschine vertraglich bereits festgelegt, kann der Kunde natürlich auf die Lieferung der übersetzten Anleitung beharren, ohne dass er dafür zusätzliche Kosten tragen muss. Die Betriebsanleitung ist laut EU-Recht schließlich ein Teil der Maschine und somit im Kaufpreis der Maschine enthalten.

Es ist ratsam eine Technische Übersetzung für die Oberfläche der Benutzersoftware in die Amtssprache des Verwenderlandes zu erstellen. Dies ist sogar eine Forderung aus den Rechtsvorschriften der EU. Beispielsweise fordert die Maschinenrichtlinie, dass Informationen und Warnhinweise an der Maschine in den Amtssprachen der Gemeinschaft abgefasst sind. Zu den Informationen an der Maschine zählt auch die Oberfläche der Benutzersoftware. Auch haben viele Länder in Ihren Produktgesetzen festgeschrieben, dass die Benutzerinformationen in einer für Benutzer verständlichen Sprache übersetzt sein müssen.

Es gibt keine Forderung in der Maschinenrichtlinie, welche die Übersetzung des Typenschildes einer Maschine fordert. Jedoch sind alle für die Sicherheit relevanten Informationen und Warnhinweise in die jeweilige Amtssprache des Verwenderlandes zu übersetzen. Viele Kunden möchten aber trotzdem eine Technische Übersetzung des Typenschildes, beispielsweise in die englische Sprache.

Jetzt Kontakt aufnehmen

Manuel Schneider
Geschäftsinhaber

Tel.: +49 7136 / 2973910
E-Mail: info@schneiderdokumentation.de