Module al gusto - Technische Informationen nach Ihren Erfordernissen strukturieren

Beim Aufbau modularer Dokumentation wird großer Wert auf die Auswahl einer geeigneten Inhalts-Strukturierung gelegt. Das kann einerseits durch eine geeignete XML-Struktur geschehen oder auch durch die konsequente Anwendung von Format-Definitionen in einem DTP-Werkzeug.

Die Wiederverwendung von Inhalten und die Effizienz des Systems beim Publizieren werden gleichzeitig durch die Klassifizierung der Module und Vereinbarungen zur Modulgröße beeinflusst.

Bei der Modularisierung der bestehenden Publikationen, entstehen Module mit den unterschiedlichsten Inhalten, die vom Redakteur bei der Arbeit mit dem System leicht gefunden, eindeutig identifiziert und im gewünschten Kontext zusammengestellt werden müssen.

Was ist das Schwierige am Finden einer effektiven Kennzeichnung für Module? Es ist der Wunsch, mit ständig wechselnden Suchkriterien jedes Modul über die Kennzeichnung aus einer schwer bzw. nicht mehr überschaubaren Vielzahl anderer Module in einer verzweigten Ablagestruktur oder einer unendlich langen Liste wiederfinden zu können.

Wer sucht, der findet?

Folgende Szenarien sind vorstellbar:

1. Jemand sucht alle Module, in denen das Wort „Schraubenzieher“ vorkommt.
2. Es soll ein Modul gefunden werden, in dem die Reinigung eines Filters von Ölresten beschrieben wird.
3. Die Anleitung für Produkt 1 muss überarbeitet werden, da es eine funktionale Änderung gibt, die nur Produkt 1 betrifft. Wie müssen Module gekennzeichnet werden, damit nur die Module von Produkt 1 und nur die aus den Kapiteln Inbetriebnahme und Bedienung gefunden werden?
4. Es soll ermittelt werden, ob es Module gibt, für die ein konkreter Autor Inhalte für Service-Handbücher verfasst hat.
5. Die Anleitungen von Produkten, die im kommenden Monat auf den Markt gehen sollen, müssen um einen Sicherheitshinweis für die Betriebssicherheit ergänzt werden. Davon betroffen sind nur die Produkte einer Produktklasse und nur die Abschnitte für das Kapitel Bedienung. Wie müssen die Module gekennzeichnet worden sein, damit konkret diese Module leicht gefunden werden?

Die Beispiele zeigen, dass es empfehlenswert ist, in der Konfiguration des Systems die Möglichkeit vorzusehen, Module mit ausreichend vielen Meta-Informationen auszuzeichnen, um gezielt nach ihnen suchen zu können. Durch jedes Metadatum wird dabei eine bestimmte Perspektive definiert, nach der gesucht werden kann.

Informationen für Metadaten klassifizieren

Es hat sich für die Technische Dokumentation  bewährt, die Handbuch-Typen (Betriebsanleitung, Serviceanleitung,Schulungshandbuch usw.) und die nach Maschinenrichtlinie erforderlichen Kapitel (Installation/Inbetriebnahme, Bedienung,Fehlerbehebung usw.) in zwei Meta-Informationen anzugeben. Welche anderen Metadaten zusätzlich sinnvoll sind, kann je nach Anwendungsfall sehr unterschiedlich sein.

Für Firmen mit einer konkreten Produktstruktur nach Produktklassen und -gruppen, mit wenigen Zusatzoptionen und ohne Varianten, die sehr umfangreiche Dokumentationen erstellen (z. B. im Flugzeugbau), ist es sinnvoll, in den Modulen die Produktzugehörigkeit anzugeben. Ist die Produktpalette einer Firma sehr breit gefächert, variantenreich und der Innovationsgrad sehr hoch, wird die Produkt-Kennzeichnung in der Vielzahl kleiner, allgemeingültiger Module zu aufwendig. In diesem Fall empfiehlt es sich, bestimmte Produkt-Merkmale und -Funktionen als Kennzeichnung zusammenzustellen.

Da nicht nur die Dokumentationsabteilung mit der Produktvielfalt umgehen muss, sondern die Produktionsplanung und Fertigung davon genauso betroffen sind, lohnt es, sich in anderen Betriebsbereichen anzuschauen, wie dort die Vielfalt der Produkte handhabbar klassifiziert wird.