Was ist Technische Dokumentation?

Technische Dokumentation bezeichnet die Aufbereitung und Publikation technischer Sachverhalte und Abläufe in einer der Zielgruppe und Zielsetzung entsprechend optimierten Form.

Dabei spielen die Strukturierung der Information, die prägnante Formulierung von Texten, die Aufbereitung von visuellen Informationen und die Wahl des richtigen Mediums eine wesentliche Rolle.

Zu den Publikationen in der Technischen Dokumentation zählen neben Gebrauchs- und Betriebsanleitungen auch elektronische Teilekataloge, Service- und Reparaturhandbücher, Handbücher für Software sowie interaktive Hilfesysteme und Online-Hilfen. Die erstellten technischen Dokumentationen liegen also nicht zwangsläufig (nur) in gedruckter Form vor, sondern werden je nach Zielsetzung auch auf CD-ROM oder Webseiten publiziert.

Gesetzliche Grundlagen und Normen für die Technische Dokumentation

Die Bereitstellung von Technischen Dokumentationen ist in Richtlinien und Gesetzen gefordert. In der EU gelten für Hersteller einschlägige EG-Richtlinien.

EG-Richtlinien, die die Technische Dokumentation betreffen
Maschinenrichtlinie 2006/42/EG
Niederspannungsrichtlinie 2006/95/EG
Druckgeräterichtlinie 97/23/EG
Geräte in explosionsgefährdeten Bereichen (ATEX) 94/9/EG
Aufzugsrichtlinie 95/16/EG
Medizinprodukterichtlinie 93/42/EWG
Produkthaftungsrichtlinie
Geräte- und Produktsicherheitsrichtlinie
… und viele mehr

Die Mitgliedstaaten setzen diese Richtlinien in nationales Recht um (z. B. Geräte- und Produktsicherheitsgesetz, GPSG). Das GPSG besagt z. B., dass beim Inverkehrbringen eine Gebrauchsanleitung in deutscher Sprache mitzuliefern ist, wenn "zur Gewährleistung von Sicherheit und Gesundheit bestimmte Regeln bei der Verwendung, Ergänzung oder Instandhaltung eines technischen Arbeitsmittels oder verwendungsfertigen Gebrauchsgegenstandes beachtet werden müssen".

Darüber hinaus enthalten einzelne Richtlinien wie die Maschinenrichtlinie und Medizinprodukterichtlinie konkrete inhaltliche Forderungen an die Technische Dokumentation. Die Einhaltung dieser Regelungen ist für die Hersteller bzw. Inverkehrbringer solcher Produkte Pflicht und auch in deren eigenem Interesse. So werden bei Produkthaftungsfällen auch immer wieder die sogenannten "Instruktionsmängel" herangezogen, um einen Hersteller zu belasten.

Neben der gesetzlichen Verpflichtung gilt für die inhaltliche Seite der Technischen Dokumentation: Normen und Richtlinien von Institutionen und Verbänden sind zu beachten, die für das in der Technischen Dokumentation betrachtete Produkt maßgeblich sind. Solche Normen und Richtlinien werden z. B. vom DIN, dem VDE, VDI, EN und international der ISO erstellt.

Auch für das Verfassen, namentlich die Bereiche Gliederung, Inhalt und Darstellung von Anleitungen, gibt es eine Norm: Die DIN EN 62079 stellt Forderungen und methodische Regeln zusammen, die beim Erstellen von Anleitungen für Benutzer von Produkten zu berücksichtigen sind. Ähnliche Ziele verfolgt die Richtlinienreihe VDI 4500.

Ob und inwieweit diese Gesetze, Normen und Richtlinien bei der Erstellung einer konkreten Technischen Dokumentation befolgt wurden, zeigt sich oft erst im Haftungsfall. Eine rechtssichere Anleitung kann dazu beitragen, den Hersteller vor Schadensersatzforderungen zu schützen.

Mit dem GPSG wird zudem ein neuer Ansatz verfolgt: die Prävention steht im Vordergrund; es soll verhindert werden, dass gefährliche Produkte auf den Markt kommen. Hierzu erhalten Behörden die Befugnis, unsichere Produkte vom Markt zu nehmen oder die Öffentlichkeit vor ihrer Verwendung zu warnen. Ein wesentliches Entscheidungskriterium für die Sicherheit eines Produktes wiederum ist die Technische Dokumentation.

