Sie suchen auf: {{ keyword }}

Technische Dokumentation - Was man darüber wissen sollte

Was ist Technische Dokumentation?

Haben Sie schon mal eine komplexere Software installiert oder sich mit der Bedienung einer industriellen Maschine auseinandergesetzt?

Je nachdem, in welcher Branche Sie arbeiten, stehen die Chancen gut, dass Sie bei Ihrer Arbeit schon mal technischen Dokumentationen genutzt haben.

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 detailliert beschrieben.

Den Prozess, bei dem technische  Informationsprodukte von Fachleuten definiert, erstellt und bereitgestellt werden, bezeichnet man als Technische Kommunikation oder auch als Informationsentwicklung.

Ein besonderes Merkmal dieser Dokumentationsform ist die Anwendung von spezialisierter Fachsprache, die meist nur für Experten innerhalb eines bestimmten Fachgebietes verständlich ist. Oft werden komplexe Inhalte zusätzlich durch verschiedene Arten von Visualisierungen veranschaulicht.

 

Anwendungsgebiete von Technischer Dokumentation

Die Anwendungsgebiete von Technischer Dokumentation sind sehr vielseitig. Typische Beispiele für solche Dokumentationen sind:

  • Bedienungsanleitungen
  • Serviceanleitungen
  • Betriebsanleitungen
  • Reparaturanleitungen
  • Montageanleitungen
  • Wartungsanleitungen
  • Installationshandbücher
  • Datenblätter
  • Tutorials
  • Software-Handbücher
  • Online-Hilfen

In diesen Publikationen finden Nutzer alle relevanten Produktdefinitionen und  Produktspezifikationen, aber auch umfangreiche Informationen zur Konstruktion und Anwendungen sowie Instandhaltung und Reparatur. Weitere wichtige Angaben betreffen u.a. Bereiche wie die Produkthaftung oder auch die sachgemäße Entsorgung.

Dabei verfolgt die Technische Dokumentation immer ein klares Ziel: die relevanten produktspezifischen Informationen sollen für verschiedene Nutzergruppen nachvollziehbar präsentiert werden.

So müssen Installateure anhand einer Anleitung ablesen können, wie ein bestimmtes Produkt installiert und in Betrieb genommen wird. Auch ein Verkäufer greift auf entsprechende  Datenblätter und Anleitungen zurück, um Fragen von Kunden professionell beantworten zu können.

Es gibt heutzutage wahrscheinlich kaum ein Unternehmen, in dem Technische Dokumentation nicht in irgendeiner Form genutzt wird. Überall dort, wo Maschinen oder Software genutzt werden, liegen normalerweise auch entsprechende Gebrauchsanleitungen oder Handbücher vor.



Interne vs. externe Dokumentation

In der Technischen Dokumentation unterscheidet man normalerweise zwei Bereiche: die interne und die externe Technische Dokumentation.

Erstere wird meistens durch die entsprechende Entwicklungsabteilung eines Herstellers geführt und soll sicherstellen, dass alle internen produktrelevanten Dokumente angefangen von der Planung bis zur Entwicklung und Markteinführung eines Produktes lückenlos und gemäß der Vorschriften archiviert werden. Auf diese weise wird der gesamte  Produktlebenszyklus von den ersten Plänen, Entwürfen und Zeichnungen bis zur dokumentierten Risikobeurteilung, Versuchsberichten und dem anschließenden Vertrieb dokumentiert und ist später - zum Beispiel im Fall von Unfällen oder einem Rechtsstreit - nachvollziehbar. Das Ergebnis einer solchen Dokumentation ist ein Informationslebenszyklus.

Die externe Technische Dokumentation wiederum richtet sich an externe Nutzer, also die Personen, die das Produkt anwenden, installieren oder warten müssen. Die Sprache dieser Dokumentationen richtet sich meist gezielt an bestimmte Nutzergruppen.

 

Sprachliche Merkmale technischer Dokumentationen  

Die Sprache und Struktur Technischer Dokumentationen unterscheidet sich in vieler Hinsicht von Literatur oder journalistischen Texten, denn in puncto Verständlichkeit, Eindeutigkeit und Konsistenz müssen hohe Anforderungen erfüllt werden. Außerdem muss bereits bei der Erstellung eine gute Übersetzbarkeit der Texte gewährleistet sein, damit auch einer (späteren) internationalen Vermarktung nichts im Wege steht.

Der Wortschatz ist in der Regel hoch spezialisiert und richtet sich an bestimmte Zielgruppen, die diese Art von Sprache und Fachvokabular verstehen können. Die angewendete Sprache zeichnet sich auch durch eine Vielzahl von Regelungen aus, die durch stilistische und grammatikalische Einschränkungen auffällt. Damit die Funktionalität und Unmissverständlichkeit der Inhalte gewährleistet bleibt, entfallen all jene Stilelemente, die in der Schönliteratur oder im Journalismus genutzt werden, um die Sprache lebhafter oder packender zu gestalten.

 

Verbesserte Nutzerfreundlichkeit durch Tests

Damit die Nutzerfreundlichkeit bzw. Usability von Technischer Dokumentation optimiert werden kann, greifen Unternehmen teilweise auch auf Tests zurück. Dabei kann erprobt werden, ob ein Nutzer tatsächlich die Informationen bekommt, die er braucht, um Zugang zu einem Produkt und dessen Bedienung zu erlangen. In speziellen Usability Tests kann genau dies geprüft werden. Die Kenntnisse, die bei solchen Tests gewonnen werden, können dann gezielt für die Verbesserung der Nutzerfreundlichkeit genutzt werden, um reibungslose, sichere und ordnungsgemäße Arbeitsabläufe zu gewährleisten.

 

