Häufig gestellte Fragen – FAQ

Herzlich willkommen in unserem FAQ-Bereich!

Manche Fragen werden uns häufig gestellt. Hier beantworten wir sie.
Klicken Sie einfach auf die Frage, um die Antwort zu lesen.
Haben Sie eine andere Frage an uns? Dann nehmen Sie Kontakt auf. Wir sind gerne für Sie da.

Es gibt unzählige Normen und Richtlinien – Welche davon sind für die Technische Dokumentation relevant?

Unter anderem die EU gibt Richtlinien vor. Diese Richtlinien müssen dann von den Ländern in eigene Gesetze umgesetzt werden. So wurden beispielsweise die Forderungen aus der EU-Maschinenrichtlinie (EG-Maschinenrichtlinie 2006/42/EG) im Produktsicherheitsgesetz (ProdSG) in Deutschland umgesetzt.

Normen sollen vereinheitlichen und Standards schaffen – für Produkte, Verfahren, Dienstleistungen und Benennungen. Normen spiegeln den Stand der Technik wider, sie haben jedoch keinen gesetzgeberischen Charakter. Die wichtigste Norm für die Technische Dokumentation ist die DIN EN 82079-1, die vom Deutschen Institut für Normung (DIN) im Jahr 2013 herausgegeben wurde. In der Norm ist beschrieben, was es bei der „Erstellung von Gebrauchsanleitungen“ zu beachten gilt. Wichtige Aspekte der DIN EN 82079-1 sind die Strukturierung der Informationen sowie die Aufbereitung und Darstellung des Inhalts. Eine weitere für die Technische Dokumentation wichtige Norm ist die ANSI Z535.6, die die Erstellung und Darstellung von Warn- und Sicherheitshinweisen regelt.

Darüber hinaus gibt es Produktnormen, wie z. B. die IEC 60601-1-6 für medizinisch-elektrische Geräte, in denen sich auch Hinweise finden, die für die Technische Dokumentation relevant sind.

Technische Redakteurinnen und Technische Redakteure kennen sowohl die DIN EN 82079-1 als auch die ANSI Z535.6 aus dem Effeff. Dahingegen müssen sie die Produktnormen, die für einen Auftrag relevant sind, jedes Mal von Neuem in Erfahrung bringen.

Auch bei der Übersetzung spielen Normen eine Rolle. Besonders wichtig ist die DIN EN ISO 17100. Sie beschreibt wichtige Aspekte des Übersetzungsprozesses, erwähnt den Einsatz von Übersetzungstechnologien und Übersetzungstools, definiert aber auch, welche Qualifikation Übersetzerinnen und Übersetzer haben müssen.

Welche Dokumenttypen gehören zur Technischen Dokumentation? Wie unterscheiden sie sich?

In der Technischen Dokumentation gibt es unterschiedlichste Anleitungen. Folgende Dokumenttypen lassen sich unterscheiden: 

Anlagendokumentation: Enthält Informationen zu Aufbau, Funktion und Betrieb einer Anlage, die sich aus mehreren Einzelmaschinen oder Baugruppen zusammensetzt (z. B. eine Abfüllanlage oder Verpackungsanlage). 

Bedienungsanleitung: Befähigt den Anwender zur bestimmungsgemäßen Verwendung eines Konsumprodukts (z. B. eines Küchengeräts oder Fernsehers). 

Betriebsanleitung: Befähigt den Anwender zur bestimmungsgemäßen Verwendung einer Maschine (z. B. einer Etikettiermaschine oder eines Gabelstaplers). 

Datenblatt: Enthält ausschließlich Angaben zu den Technischen Daten eines Produkts. 

Deinstallationsanleitung: Befähigt den Anwender dazu, die Installation eines Produkts (z. B. einer Software) rückgängig zu machen bzw. das Produkt vollständig zu entfernen. 

Ersatzteilkatalog: Systematische Übersicht aller Ersatzteile eines Produkts, die die Recherche nach Ersatzteilen und Serviceinformationen über eine interaktive bildliche Darstellung ermöglicht. 

Gebrauchsanleitung: Sammelbezeichnung für alle Arten von Anleitungen, die nur in der Norm DIN EN 82079-1 verwendet wird. 

Gebrauchsanweisung: Befähigt den Anwender zur bestimmungsgemäßen Verwendung eines Medizinprodukts (z. B. eines Endoskops oder Ultraschall-Generators). 

Installationsanleitung: Befähigt den Anwender dazu, ein Produkt (z. B. eine Heizung, einen Drucker, eine Software) so einzubauen und/oder elektrisch anzuschließen, dass es bestimmungsgemäß verwendet werden kann. 

Kurzanleitung: Kurzfassung einer Anleitung, die in komprimierter Form die wichtigsten Funktionen oder Schritte zusammenfassend erklärt. 

Montageanleitung: Befähigt den Anwender dazu, ein Produkt (z. B. Selbstbaumöbel) so zusammenzubauen, dass es bestimmungsgemäß verwendet werden kann. 

Serviceanleitung: Befähigt autorisierte Servicetechniker dazu, Servicearbeiten an einer Maschine, einer Anlage, an einem Medizinprodukt oder Konsumprodukt durchzuführen. 

