Technische Dokumentation
aus Wikipedia, der freien Enzyklopädie
Eine Technische Dokumentation (auch: Technikdokumentation oder Produktdokumentation) ist die Gesamtheit von Dokumenten, die ein technisches Erzeugnis beschreiben. Merkmal der Technischen Dokumentation ist die strukturierte Aufbereitung der Informationsinhalte in der für einen bestimmten Zweck geforderten Art und Vollständigkeit. Die Technische Dokumentation muss dem dokumentierten Erzeugnis klar zuzuordnen sein.
Inhaltsverzeichnis |
[Bearbeiten] 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.
[Bearbeiten] Einteilung nach Zielgruppe / 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, Risikoanalysen 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 bestimmmungsgemäße Verwendung des technischen Erzeugnisses informiert wird. Die externe Dokumentation wird in der Regel von Technischen Redakteuren zielgruppengerecht 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").
[Bearbeiten] Gesetzliche Grundlagen und Normen
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 übernommen werden (Produkthaftungsgesetz, Geräte- und Produktsicherheitsgesetz).
Wichtige Normen und Richtlinien erstellen ferner das DIN, der VDE, der VDI und das EN. Internationale Standards liefert unter anderem die ISO, das amerikanische ANSI oder das russische GOST.
Als Leitfäden für das Gestalten einer Technischen Dokumentation / Benutzerinformation dienen verschiedene Normen und Richtlinien, wie die DIN EN 62079 oder die Richtlinie VDI 4500. Die Dokumentation für Kraftwerke ist geregelt in der VGB-Richtline VGB R171, Lieferung der technischen Dokumentation für fossil befeuerte und regenerative Kraftwerke.
[Bearbeiten] Dokumentationssystematik
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.
[Bearbeiten] 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.
[Bearbeiten] Verschiedene Sprachvarianten
Da technische Erzeugnisse aufgrund ihres hohes Spezialisierungsgrades häufig in eine Vielzahl von Ländern exportiert werden, werden externe Dokumentationen und Benutzerinformationen zumeist in eine Reihe von 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.
[Bearbeiten] 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 Konstruktions- und Fertigungsunterlagen 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 jedoch 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.
[Bearbeiten] Autorenwerkzeuge
Als Autorenwerkzeuge, engl.: Help authoring tools, kurz: HAT, bezeichnet man Software-Programme, mit denen Online-Hilfen und andere Informationsprodukte erstellt werden.
[Bearbeiten] Siehe auch
- HowTo
- FAQ
- AECMA
- Mumasy
- Instruktionsdesign
- Benutzerhandbuch
- Softwaredokumentation
- Verfahrensdokumentation
- Produktdatenmanagement
- Dokumentenmanagement
- Dokumenten-Technologien
- Information-Mapping-Technik
- Funktionsdesign
[Bearbeiten] Weblinks
- tekom - Fachverband der technischen Redakteure (Ersteller technischer Dokumentationen)
