Technische Dokumentation

Einblick in die Praxis

Technische Dokumentation soll Verständnisbarrieren abbauen und den Zugang der Nutzer zum Produkt erleichtern.

Insofern sollten die Ziele der Barrierefreiheit mit denen der Technischen Dokumentation vereinbar sein.

Beschäftigungsverhältnisse
- Angestellte bei Herstellern in verschiedenen Abteilungen
  (Dokumentation, Entwicklung, Marketing, Support usw.)
- Dienstleistungsunternehmen
- Freiberufler (für Hersteller & Dienstleister)
Hintergrund & Ausbildung
- Technik- & Sprachinteressierte Quereinsteiger
  (Journalisten, Übersetzer, Entwickler usw.)
- Absolventen von Weiterbildungen & neuen Studiengängen
  (Technische Redaktion o. ä.)

Standards
- ISO 26514 – Struktur, Inhalt & Format von Benutzerdokumentation
- ANSI Z535 & ISO 3864 – Symbole für Warn- und Sicherheitshinweise
- EU Machinery Directive 2006/42/EC – “Maschinenrichtlinie”
Style Guides – Gestaltungsrichtlinien & Redaktionsleitfäden
- Sun: “Read Me First! A Style Guide for the Computer Industry”
- Microsoft: “Manual of Style for Technical Publications”
Berufsverbände
- Society for Technical Communication – STC – www.stc.org
- Gesellschaft für Technische Kommunikation e.V. – tekom – www.tekom.de
- Dachverbände: TCeurope & INTECOM (International Council for Technical Communication)

Welche Methoden & Prinzipien sind in der Branche als empfehlenswert anerkannt? Welche Motivation gibt es, diese anzuwenden?

Nutzer:
Bessere Übersicht, leichtere Einarbeitung, höhere Konsistenz & Qualität.

Redakteur: Verringerter Wartungsaufwand.
“Wie kann ich die Arbeit erleichtern und bessere Ergebnisse produzieren?”

Chef: Produktivität. Geld sparen.
“Wie können wir mit weniger Ressourcen mehr machen?”

Trennung des Inhalts von der Darstellung
- Semantische Auszeichnung – Struktur statt Präsentation
  “Was ist es?” statt “Wie sieht es aus?”
- Formatvorlagen, Absatz- und Zeichenformate
- z.B. Struktur & Inhalt in HTML, Formatanweisungen in CSS
Modularisierung, Wiederverwendung & “Single Source Publishing”
- Verschiedene Versionen/Formate eines Dokumentes aus einer Quelle
- Allgemeines erkennen & generisch halten, Spezifisches auslagern
- Variablen & bedingter Text
XML-basierte Informationsarchitektur (DocBook, DITA)
- Vordefiniertes Vokabular (DTD/Schema) gibt Struktur vor
- Sehr granulare Filterung über Attribute möglich
- Werkzeugunabhängig