Sofortanleitung: Anleitung zu einer Tätigkeit, die nur einmal direkt ausgeführt wird (z. B. die Bedienung eines Feuerlöschers oder Parkscheinautomaten). 

Softwaredokumentation: Befähigt den Anwender zur Verwendung eines Computerprogramms, indem sie mit Grundfunktionen vertraut macht, Möglichkeiten aufzeigt und Abhängigkeiten erklärt. 

Transportanleitung: Befähigt den Anwender dazu, eine Maschine so zu transportieren, dass keine Personen- oder Sachschäden entstehen können. 

Wartungsanleitung: Befähigt eine Fachkraft dazu, Wartungsarbeiten an einem Produkt durchzuführen (z. B. an einem Kühlschrank). 

Was ist der Vorteil von SVG-Grafiken in der mobilen Dokumentation?

Die Abkürzung SVG steht für Scalable Vector Graphics (skalierbare Vektorgrafiken). Eingebunden in eine HTML-Seite, können sich Grafiken im SVG-Format responsiv verhalten. Ob Smartphone, Tablet oder Browser, die SVG-Grafik passt sich an die Größe des Bildschirms an und nutzt den zur Verfügung stehenden Platz bestmöglich – und zwar ohne Qualitätsverlust. Außerdem lassen sich SVG-Grafiken animieren und sogar interaktiv gestalten. 

Was ist ein Redaktionsleitfaden?

Im Redaktionsleitfaden – auch Redaktionshandbuch oder Redaktionsrichtlinie genannt – stehen verbindliche Vorgaben für das Erstellen von Technischer Dokumentation. Beispiele veranschaulichen, wie das Ergebnis aussehen soll. Der Redaktionsleitfaden legt fest, wie Anleitungen strukturiert, gestaltet und formuliert sein sollen. Das betrifft so unterschiedliche Aspekte wie die Gliederung der Kapitel, die Leseransprache, den Stil, die Satzlänge, den Einsatz von Grafiken und sogar die Schreibweise einzelner Wörter. Teilweise ist auch der Prozess für die Erstellung vorgegeben und welche Programme eingesetzt werden müssen. Durch die verbindlichen Vorgaben und die damit verbundene Standardisierung können Technische Redakteure schneller arbeiten. Die Texte sind von einheitlicher Qualität und können eher wiederverwendet werden. Und Kosten spart es obendrein.

Welche Rolle spielt die Zielgruppenanalyse in der Technischen Dokumentation?

Zu jedem Produkt gehört eine Anleitung. Diese Anleitung soll den Nutzer in die Lage versetzen, das Produkt zweifelsfrei und sicher zu bedienen. Der Nutzer muss die Anleitung also verstehen können. Für Technische Redakteure ist es daher wichtig zu wissen, für wen sie eine Anleitung schreiben. Um das in Erfahrung zu bringen, muss eine Zielgruppenanalyse durchgeführt werden. Im besten Fall hat der Hersteller das schon während der Produktentwicklung erledigt. Wenn nicht, machen das die Technischen Redakteure eben selbst.

Es gibt unterschiedliche Verfahren, die Zielgruppe kennenzulernen, z. B. die Persona-Methode, die Erstellung einer Was-macht-Wer-Matrix, aber auch gezielte Befragungen, dauerhafte Beobachtungen und User Journeys sind geeignet. Mit all diesen Verfahren lässt sich herausfinden, wer das Produkt nutzt – und folglich die Anleitung benötigt. Wie alt ist ein typischer Nutzer? Erkundet er das Produkt eher explorativ oder bevorzugt er eine detaillierte Beschreibung? Welches Vorwissen, welche Erfahrung hat er? Wie viel Information benötigt er?

Erst wenn all diese Fragen beantwortet sind, fangen die Technischen Redakteure an, die Anleitung zu schreiben – zielgruppengerecht.

Wer übersetzt für ZINDEL?

Anleitungen werden von Fachübersetzerinnen und Fachübersetzern mit nachgewiesener Ausbildung und spezieller Qualifikation im technischen Bereich übersetzt. Und zwar ausschließlich in die Muttersprache.

Unsere Übersetzerinnen und Übersetzer sind wahre Spezialisten für die Beschreibung von technischen Sachverhalten in anderen Sprachen. Denn für eine technische Übersetzung ist eines entscheidend: Dass die Übersetzerin oder der Übersetzer den Ausgangstext bis ins Detail versteht.

Ob Elektrotechnik oder Mechanik, Pneumatik oder Hydraulik, Maschinen- oder Computersoftware, Physik oder Chemie: Wir haben für jeden Bereich die passende Übersetzerin bzw. den passenden Übersetzer. So gewährleisten wir höchste inhaltliche Qualität.

Setzt ZINDEL maschinelle Übersetzung ein?

Nein. Inhaltliche Richtigkeit und sprachliche Genauigkeit müssen garantiert sein. Das schafft keine maschinelle Übersetzung.

Ob Elektrotechnik oder Mechanik, Pneumatik oder Hydraulik, Maschinen- oder Computersoftware, Physik oder Chemie: Wir haben für jeden Bereich die passende Übersetzerin bzw. den passenden Übersetzer. So gewährleisten wir höchste inhaltliche Qualität.