Interne und externe Technische Dokumentation

Damit sichergestellt werden kann, dass der Nutzer sicher mit dem Produkt umgehen und es bestimmungsgemäß verwenden kann, wird eine sogenannte externe Technische Dokumentation erstellt, z. B. eine Betriebsanleitung. Sie wird zusammen mit dem Produkt ausgeliefert.

Von der Maschinenrichtlinie wird darüber hinaus auch eine interne Technische Dokumentation gefordert, die im Schadensfall als Nachweis für die Sicherheit des Produkts dienen. Zu dieser internen Technischen Dokumentation zählen z. B. Risikobeurteilungen, Konstruktionszeichnungen, Normenlisten, Berichte und Prüfergebnisse.

Sprache und Struktur von Technischen Dokumentationen

Die Technische Dokumentation stellt eine besondere Textsorte dar. Sie muss hohe Anforderungen an Verständlichkeit, Eindeutigkeit und Konsistenz erfüllen. Mit Blick auf eine internationale Vermarktung spielt auch die Übersetzbarkeit der Texte eine wichtige Rolle, die schon bei der Erstellung berücksichtigt werden muss.

Um diese Ansprüche zu erfüllen, verwenden Technische Redakteure eine sogenannte "kontrollierte Sprache". Sie zeichnet sich durch Regelungen und Einschränkungen in den Bereichen Syntax, Grammatik und Stil aus, die zusammen mit einer festgelegten Terminologie die Funktionalität von Technischen Dokumentationen gewährleisten sollen. Dem gleichen Zweck dienen auf der formalen Seite Strukturierungsmethoden zur Gliederung der oft komplexen Inhalte.

Das gezielte Auffinden von Informationen und deren zügiges Erfassen wird z. B. durch ein Funktionsdesign unterstützt. Die Strukturierung der Inhalte ist darüber hinaus eine wesentliche Voraussetzung für die Erstellung, Verwaltung, Wiederverwendung und Publikation von Inhalten mit einem Redaktionssystem.

Usability und Technische Dokumentation

Nicht allein sprachliche und strukturelle Regeln werden eingesetzt, um die Technische Dokumentation zielgruppengerecht zu gestalten. Ob der Nutzer anhand einer Anleitung tatsächlich schnell an die benötigten Informationen kommt und einen einfachen Zugang zum Produkt erhält, kann auch in Usability Tests überprüft werden. Darin kontrollieren Testpersonen am konkreten Produkt, ob es mit der dazugehörigen Technischen Dokumentation einfach und sicher bedienbar ist. Die in Usability Tests gewonnenen Erkenntnisse können direkt in die Optimierung der Technischen Dokumentation einfließen.

Wer erstellt Technische Dokumentationen?

Um die komplexen technischen Inhalte von Technischen Dokumentationen für die jeweilige Zielgruppe verständlich aufzubereiten, sind Technische Redakteure gefragt. Sie verfügen über technisches und fachsprachliches Wissen ebenso wie über rhetorische und didaktische Fähigkeiten. So können sie die Sachverhalte, die sie dokumentieren, selbst bis ins Detail verstehen und sie zugleich für den Nutzer didaktisch wirkungsvoll aufbereiten.

Häufig kommen Technische Redakteure aus den Bereichen Maschinenbau, Elektrotechnik oder Softwareprogrammierung – dort, wo Technische Dokumentationen hauptsächlich entstehen und gebraucht werden.

Auch wenn nicht zwingend ein ingenieurswissenschaftlicher Hintergrund nötig ist, sind technische Grundkenntnisse für einen Technischen Redakteur doch unabdingbar. Ebenso erforderlich sind Kenntnisse und Fertigkeiten in redaktioneller Arbeit (Recherche, Textproduktion etc.) und den in der Dokumentationserstellung üblichen Anwendungen wie Redaktionssysteme und Bildbearbeitungssoftware. Dies sowie die juristischen und normativen Anforderungen an Technische Dokumentationen werden z. B. in einem Volontariat zum Technischen Redakteur oder betriebsinternen Ausbildungsmaßnahmen vermittelt. Aber auch (Aufbau-)Studiengänge zum Technischen Redakteur werden in Deutschland an einigen Fachhochschulen angeboten.