Grundlagen der Technischen Dokumentation für Einsteiger

Unternehmen und Start-ups, die sich zum ersten Mal mit dem Thema Technische Dokumentation beschäftigen, können sich schnell überfordert fühlen, und haben wahrscheinlich viele Fragen:

• Was genau ist Technische Dokumentation eigentlich?
• Warum unterscheidet man zwischen interner und externer Dokumentation?
• Warum muss ich an verschiedene Zielgruppen denken?
• Was für rechtliche Anforderungen und Normen sind zu beachten?
• Was macht eigentlich ein technischer Redakteur?
• Welche Tools benötige ich?
• Und wie kann ich meine Technische Dokumentation übersetzen lassen?

Fragen über Fragen, die wir in diesem Artikel leicht verständlich für Sie beantworten. Mit diesem Grundwissen sind Sie für die nächsten Schritte gewappnet.

Was ist technische Dokumentation?

Technische Dokumentation (TD), auch Produktdokumentation genannt, bezeichnet alle Unterlagen zu technischen Geräten und Softwareprodukten. Diese Unterlagen, egal ob in Papierform oder im Onlineformat, beschreiben deren sichere Nutzung, Wartung oder Reparatur.

Technische Dokumentation ist immer zweckorientiert: Sie soll die jeweilige Zielgruppe, beispielsweise Bediener, Techniker oder Vertriebsingenieure, zum Handeln befähigen. Außerdem sichert sich der Hersteller haftungsrechtlich ab – und erfüllt mit der Produktdokumentation gleichzeitig alle gesetzlichen Anforderungen und Nachweispflichten.

Im Allgemeinen unterscheidet man zwischen interner und externer Technischer Dokumentation:

• Die interne Technische Dokumentation dient zur Archivierung aller produktrelevanten Unterlagen und verbleibt meist beim Hersteller, der sie bewahrt und aktualisiert. Dazu gehören u. a. Pflichtenhefte, Versuchsberichte, Risikobeurteilungen und technische Zeichnungen.

• Mit der externen Technischen Dokumentation werden Betreiber und Benutzer des Produkts informiert und angeleitet, beispielsweise über Montage-, Installations-, Benutzer- und Wartungsanleitungen.

An welche Zielgruppe richtet sich die technische Dokumentation?

„Wer ist meine Zielgruppe?“ lautet die wichtigste Frage, die Hersteller vor der Erstellung der Technischen Dokumentation beantworten müssen. Idealerweise sollte für jede Zielgruppe ein eigenes Dokument erstellt werden, statt einer 400-seitigen Megaanleitung für alle.

Überlegen Sie vorab, welche Handlungen über den gesamten Lebenszyklus des Geräts erforderlich sind und wer dafür zuständig ist. Tragen Sie alle Informationen in einer kurzen Übersicht zusammen. Listen Sie dabei für jede notwendige Handlung die zuständige Person auf. Wie das aussieht, haben wir hier am Beispiel einer CNC-Drehmaschine beschrieben:

• Planung: Herstellernahe Personen
• Transport: Transporteur
• Installation: Herstellernahe Personen
• Programmierung: CNC-Zerspaner, Programmierer
• Benutzung: CNC-Zerspaner
• Instandhaltung: CNC-Zerspaner
• Reparatur: CNC-Zerspaner, Servicetechniker
• Demontage…

In diesem Fall, den Dietrich Juhl in seinem Buch „Technische Dokumentation“^*1 beschreibt, benötigt der CNC-Zerspaner keine Informationen zum Transport und zur Installation der Maschine. Was für ihn jedoch relevant ist, sind Anweisungen zur Programmierung, Benutzung und Instandhaltung.

Demnach ergeben sich laut Juhl für die CNC-Maschine acht Anleitungen für die unterschiedlichen Zielgruppen ergeben:

• Planungsunterlage
• Transportanleitung
• Installations- und Inbetriebnahmeanleitung
• Betriebsanleitung
• Programmierhandbuch
• drei Serviceunterlagen (jeweils eine für Mechanik, Hydraulik und Elektrik)

Welche Normen und rechtliche Anforderungen müssen Sie beachten?

Die Sicherheit liegt dem Gesetzgeber am Herzen. Zum einen müssen Produkte sicher konstruiert sein und dürfen keine Gefahr für Personen darstellen. Wenn sich Risiken zum anderen nicht ausschließen lassen, müssen Hersteller Hinweise und Warnungen für eine sichere Nutzung geben.

