Technische Dokumentation
aus Wikipedia, der freien Enzyklopädie
Eine Technische Dokumentation (sprachlich präzise heißt es: Technikdokumentation) ist ein zusammenfassender Begriff für alle Informationen, die dem Benutzer eines Produkts zur Verfügung gestellt werden (können). Die Ersteller von Technischer Dokumentation nennt man technische Redakteure.
Inhaltsverzeichnis |
[Bearbeiten] Zweck der Technischen Dokumentation
Technische Dokumentation ist Information zu einem technischen Thema, wendet sich an eine bestimmte Zielgruppe und hat eine festgelegte Absicht. Sie ist keine Unterhaltungslektüre, sondern die Leser wollen ein Ziel erreichen (Problem lösen) und stehen oft unter Zeitdruck. Dies erfordert eine bestimmte Art der Aufbereitung und Darstellung der Informationen. Gute Technische Dokumentation ist Vorwärtsdokumentation und hat folgende Merkmale: Sie ist einfach zu nutzen, einfach zu verstehen und einfach zu finden.
Die Bestandteile der Technischen Dokumentation bieten Informationen über das Produkt selbst, den Umgang mit ihm und über das Verhalten der Nutzer.
[Bearbeiten] Einteilung nach Zielgruppe
Abhängig von der Zielgruppe unterscheidet man zwischen Interner und Externer Technischer Dokumentation:
Die Interne Technische Dokumentation umfasst z. B. Konstruktions- und Fertigungsunterlagen, Pflichtenhefte und Nachweise über Maßnahmen der Qualitätssicherung. Sie richtet sich an die Mitarbeiter des Herstellers.
Die Externe Technische Dokumentation richtet sich dagegen an den Benutzer, der z. B. mit Betriebsanleitungen, Gebrauchsanweisungen oder Sicherheitshinweisen über die richtige Handhabung des Produkts informiert wird.
[Bearbeiten] Gesetzliche Grundlagen und Normen
Aus Haftungsgründen fordern staatliche Gesetze und Vorschriften privatrechtlicher Organisationen die Hersteller und Einrichter von technischen Systemen zur Bereitstellung der Technischen Dokumentation. Beispiele für nationalstaatliche Regelungen der Bundesrepublik Deutschland sind das Produkthaftungsgesetz und das Geräte- und Produktsicherheitsgesetz. Wichtige Normen erstellen in Deutschland das DIN und Richtlinien der VDE und der VDI Für die ganze EU erstellt das EN Normen. Eine wichtige internationale Regelung der EU ist die EG-Richtlinie "Maschinen" Grundlagen für das Gestalten einer Technischen Dokumentation sind verschiedene Normen und Richtlinien, unter anderen die DIN EN 62079 oder die Richtlinie VDI 4500.
[Bearbeiten] Strukturierungsmethoden
Um die oft komplexen Informationen bei der Erstellung Technischer Dokumentation übersichtlich zu gliedern und leicht verständlich darzustellen gibt es Strukturierungsmethoden, wie die Information-Mapping-Technik. Diese erleichtern die Aufnehmbarkeit der Inhalte und ermöglichen dem Benutzer der Dokumente ein leichteres Auffinden der gesuchten Information.
[Bearbeiten] Verschiedene Sprachvarianten
Da heute Produkte meist in eine Vielzahl von Ländern exportiert werden, wird die Technische Dokumentation 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] 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
[Bearbeiten] Weblinks
- tekom - Fachverband der technischen Redakteure (Ersteller technischer) Dokumentation
