Technische Dokumentation

1:1-Anleitung dank Typenschlüssel mit Steuerungsfunktion

Seite: 2/3

Anbieter zum Thema

Struktur als wichtige Voraussetzung für Modularisierung

Zunächst wurde durch umfangreiche strukturelle und inhaltliche Standardisierung der Texte eine saubere Basis für die Modularisierung geschaffen. Dazu wurden sowohl die Struktur als auch die Inhalte der bestehenden Informationsmittel jener Produktgruppe überarbeitet, die beispielhaft für das Pilotprojekt betrachtet wurde. Das Ziel war die Identifikation von Informationen, die sich entweder eindeutig bestimmten Produktkomponenten, Varianten und Optionen zuordnen ließen (Beispiel: Trennverstärker montieren -> auf Hutschiene -> mit xy-Verbinder/ohne xy-Verbinder) oder allgemeingültiger Natur waren (Über diese Anleitung -> Symbolerklärung).

Anschließend wurde eine „Masterstruktur“ für eine Installationsanleitung erarbeitet. Diese Struktur enthält den Maximalumfang an Informationen für alle Produkte der gesamten Baureihe. Gleichzeitig stellt sie die Reihenfolge dar, in der die Informationen später ausgegeben werden sollen.

Produktseitige Voraussetzung: Der Typenschlüssel

Auch der Typenschlüssel muss bestimmten Kriterien standhalten, wenn das Konzept funktionieren soll. Eine saubere Systematik ist unabdingbar, damit bei späteren Zusammenstellungs- oder Filterprozessen eine eindeutige Zuordnung von Informationen möglich ist. Der Typenschlüssel muss also frei sein von Mehrfachbezügen, Dopplungen, u. Ä.

Der Typenschlüssel, der zur Steuerung der Dokumentation dienen sollte, besteht aus 12 Elementen. Zunächst mussten die hierarchischen und die nicht-hierarchischen Bestandteile identifiziert werden. Hierarchisch aufgebaut sind alle jene Komponenten, deren Elemente eine Abhängigkeit aufweisen (Interfacetechnik -> Schaltgeräte -> Trennverstärker).

Typenschlüssel (Beispiel): Die optionalen Komponenten bzw. Funktionen sind gleichwertig und müssen – auch wenn sie im Typenschlüssel hierarchisch dargestellt werden – als nicht-hierarchische Elemente betrachtet werden (Spannungsversorgung 24 V oder 230 V, analoger oder digitaler Eingang usw.).

(ID:44620958)