Technische Dokumentation
Eine Technische Dokumentation (auch Technikdokumentation oder Produktdokumentation) umfasst alle Informationsprodukte, die ein technisches Erzeugnis beschreiben und zu seiner Nutzung, Wartung oder Reparatur anleiten. Sie bereitet die Informationen systematisch auf und strukturiert sie so, dass der jeweilige Zweck vollständig erfüllt wird. Die Technische Dokumentation wird dem dokumentierten Erzeugnis meist über Namens- und Nummernsysteme eindeutig zugeordnet.
Zweck der Technischen Dokumentation
Die Technische Dokumentation dient der Information und Instruktion in der Regel definierter Zielgruppen, der haftungsrechtlichen Absicherung des Herstellers, der Produktbeobachtung, der Rückverfolgbarkeit und Reproduzierbarkeit sowie der dauerhaften bzw. gesetzlich geforderten Archivierung der relevanten Informationsinhalte.
Die Bestandteile der Technischen Dokumentation bieten Informationen über das Produkt selbst, den Umgang mit ihm und über das Verhalten der Nutzer. Sie betrachten alle Lebensphasen des Produktes, von der Entwicklung bis zur Entsorgung, teilweise einschließlich der Herstellung der Vorprodukte.
Interne und externe Technische Dokumentation
Bei der Technischen Dokumentation wird nach VDI 4500 zwischen interner und externer Technischer Dokumentation unterschieden:
- Die interne Technische Dokumentation dient der internen Archivierung aller produktrelevanten Dokumente und der Nachweispflicht, alle rechtlichen Pflichten eingehalten zu haben. Sie umfasst den gesamten Produktlebenszyklus von der Produktplanung über Entwicklung, Markteinführung und Produktbeobachtung bis zur Einstellung des Produkts. Die Informationen bleiben im Normalfall beim Hersteller, der sie dauerhaft archiviert und während der gesamten Lebensdauer des Produkts aktuell hält. Typische Bestandteile sind Pflichtenhefte, Berechnungsunterlagen, Versuchsberichte, Risikobeurteilungen, technische Zeichnungen und Fertigungsunterlagen, Nachweise über Maßnahmen der Qualitätssicherung sowie die gesamte externe Technische Dokumentation des Produkts.
- Die interne Dokumentation wird in der Regel von der Entwicklungs- oder Konstruktionsabteilung des Herstellers geführt.
- Die externe Technische Dokumentation dient der Information der Betreiber und Benutzer des Produkts und stellt sicher, dass das Produkt sicher und bestimmungsgemäß in Betrieb genommen, verwendet, gewartet und ggf. entsorgt werden kann.
- Die externe Dokumentation wird in der Regel von Technischen Redakteuren erstellt und in der Regel in die Sprache der jeweiligen Anwender übersetzt. Je nach Produkt, Zielgruppe und gesetzlichen Anforderungen sind verschiedene Bezeichnungen und Formen möglich, wie Gebrauchsanleitung, Installationsanleitung, Montageanleitung, Kurzanleitung, Benutzerhandbuch, Gebrauchsanweisung, Bordbuch, Serviceanleitung, Online-Hilfe, Tutorial usw.
Spezielle Unterarten der Technischen Dokumentation ergeben sich aus rechtlichen Anforderungen wie der Hinterlegungspflicht bei Benannten Stellen (Beispiel: Technische Dokumentation nach Richtlinie 94/9/EG „ATEX“).
Gesetzliche Grundlagen
Um die Sicherheit von Produkten sicherzustellen, fordern staatliche Gesetze und Vorschriften privatrechtlicher Organisationen die Hersteller und Einrichter von technischen Erzeugnissen zur Bereitstellung der Technischen Dokumentation.
In der EU sind einschlägige EG-Richtlinien wie die Maschinenrichtlinie, die ATEX-Richtlinie, die Niederspannungsrichtlinie, die Druckgeräterichtlinie oder die Produktsicherheitsrichtlinie zu nennen, die von den Mitgliedstaaten in nationales Recht umgesetzt wurden (z. B. deutsches Produktsicherheitsgesetz oder Medizinproduktegesetz).
Im Schadensfall führt eine fehlerhafte Technische Dokumentation zur Haftung des Herstellers, die sich aus dem Produkthaftungsgesetz, dem Bürgerlichen Gesetzbuch (§ 823 Schadensersatzpflicht) sowie eventuellen einzelvertraglichen Verpflichtungen ergibt.
Normen
Normen und Richtlinien erstellen das DIN, der VDE, der VDI und das CEN. Im englischen Sprachgebrauch wird zwischen Normen und Standards nicht unterschieden. Internationale Standards erstellt und liefert unter anderem die ISO (die bei den Vereinten Nationen als weltweit koordinierende Standardisierungsinstitution registriert ist). Standards nationaler Organisationen wie die amerikanische ANSI oder das russische GOST finden ebenso internationale Anerkennung. Weitere Standardisierungsgremien finden sich beispielsweise in der IEC, der IMO, der IATA und der ICAO, die ihre Arbeit teilweise direkt mit der ISO organisieren und koordinieren.
Leitfäden für das Gestalten von Technischer Dokumentation oder Benutzerinformation sind in Form verschiedener Normen und Richtlinien verfügbar, die EN 82079 oder die Richtlinie VDI 4500. Die Dokumentation für Kraftwerke ist geregelt in der VGB-Richtlinie VGB-S-831-00, Lieferung der Technischen Dokumentation (Technische Anlagendaten, Dokumente) für Anlagen der Energieversorgung.
Die EN 61355 regelt die Klassifikation und Kennzeichnung von Dokumenten der Technischen Dokumentation für Anlagen, Systeme und Einrichtungen.
In einigen Industriebereichen werden abhängig von der zivilen oder militärischen Nutzung eines Produktes unterschiedliche Normen, Richtlinien und Spezifikationen eingesetzt. In der Luftfahrt sind dies beispielsweise die Spezifikation ATA100/ATA2000 im zivilen Bereich und die Spezifikation S1000D in der Wehrtechnik, wobei auch zivile Normen für Wehrmaterial verwendet werden und umgekehrt. Die Rangfolge der Normen, Richtlinie (EU) und Spezifikationen, für Wehrmaterial sind in § 14 der RICHTLINIE 2009/81/EG[1] sowie in der DIN EN 16341 geregelt. Die Spezifikation DIN SPEC 3105 sammelt Anforderungen an die technischen Dokumentation von Open-Source-Hardware.[2]
Für die physische Verwaltung der schriftlichen und elektronischen Dokumente kommt die internationale Norm ISO 15489 (Records Management/Schriftgutverwaltung) zur Anwendung.
Terminologie (Begrifflichkeiten) der technischen Produktdokumentation regelt u. a. DIN 199.
Dokumentationssystematik
Das Arbeiten an einer Dokumentation ist eine planbare Tätigkeit. Daher sollte eine systematische Produktion auch technischer Dokumentation einem Plan folgen, der wiederum während der Bearbeitung erweitert und verändert wird.
Struktur
Die Technische Dokumentation muss logisch gegliedert und strukturiert sein. Um die Handhabung zu erleichtern, werden bestimmte Dokumente in Gruppen thematisch oder analog zur Struktur des Erzeugnisses zusammengefasst und mit modular aufgebauten Dokumentenlisten und Inhaltsverzeichnissen verwaltet. Zum Zweck der Rückverfolgbarkeit von Revisionsständen ist eine Änderungshistorie üblich. Einen plastischen Überblick über die Dokumentationssystematik geben Normen wie die DIN 6789.
Eine bestimmte Struktur unterstützt eine ausgewählte Sicht auf einen Bestand an Dokumentation. Daher kann diese Struktur nicht allen Anforderungen gleichzeitig in demselben Maße genügen. Zwischen einer speziellen Struktur und möglichen weiteren speziellen Interessen einer anderen Ordnung vermittelt ein Index.
Strukturierungsmethoden
Insbesondere die Benutzerinformation stellt hohe Anforderungen hinsichtlich Übersichtlichkeit und Verständlichkeit. Um die oft komplexen Informationen übersichtlich zu gliedern und leicht verständlich darzustellen, gibt es Strukturierungsmethoden, wie die Information-Mapping-Technik oder das Funktionsdesign. Diese erleichtern die Aufnehmbarkeit der Inhalte und ermöglichen dem Benutzer der Dokumente ein leichteres Auffinden der gesuchten Information. Eine Strukturierung unterstützt außerdem die Erstellung, Verwaltung, Wiederverwendung und Publikation von Inhalten mit einem Redaktionssystem.
Verwendung von Farben und Kontrasten in Sicherheits- und Warnhinweisen
Gemäß dem amerikanischen Standard ANSI Z535.6, sowie der Europäischen Norm EN 82079-1, können Warnhinweise, Sicherheitshinweise und Produktsicherheitslabel schwarz-weiß, in Graustufen oder farbig dargestellt werden. Die Internationale Norm DIN EN ISO 12100-2 (Sicherheit von Maschinen) regt die Verwendung von Farbe in folgendem Sinne an: „Die Verwendung von Farbe sollte in Erwägung gezogen werden, insbesondere bei Bauteilen, die schnelles Erkennen erfordern.“ Farben können in verschiedener Intensität (Vollton oder aufgehellt durch Rasterung) und für verschiedene Zwecke eingesetzt werden. Insbesondere bei der Gestaltung von Symbolen und Piktogrammen zielt die Verwendung der Farbe darauf ab, Gebote und Verbote deutlich hervorzuheben. Beim Einsatz von Farben ist darauf zu achten, gleiches immer mit der gleichen Farbe zu kennzeichnen und die Zeichen kontrastreich zu gestalten. Ebenso ist zu beachten, dass auch Benutzer mit einer Sehschwäche (Rot-Grün-Schwäche, Farbenblindheit) die Sicherheitshinweise richtig interpretieren können müssen. Bei der Erstellung des Sicherheitshinweises sollte der Kontrast zwischen Hintergrund und Signalwort möglichst groß sein. Um einen einheitlichen Qualitätsstandard bei der Verwendung von Signalfarben zu gewährleisten, sind in amerikanischen und europäischen Normen Richtwerte für die jeweiligen Signalfarben definiert. Als Richtwert bei farbigen Drucken dienen die Vorgaben der ANSI Z535.1 oder/und die internationale Norm ISO 3864-4. Während die ANSI-Norm das Munsell-Farbsystem verwendet, wird in den europäischen Richtlinien das RGB- oder das CMYK-Farbmodell verwendet. Der individuelle Farbeindruck weicht immer etwas vom Soll ab, was aber in der Praxis kein großes Problem ist. International genormte und abgestimmte Sicherheitszeichen sind in der internationalen Norm DIN EN ISO 7010 zu finden.
Fachsprachen
Technische Dokumentation bedient sich einer in der jeweiligen Gemeinschaft der Nutzer (community) üblichen Nomenklatur und eines hoch spezialisierten Sprachschatzes. Die Benutzer dieser Sprache werden sich gut darin zurechtfinden, fremde Leser werden sich über Thesauri dieser Sprache annähern müssen.
Sprachliche Besonderheiten
Die Benutzerinformation ist neben den Strukturierungsmethoden auch sprachlich eine Textsorte mit bestimmten Primärzielen, u. a.:
- Verständlichkeit (vgl.: Hamburger Verständlichkeitskonzept)
- Eindeutigkeit
- Konsistenz
- Übersetzbarkeit (vgl.: Übersetzungsgerechtes Schreiben)
Sprachlich werden diese Ansprüche, gerade bei einer inhomogenen Autorengruppe, durch eine eingeschränkte bzw. Kontrollierte Sprache erfüllt. Die Sprachkontrolle umfasst dabei, je nach Kontrollgrad, folgende Regelungen und Einschränkungen:
- Terminologie
- Stil- und Grammatikregeln (vgl.: Simplified English)
- Syntaxregeln
- Interpunktionsregeln (Vor allem für die Weiterverarbeitung mit Translation-Memory-Systemen)
Diese sprachlichen Einschränkungen werden durch eine Terminologie und ggf. durch einen Redaktionsleitfaden festgehalten und können durch geeignete Sprachprüfprogramme (Controlled Language Checker) unterstützt werden.
Verschiedene Sprachen
Da technische Erzeugnisse aufgrund ihres hohen Spezialisierungsgrades häufig in eine Vielzahl von Ländern exportiert werden, werden externe Dokumentationen und Benutzerinformationen zumeist in eine Reihe von nationalen oder regionalen Sprachen übersetzt. Damit diese Übersetzungen kostengünstig durchgeführt werden können, sollten Technische Redakteure bereits während der Erstellung auf die Anforderungen des übersetzungsgerechten Schreibens achten. Dieses Thema wird heute auch unter dem Stichwort Lokalisierung diskutiert. Zur Unterstützung einer qualitativ hochwertigen Übersetzung werden Translation Memory Systeme eingesetzt, die nicht nur einzelne Wörter, sondern bestimmte Satzteile sinngemäß übersetzen und abspeichern.
Erstellung Technischer Dokumentationen
In die Erstellung der Technischen Dokumentation für ein Erzeugnis sind idealerweise alle technischen Funktionsbereiche des Herstellers einbezogen. Spezifikationen, Pflichtenhefte, Risikoanalysen sowie Unterlagen der Konstruktion und Fertigung werden von Entwicklungs- und Konstruktionsabteilungen erstellt. Unterlagen der Qualitätssicherung werden seitens der hierfür beauftragten Fachkräfte erstellt bzw. beschafft. Zu integrierende Unterlagen von Lieferanten und Sub-Herstellern werden durch Einkaufsabteilungen angefordert.
Speziell die Erstellung externer Dokumentationen erfordert besondere Fachkenntnisse und Qualifikationen. Mit dieser Aufgabe werden Technische Redakteure betraut, die häufig in speziellen Fachabteilungen – Technischen Redaktionen – sowohl für die redaktionelle Bearbeitung von Benutzerinformationen als auch für die Koordination des abteilungsübergreifenden Dokumentationsprozesses verantwortlich sind.
Unterbegriffe
Diese Begriffe stehen in direktem Zusammenhang mit dem Hauptbegriff Technische Dokumentation. Sie werden für unterschiedliche Zwecke und kundenorientiert eingesetzt.
- IETD – Interaktive Elektronische Technische Dokumentation
- IETP – Interaktive Elektronische Technische Publikation
- IETM – Interactive Electronic Technical Manual
Autorenwerkzeuge
Autorenwerkzeuge (engl.: Help authoring tools, kurz: HAT) sind spezielle Softwarewerkzeuge, mit denen Online-Hilfen und andere Informationsprodukte erstellt werden.
Literatur
- Dietrich Juhl: "Technische Dokumentation: Praktische Anleitungen und Beispiele", Springer Vieweg; 3., vollst. überarb. Aufl. 2015, ISBN 978-3662468647
- Andreas Baumert, Annette Verhein-Jarren: "Texten für die Technik: Leitfaden für Praxis und Studium", Springer, Berlin, Heidelberg 2012 ISBN 978-3-642-13826-3
- Petra Drewer, Wolfgang Ziegler: "Technische Dokumentation", Vogel, 2010 ISBN 978-3-8343-3101-4
- Andreas Schlenkhoff: "Duden Ratgeber – Technische Dokumentation: Verständliche Texte für Produkte erstellen und gestalten", Bibliographisches Institut, Mannheim 2012 ISBN 978-3-411-74721-4
- Richtlinienreihe VDI 4500 https://www.vdi.de/technik/fachthemen/produkt-und-prozessgestaltung/fachbereiche/technischer-vertrieb-und-produktmanagement/themen/technische-dokumentation/richtlinienreihe-vdi-4500-technische-dokumentation/
- Lars Kothes: Grundlagen der Technischen Dokumentation – Anleitungen verständlich und normgerecht erstellen, Springer, Berlin, Kempen, 2010, ISBN 978-3-642-14667-1
Weblinks
Fachverbände
Technisches Wörterbuch
Weiterführende Angaben
Einzelnachweise
- Richtlinie 2009/81/EG
- DIN SPEC 3105-1:2020-07, Open Source Hardware - Teil 1: Anforderungen an die technische Dokumentation; Text Englisch. Beuth Verlag GmbH, Berlin Juli 2020, doi:10.31030/3173063 (beuth.de [abgerufen am 11. November 2021]).