Wer sich mit der Technischen Dokumentation (TD) als Ganzes beschäftigt, stellt fest, dass es eine große Bandbreite an Produkten und Dokumenten gibt, siehe Bild.
Dabei wird auch schnell klar, dass die Anforderungen und Ausführungen sehr (!) unterschiedlich sind.
Meine Motivation
Technische Dokumentation wird m.E. häufig zu pauschal gesehen und diskutiert. TD ist sehr unterschiedlich und Erkenntnisse gelten meistens nur für eine kleinen Teil der TD.
Mit diesem kleinen Beitrag möchte ich das Thema zunächst nur mal anreissen. Wenn Sie Interesse haben, können wir weitere Details gerne diskutieren oder ausarbeiten.
Typologie
Besonders wichtig sind mir folgende Kategorien:
Beschreibung
Ein Teil einer TD ist immer beschreibend, z.B.:
- bestimmungsgemäßer Gebrauch
- Aufbau und Funktion
- Bedienelemente
- Konzepte
Anleitung
Besonders wichtig und für uns herausfordernd sind die Teile der TD, bei denen es darum geht, den Anwender zu Handlungen anzuleiten. Hier hat sich die Schritt-für-Schritt-Anleitung etabliert, ist aber nicht die einzige Form einen Benutzer zur Handlung zu befähigen.
Technische Unterlagen
Ein Großteil der TD sind Technische Unterlagen, häufig eine Sammlung von Daten und Zeichnungen, meist systematisch geordnet. Sie dokumentieren das Produkt aus technischer Sicht und halten wichtige Informationen für später fest.
- Technische Daten, ggf. auch mehrere Tabellen
- Zeichnungen
- Pläne
Letztlich dienen solche Technischen Unterlagen auch dazu, irgendwelche Handlungen zu ermöglichen, z.B. Umbau, Reparatur, Ersatzteilbeschaffung …
Produktgruppen und TD-Anteile
Betrachtet man die Produkte, stellt man fest, dass der Anteil von Beschreibung, Anleitung und Technischen Unterlagen sehr unterschiedlich ist.
Das Bild zeigt die von mir geschätzten Anteile und zeigt die riesigen Unterschiede:
- beim Gerät sehr viel Anleitung
- bei der Anlage sehr viel Technische Unterlagen
Natürlich sollen das nur Mittelwerte sein.
TD-Namen
Sehr unterschiedlich sind auch die Namen für TDs, die sich eingebürgert haben, z.B.:
- Chemie: Anwendungshinweise
- Tabletten: Beipackzettel
- Gerät: Bedienungsanleitung
- Software: Bedienungsanleitung, Tutorial, Referenz-Guide
- Maschine: Betriebsanleitung,
sehr häufig auch Teildokumente, wie z.B. Installationsanleitung, Inbetriebnahmeanleitung, Wartungsanleitung, Serviceanleitung …)
Hier eine kleine Zusammenstellung aus heutiger Sicht.
