- Technische Dokumentation
-
Eine Technische Dokumentation (auch: Technikdokumentation oder Produktdokumentation genannt) ist die Gesamtheit von Dokumenten, die ein technisches Erzeugnis beschreiben. Merkmal der Technischen Dokumentation ist die systematische Aufbereitung und die strukturierte Präsentation der Informationsinhalte in der für einen bestimmten Zweck geforderten Art und Vollständigkeit. Die Technische Dokumentation muss dem dokumentierten Erzeugnis klar zuzuordnen sein, das erfolgt in der Regel durch Namens- und Nummernsysteme.
Zweck der Technischen Dokumentation
Die Technische Dokumentation dient der Information und Instruktion 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.
Einteilung entsprechend Zielgruppe und Verwendungszweck
Je nach Zielgruppe und Verwendungszweck enthält die Technische Dokumentation Informationen über die Herstellung, die Beschaffenheit und die bestimmungsgemäße Verwendung des technischen Erzeugnisses.
Die Richtlinie VDI 4500 unterscheidet zwischen interner und externer Technischer Dokumentation:
Die interne Technische Dokumentation (Technische Produktdokumentation) umfasst z. B. Konstruktions- und Fertigungsunterlagen, Pflichtenhefte, Berechnungsunterlagen, Versuchsberichte, Risikobeurteilungen und Nachweise über Maßnahmen der Qualitätssicherung. Ferner enthält sie alle Informationen der "Externen Technischen Dokumentation" (vorzugsweise im Original). Sie bleibt beim Hersteller dauerhaft archiviert und wird während der gesamten Lebensdauer des Produktes aktuell gehalten (Produktbeobachtung).
Die externe Technische Dokumentation richtet sich dagegen an den Benutzer, der mit Benutzerinformationen wie Betriebsanleitungen, Gebrauchsanweisungen oder Sicherheitshinweisen, aber auch anhand von Plänen, Zeichnungen und Stücklisten über die Beschaffenheit und die bestimmungsgemäße Verwendung des technischen Erzeugnisses informiert wird. Die externe Dokumentation wird in der Regel von Technischen Redakteuren entsprechend einer Zielgruppe erstellt.
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
Aus Haftungsgründen 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 sog. Maschinenrichtlinie, die ATEX-Richtlinie, die Druckgeräterichtlinie oder die Produkthaftungsrichtlinie zu nennen, die von den Mitgliedstaaten in nationales Recht umgesetzt werden (Produkthaftungsgesetz, Geräte- und Produktsicherheitsgesetz).
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 62079 oder die Richtlinie VDI 4500. Die Dokumentation für Kraftwerke ist geregelt in der VGB-Richtlinie VGB R171, Lieferung der technischen Dokumentation für fossil befeuerte und regenerative Kraftwerke.
Die EN 61355 regelt die Klassifikation und Kennzeichnung von Dokumenten der technischen Dokumentation für Anlagen, Systeme und Einrichtungen.
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 Sicherheitshinweisen
Gemäß ANSI Z535.6 können Sicherheitshinweise schwarz-weiß, in Graustufen oder farbig dargestellt werden. Die europäische Norm DIN EN ISO 12100-2 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 alternativ die europäischen Normen EN 61310-146 und ISO 3864-247. Während die ANSI-Norm das Munsell-Farbsystem verwendet, wird in den europäischen Richtlinien das RGB- oder das CMYK-Farbsystem verwendet. Der individuelle Farbeindruck weicht immer etwas vom Soll ab, was aber in der Praxis kein großes Problem ist. In der Tabelle Signalfarben werden die Farbwerte für die verschiedenen Signalfarben in den verschiedenen Farbsystemen optisch veranschaulicht.
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.
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 der Online-Hilfen und andere Informationsprodukte erstellt werden.
Weblinks
Wikimedia Foundation.