Aus diesem Grund unterliegt die Technische Dokumentation einer großen Bandbreite an Normen und rechtlichen Anforderungen, die wir nachfolgend ausgewählt vorstellen:

• Die DIN EN 82079-1 ist eine Norm für die Erstellung von Gebrauchsanweisungen, die u. a. die Qualität der Kommunikation, die Risikominimierung sowie den Inhalt und die Gestaltung von Gebrauchsanweisungen beschreibt. Kostenlose Checklisten helfen bei der Einhaltung. Diese Norm gehört zur Grundausstattung jedes technischen Redakteurs.
• Die Maschinenrichtline 2006/42/EG verpflichtet Hersteller zur Bereitstellung einer Betriebsanleitung in Herstellersprache und ggf. als Übersetzung, die den Wissensstand und die Verständnisfähigkeit der Benutzer berücksichtigt.
• Die VDI-Richtlinie 4500 regelt verschiedene Aspekte der Technischen Dokumentation, von den Begriffen über die Organisation und Verwaltung bis zur Planung, Gestaltung und Erstellung der Unterlagen.
• Die Norm DIN EN ISO 7010 regelt einen einheitlichen Standard für die Sicherheitskennzeichnung weg von Textschildern hin zu sprachunabhängigen und universell verständlichen Sicherheitskennzeichnungen.
• Die ANSI Z535 ist die US-amerikanische Norm für Sicherheitshinweise. Sie ist nicht für Produkte relevant, die in Europa auf den Markt gebracht werden, aber für Hersteller interessant, die ihre Geräte und Maschinen in die USA exportieren.
• Das Produktsicherheitsgesetz (ProdSG) ist die Umsetzung der EU-Richtlinie 2001/95/EG und damit das wichtigste Regelwerk in Deutschland für die Bereitstellung von Produkten.

Daneben gelten weitere Richtlinien für verschiedene Produktgruppen, wie das Medizinproduktegesetz (MPG) oder die Niederspannungsrichtlinie (2006/95/EG). Zudem gelten für verschiedene Regionen, wie für die EU und die USA unterschiedliche Anforderungen.

Welche Rolle spielt der technische Redakteur?

Die Erstellung der Technischen Dokumentation gehört nicht zum Aufgabenbereich des Ingenieurs, wie manche vielleicht vermuten, sondern ist Sache des Technischen Redakteurs (TR). Er benötigt die Fähigkeit, komplexe Sachverhalte und Funktionen einfach und für die jeweilige Zielgruppe zu erklären und steht häufig im direkten Austausch mit dem Entwicklungsteam des Herstellers.

Technische Dokumentationen sind jedoch keine Marketingbroschüren oder Werbetexte – sondern unterschiedliche Disziplinen. Für die Erstellung von verkaufsfördernden Produkttexten, Hochglanzbroschüren und Flyern sind weitere Fertigkeiten gefragt.

Technische Redakteure, die auch im Copywriting versiert sind, können beide Aufgabenbereiche übernehmen. Wenn das nicht der Fall ist, sollten Technische Redakteure und Copywriter gemeinsam an einem Projekt arbeiten:

• Der Technische Redakteur stellt sicher, dass alle technischen Fakten korrekt sind und
• der Copywriter schreibt verkaufsstarke und attraktive Texte.  

Weitere Vorteile der Zusammenarbeit zwischen dem Technischen Redakteur und Textern finden Sie in unserem Artikel Der Technische Redakteur im Marketing-Mix.

Welche Software und Tools benötigen Sie für Ihre technische Dokumentation?

Die Verwaltung Ihrer Technischen Dokumentation kann eine Herausforderung sein. Hersteller müssen jede Funktionsänderung genau dokumentieren und sicherstellen, dass diese Änderungen in allen externen Unterlagen aktualisiert werden. Wir bei Lexsys raten daher von der Verwaltung Ihrer Technischen Dokumentation in Microsoft Word oder anderen Textverarbeitungsprogrammen ab.

Wie gut eignen sich Component-Content-Management-Systeme für die Technische Dokumentation?

