Grundanforderungen an eine gelungene technische Dokumentation

Denn technische Unterlagen wie Gebrauchsanweisungen, Installationshandbücher oder Bedienungsanleitungen, die für die verschiedensten Zwecke verwendet und gespeichert werden, bilden die rechtliche Grundlage dafür, technische Geräte wie Produktionsmaschinen überhaupt in Verkehr zu bringen und in Betrieb zu nehmen.

Daher sind Hersteller und Anbieter von Produkten nicht nur rechtlich verpflichtet, Informationen entlang des gesamten Produktlebenszyklus in geeigneter medialer Form umfassend zu dokumentieren. Vielmehr muss ihnen im eigenen Interesse explizit daran gelegen sein, eine für Laien oftmals unverständliche, weil komplexe Technik transparenter zu machen.

Kunden wie auch einer potentiell interessierten Käuferschicht können technische Details von Produkt- wie Produktionsinnovationen nur nähergebracht werden, wenn sie diese auch verstehen und nachvollziehen können. Daher gibt es einige grundlegende Aspekte zu berücksichtigen, die im Zusammenhang mit der Erstellung von Manualen, Handbüchern, Anleitungen & Co stehen.

Komplexes in leicht verständliche Sprache gießen

Spätestens, wenn Produkte, Dienstleistungen oder technische Verfahren zur Marktreife gelangt sind, gilt es, die ihnen zugrundeliegenden Charakteristika zu dokumentieren. Technische Handbücher, Gebrauchsanweisungen oder auch Bedienungsanleitungen sind dabei die adäquaten medialen Vermittler zwischen Erzeuger beziehungsweise Entwickler und einer potenziellen Käuferschicht.

Technische Beschreibung von Sachverhalten und Anleitungen zu ihrer Bedienung sind für sich genommen eine trockene, schwer verdauliche Kost.

Denn alle wichtigen Detail-Angaben etwa für

• Montage
• Bedienung
• Inbetriebnahme
• Instandhaltung
• Transport
• Entsorgung

müssen nach DIN EN 82079-1 von einer technischen Dokumentation abgedeckt werden. Die Norm stellt ein Anforderungs- und Regelkatalog hinsichtlich

• Inhalten
• Gliederungsmerkmalen und
• ihrer Visualisierung

dar, die beim Erstellen von Anleitungen für Benutzer von Produkten zu berücksichtigen sind.

Um die Konzentrations- und Aufnahmefähigkeit des Rezipienten möglichst lange aufrecht zu erhalten, gilt es daher umso mehr, technische Sachverhalte in einer leicht verständlichen Sprache mit eindeutigen Formulierungen leicht nachvollziehbar zu beschreiben. Dabei sollte der einmal gewählte Sprachstil im Zuge stilistischer Konsistenz einheitlich über das gesamte Dokument hinweg beibehalten werden.

Kurze, prägnante Sätze sollten daher mit einem möglichst quantitativ geringen Arsenal an Formulierungen auskommen, der überdies so weit als möglich dem allgemeinen Sprachschatz entnommen ist.

Dagegen wirken etwa lange, verschachtelte Sätze, eventuell mit Passivkonstruktionen, Fremdwörtern und Fachjargon angereichert, eher verwirrend und intransparent. Sie tragen vielmehr zu einer vermeidbaren Verkomplizierung des Fließtextes bei, welche die inhaltliche Aufnahme der Fakten erschwert.

Und dabei die Form wahren

Nicht weniger als die prägnante Formulierung von Texten, genießen auch eine

• passgenaue Strukturierung der Information
• ihre visuelle Aufbereitung und
• die Wahl des geeigneten Mediums

hervorgehobene Bedeutung. Dem Zweck, eine Funktionalität von technischen Dokumentationen zu gewährleisten, dienen neben der inhaltlichen Seite auch Strukturierungsmethoden zur Gliederung der oft komplexen Inhalte auf formeller Ebene.