Visualisierungen in der Technischen Dokumentation

Mit zunehmendem technischem Fortschritt entwickeln sich nicht nur die technischen Innovationen, sondern auch ihre Dokumentation. Für die bessere Veranschaulichung von technischen Dokumentationen werden verschiedene Formen von Visualisierungen eingesetzt. Es gibt eine Reihe von Unternehmen, die sich speziell auf solche Visualisierungen spezialisiert haben. Sie konstruieren beispielsweise digitale 3D CAD Daten, erstellen technische Detailansichten oder animierte Video-Dokumentationen für verschiedene Zwecke.

Der Vorteil von Videos ist, dass sich damit auch komplexe Arbeitsschritte unabhängig von der Sprache und für jeden nachvollziehbar darstellen lassen. Für Unternehmen ermöglicht der Einsatz neuer Medien eine große finanzielle Ersparnis, da teure Schulungskosten wegfallen oder zumindest deutlich reduziert werden können.

Im Vergleich zu traditionellen Printmedien ermöglichen virtuelle Bedienungsanleitungen und digitale Produktdokumentationen auch das ortsunabhängige Abrufen und das leichte Suchen und Finden von Informationen – mühsames Durchblättern langer Kataloge und Handbücher entfällt und wird durch wenige Klicks ersetzt.



Welche Publikationsmedien kommen in Frage?

Eine Vielzahl von Medien kommt für die Technische Dokumentation in Frage. Die klassische Veröffentlichung in Form von Büchern, Broschüren oder Ordnern aus Papier sind immer noch weit verbreitet, werden aber zunehmend ergänzt und ersetzt durch moderne Speichermedien. Übliche Formate sind zum Beispiel PDF-Dateien oder CDs.

Die neuen Medien bringen eine Vielzahl von Vorteilen: hohe Druckkosten für Bücher und Hefte können gespart und Informationen platzsparend und leicht transportierbar gemacht werden. Technische Dokumentation, die online auffindbar ist, ist jederzeit ortsunabhängig abrufbar. Das trifft vor allem für Online-Hilfen, Blogs und Webseiten zu.

 

Normen und gesetzliche Richtlinien  

Der Bereich der Technischen Dokumentation stellt ein Spezialgebiet dar, da neben sprachlicher Regeln und Merkmale eine Reihe von Dingen beachtet werden müssen. Dazu zählen neben gewissen gesetzlichen Verpflichtung auch Normen und Richtlinien von Institutionen und Verbänden, die für die Technische Dokumentation eines bestimmten Produktes maßgeblich sind. Diese Normen und Richtlinien dienen vor allem der rechtlichen Absicherung der Hersteller, der Sicherheit der Nutzer und der Prävention.

Die Gesetze sind für Hersteller von Produkten bindend. Ohne Technische Dokumentation darf zum Beispiel keine Maschine verkauft  und in Betrieb genommen werden.   

Gesetze in der Technischen Dokumentation

  • Produktsicherheitsgesetz (ProdSG) - Gesetz über die Bereitstellung von Produkten auf dem Markt
  • Produkthaftungsgesetz (ProdHaftG) - Gesetz über die Haftung für fehlerhafte Produkte

Beispiele für EG-Richtlinien

  • Maschinenrichtlinie 2006/42/EG    
  • Druckgeräterichtlinie 97/23/EG   
  • Niederspannungsrichtlinie 2006/95/EG        
  • Geräte in explosionsgefährdeten Bereichen (ATEX) 2014/34/EU
  • Medizinprodukterichtlinie 93/42/EWG

DIN-Normen zur technischen Dokumentation

  • DIN EN 82079-1 Erstellen von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung
  • DIN EN ISO 12100 Sicherheit von Maschinen
  • DIN EN 15038 Übersetzungs-Dienstleistungen

Aufgrund dieser sehr spezifischen Anforderungen und teilweise komplexen Richtlinien, ist sind weitreichende Fachkenntnisse für die Erstellung technischer Dokumente Pflicht. Hier kommt der Technische Redakteur ins Spiel.

 

Berufsbild Technischer Redakteur

Technische Redakteure kommen häufig aus den Bereichen Elektrotechnik, IT, Softwareentwicklung oder Maschinenbau. Das überrascht nicht, da dies auch die Bereiche sind, in denen Dokumentationen technischer Art häufig gebraucht werden.

Wer als Technischer Redakteur (auch Technical Writer) arbeiten möchte, sollte eine Reihe von Fähigkeiten mitbringen. Dazu zählen u.a.:

  • technisches Know-how in einem bestimmten Fachgebiet
  • Konzentrationsfähigkeit
  • Detailtreue
  • fachsprachliches Wissen
  • rhetorische Fähigkeiten
  • didaktische Fähigkeiten
  • die Fähigkeit, komplexe Sachverhalte einfach und klar darzustellen
  • Recherchekenntnisse
  • Wissen über einzuhaltende Richtlinien und Normen

Die Aufgabe des Technischen Redakteurs ist es, komplexe technische Inhalte für eine bestimmte Zielgruppe logisch nachvollziehbar und detailliert aufzubereiten. Wichtig ist, dass der Text alle qualitativen und rechtlichen Anforderungen erfüllt.

Als Experte für Technik und Sprache sind Technische Redakteure auf dem Arbeitsmarkt immer gefragt. Je nach Branche, Arbeitgeber und Erfahrung kann man mit einem monatlichen Gehalt von 3000 bis zu 5500 Euro rechnen und auch auf eine Anstellung bei führenden Großunternehmen wie Siemens hoffen.

 

Official resources

Gesellschaft für Technische Kommunikation – tekom Deutschland e.V.
Der deutsche Fachverband für Technische Kommunikation

http://www.tekom.de