In den vergangenen Jahren haben Content-Management-Systeme (CMS) an Popularität gewonnen, da sie das Erstellen, Pflegen und Veröffentlichen von TD erleichtern. Noch interessanter für Hersteller sind jedoch Component-Content-Management-Systeme (CCMS), die nicht ganze Dokumente, sondern Informationsbausteine abspeichern.

Das kann zum Beispiel eine Abbildung, eine Tabelle, eine Produktbeschreibung oder ein Prozess sein. Ein Informationsbaustein kann dabei so kurz sein wie ein einzelnes Wort oder so umfangreich wie ein ganzes Dokument.

Die Grundlage solcher Component-Content-Management-Systeme sind verschiedene Dokumentformate wie DITA, eine XML-basierte Architektur für die Erstellung, Verteilung und Wiederverwendung von technischen Informationen.

Wie übersetze ich eine technische Dokumentation?

Unternehmen, die ihre Produkte auch im Ausland vertreiben wollen, benötigen eine Übersetzung ihrer technischen Kommunikation für das jeweilige Zielland. Laut der tekom, der Gesellschaft für Technische Kommunikation, werden fast die Hälfte aller technischen Dokumentationen in mehr als zehn Sprachen übersetzt.

Da nur noch sehr wenige Hersteller firmeneigene Übersetzer und Lokalisierungsteams beschäftigen, beauftragen viele Unternehmen externe Übersetzungsagenturen. Das bringt für Hersteller viele Vorteile mit sich, denn Agenturen …

• übernehmen das gesamte Projektmanagement,
• arbeiten mit einem Pool an hoch qualifizierten Fachübersetzern zusammen,
• bieten dank ISO-Zertifizierung eine hervorragende Qualitätssicherung und
• bringen branchenspezifisches Know-how mit.

Eine professionelle Übersetzungsagentur kann Hersteller zu allen Fragen der Übersetzung von Technischer Dokumentation bis hin zu den Vor- und Nachteilen der maschinellen Übersetzung und dem Maschine Translation Post-Editing, der manuellen Prüfung maschinell übersetzter Texte durch Profis, beraten.

Da der Übersetzungsmarkt unreguliert und unübersichtlich ist, sollten Hersteller verschiedene Anbieter gründlich prüfen, bevor Sie sich für die Zusammenarbeit mit einem vertrauenswürdigen Übersetzungsdienstleister entscheiden.

Diese zeichnen sich beispielsweise durch folgende Qualitätskriterien aus …

• eine Zertifizierung nach ISO 9001,
• positives Kundenfeedback,
• transparente Prozesse und Preise und
• eine Zusammenarbeit mit muttersprachlichen und professionellen Übersetzern.

Wo finden Sie nützliche Ressourcen?

Möchten Sie noch mehr zum Thema Technische Dokumentation erfahren? Hier finden Sie weitere nützliche Informationen:

• VDI-Richtlinien: Hier können Sie Publikationen der verschiedenen Richtlinien erwerben.
• tekom: auf der Website des weltweit größten Fach- und Berufsverbands für Technische Informationen finden Sie Infos auf Deutsch zu Fachkongressen, Branchenevents, Weiterbildungsmöglichkeiten und vieles mehr.
• ¹„Technische Dokumentation: Praktische Anleitungen und Beispiele“ von Dietrich Juhl, Springer Vieweg, 2015. Dieser Ratgeber richtet sich vor allem an technische Redakteure und liefert viele nützliche Tipps zur Erstellung verschiedener Anleitungen.

Lexsys: Ihr zuverlässiger Partner für Technische Dokumentation

Die Welt der Technischen Dokumentation kann für Hersteller von Geräten und Software überwältigend sein. Sie müssen …

• rechtliche Anforderungen und Normen einhalten,
• über ihre Zielgruppe nachdenken,
• einen technischen Redakteur mit der Erstellung der Inhalte beauftragen,
• den Content anschließend auch pflegen, verwalten und publizieren und
• eventuell sogar noch übersetzen.

Kein leichtes Unterfangen. Wir bei Lexsys begleiten Hersteller bereits seit vielen Jahren auf diesem Weg und beraten Sie gern in allen Angelegenheiten der Technischen Kommunikation – von den Kosten über die Software bis zur Erstellung und Übersetzung Ihrer Dokumentation.

Benötigen Sie Unterstützung bei Ihrer technischen Dokumentation? Kontaktieren Sie uns noch heute und vereinbaren Sie ein Beratungsgespräch.