Inhalte müssen vor dem Hintergrund eines konsistenten Funktionsdesigns so strukturiert sein, dass Inhalte

• zügig erfasst und
• gezielt aufgefunden

werden können.

Beide Komponenten dienen als Grundlage eines Redaktionssystems, das Inhalte nicht nur leicht erstellen und wiederauffinden, sondern auch bequem verwalten und veröffentlichen lässt.

Normierungen beachten

Neben inhaltlichen und strukturellen Anforderungen müssen technische Dokumentationen darüber hinaus auch etwaigen Normen-Richtlinien gerecht werden. Neben einem EU-weiten Richtlinien- und Gesetzeswerk, das Herstellern eine rechtliche Dokumentationspflicht auferlegt, müssen Dokumentationen jeweilige branchenspezifische Normen-Vorgaben beachten, die von den betreffenden Fachverbänden und Institutionen verpflichtend zum Inhalt ergänzend vorgeschrieben sind.

Im Bereich Maschinenbau können dies etwa bestimmte Maschinenrichtlinien, im Bereich pharmazeutischer Erzeugnisse spezielle Medizinprodukte-Richtlinien sein.

Maschinenrichtlinien etwa erfordern eine sogenannte „Interne technische Dokumentation“. Sie kann ein Prüfergebnis, eine Konstruktionszeichnung oder auch ein Testbericht sein, die im Rahmen einer umfassenden Beweis- und Nachweispflicht zur Entlastung herangezogen werden können, wenn es zum Schadensfall kommt. Interne Dokumentation haben daher den detaillierten Nachweis technischer Produktsicherheit zum Inhalt und genießen versicherungsrechtlichen Status.

Dagegen verfolgen externe technische Dokumentation das vorrangige Ziel, zur sicheren Handhabung der Produkte anzuleiten und Nutzern ihre Struktur wie Funktionsweise explizit darzulegen.

Hinzu kommen nationale, EU-weite wie auch internationale branchenneutrale Normenvorgaben, die von Institutionen wie

• ISO
• EN
• DIN
• VDI oder
• VDE

für inhaltliche wie strukturelle Aspekte zwingend vorgeschrieben sind.

Der technische Redakteur – ein komplexes Berufsbild

Nicht nur in den gesetzlichen Regel- und Normenwerken müssen speziell ausgebildete technische Redakteure bewandert sein. Neben grundlegendem redaktionellen Know-how gehören Kenntnisse

• in „kontrollierter Sprache“
• im jeweiligen technischen Fachbereich
• im branchenspezifischen Fachjargon
• Rhetorik
• Didaktik

zu einem umfassenden Anforderungsportfolio.

Sie sollten darüber hinaus im Projekt-, Qualitäts- und Prozessmanagement, sowie in der Entwicklung von Layout und Design bewandert sein. Publikationstechnische Grundlagen sowie Produktions- und Archivierungskenntnisse runden ein vielschichtiges Berufsspektrum ab, das auch eine Koordination entsprechender Übersetzungen miteinschließt.

In verschiedene Zielsprachen internationalisieren

In Zeiten zunehmender Globalisierung sollte die technische Dokumentation letztlich – so professionell, wie sprachlich und formal korrekt ausgestaltet sie auch immer in der Basissprache bereits verfasst ist – auch in andere Sprachen übersetzt werden, um mit den Bedienungsanleitungen und Handbüchern eine möglichst breite, internationale Zielgruppe zu erreichen. Dies geschieht am effektivsten durch eine technische Übersetzung nach dem ISO 17100-Standard. Er stellt einen Europa-Standard zur Zertifizierung von Übersetzungsdienstleistern auf dem Weg zur Internationalisierung dar. Der Standard ist überdies in der Lage, Übersetzungsdienstleister im weltweiten Kontext auf Basis eines normierten Anforderungsprofils objektiv besser miteinander vergleichen zu können und so eine einheitliche Bewertungsgrundlage zu schaffen.