Modularisierte Dokumentation - was, wie und warum?

Inhalte

• Was ist modularisierte Dokumentation nicht?
• Was ist dann modularisierte Dokumentation... und wie erreiche ich sie?
• Warum modularisierte Dokumentation?

Was ist modularisierte Dokumentation nicht?

Technische Dokumentationen müssen heute ständig wachsenden Anforderungen genügen. Da sind zum einen die immer umfangreicheren Richtlinien und Bestimmungen des Gesetzgebers und zum anderen anspruchsvollere Kundenwünsche. Aber auch die Globalisierung trägt dazu bei: Immer mehr Unternehmen sind international tätig, Absatzmärkte reichen längst über den europäischen Raum hinaus, und so sind immer mehr Sprachvarianten etwa einer Betriebs- und Wartungsanleitung nötig, die zudem auch noch den jeweiligen örtlichen Vorschriften und Kundenanforderungen genügen müssen.

Das hat zur Folge, dass in vielen Unternehmen heute oft zu einem einzigen Produkt dutzende technische Dokumente in verschiedenen Sprachen existieren, die sich zum Teil nur in Details unterscheiden und so Unmengen redundanter Informationen enthalten. Ist es schon für Redakteure schwierig genug, hier den Überblick zu behalten, wird es für sie erst recht zum Problem, diese Vielzahl von Dokumenten auf aktuellem Stand zu halten. Neue Kolleginnen und Kollegen haben es schwer, sich in den Dschungel an Dokumenten und Informationen einzuarbeiten. Die Folgen sind oftmals Fehler und Inkonsistenzen in der Dokumentation, die nicht nur ärgerlich sind, sondern auch das Image des Herstellers beeinträchtigen und möglicherweise sogar rechtliche Konsequenzen nach sich ziehen können. Hinzu kommen hohe Übersetzungskosten.

Angesichts des wachsenden Wettbewerbs- und Kostendrucks in den Unternehmen ergibt sich hier ein Ansatzpunkt für eine Optimierung, um die Erstellung und Pflege von Dokumenten und Dokumentationen effizient, kostengünstig und fehlerfrei zu gestalten.

Was ist dann modularisierte Dokumentation... und wie erreiche ich sie?

Die Idee ist nicht unbedingt neu: Komplexität reduzieren und Dokumente nach dem "LEGO-Prinzip" in einfach zu handhabende, standardisierte Bausteine zerlegen, die nach Wunsch zusammengefügt werden können.

Was bedeutet Modularisierung für die Technische Redaktion? In der Regel bestehen technische Dokumentationen aus variablen und fixen Inhalten. Das heißt, ein gewisser Anteil in einer Dokumentation ist immer gleich, beispielsweise in einem Handbuch bestimmte die Sicherheitshinweise. Daneben gibt es den Anteil von individuellen Inhalten, die produktabhängig oder von Land zu Land verschieden sind. Bei der Modularisierung zerlegt man diese Inhalte in logische, möglichst wieder verwendbare Einheiten, den Informationsmodulen. Ein Informationsmodul kann also ein Satz, eine Graphik, ein Absatz, eine Seite oder ein ganzes Kapitel über mehrere Seiten sein. Dabei sollte die Größe der Informationsmodule immer so groß wie möglich sein, um die Anzahl der zu verwaltenden Information gering zu halten, aber gleichzeitig so klein wie nötig, so dass redundante Daten vermieden werden. Weiterhin sollte ein Informationsmodul einen hohen Standardisierungsgrad haben. Das bedeutet, Informationen sollten so verfasst werden, dass sie möglichst vielseitig einsetzbar sind, um damit ein breites Spektrum abzudecken. Auf diese Weise lassen sich die Informationsmodule später zur Erzeugung von individuellen, dynamischen Dokumenten verwenden.

Im Unterschied zur LEGO-Bausteinen kann bei digitalen Bausteinen wie den Informationsmodulen ein und dasselbe Modul zeitgleich in mehreren Dokumenten, Dokumententypen oder sogar in ganz verschiedenen Medien verwendet werden, ohne wirklich mehrfach und in unterschiedlicher Form vorhanden zu sein. Dieses Prinzip wird mit Single Source Publishing bezeichnet und ist besonders unter dem Gesichtspunkt der einheitlichen Pflege von Dokumenten und Webinhalten (z.B. Online-Handbücher) interessant. Es ermöglicht die zeitgleiche Änderung mehrerer Dokumente, in dem man lediglich das entsprechende Informationsmodul verändert - ein wichtiger Schritt, um Inkonsistenzen zu vermeiden.

Voraussetzung dafür ist allerdings eine Trennung zwischen Information und Layout sowie eine intelligente systemtechnische Abbildung des Modularisierungsprozesses im Rahmen einer praxisorientiert aufgebauten Softwarewarumgebung, meist einer Datenbank- oder XML-Anwendung. Die Informationsmodule müssen strukturiert und sauber klassifiziert sein, damit sie von den Redakteuren den verschiedenen Dokumenten und Anwendungsformen eindeutig zugeordnet werden können. Umgekehrt muss klar erkennbar sein, welche Module für welches Dokument verwendet werden. Ein wichtiger Punkt ist auch die Versionierung, das heißt die Historie eines Dokumentes oder Moduls muss jederzeit nachvollziehbar sein. Zu Strukturierung und Klassifikation dienen Metadaten, die an Informationsmodulen angeheftet werden. Sie sind Information über die Information. Typische Metadaten zu einem Modul in der technischen Dokumentation sind zum Beispiel die Produkt- oder Baugruppenzugehörigkeit, Sprache, Version, Autor, das Datum der letzten Änderung und nicht zu vergessen der Verwendungsnachweis, der belegt, wo und in welchen Dokumenten das Informationsmodul Verwendung findet.

Das setzt bei dem Anwender einige Vorarbeit voraus, bevor die Modularisierung der Technischen Dokumente spürbare Entlastung bringt. Denn in der Regel bestehen in den Unternehmen ja bereits klassisch produzierte Dokumentationen, die nun zunächst in ihre Einzelteile zerlegt werden müssen. Dabei gilt es, die oben genannten Kriterien für die Größe und den Inhalt eines Informationsmoduls möglichst eng einzuhalten. Das erfordert meist eine sehr genaue Prüfung aller Bestandteile - möglicherweise unter Heranziehung eines Beraters - und gegebenenfalls sogar die Neufassung einzelner Abschnitte, da sie in der vorliegenden Form zur Modularisierung ungeeignet sind.

Warum modularisierte Dokumentation?

Zusammengefasst ergibt sich, dass von einer Modularisierung technischer Dokumentationen insbesondere Unternehmen profitieren, die

• viele verschiedene, zum Teil sehr ähnliche und häufig sich ändernde Dokumente erzeugen und pflegen müssen,
• Dokumentationen in mehreren Sprachvarianten erstellen und verwalten müssen,
• mehrere Veröffentlichungsformen gleichzeitig bedienen wollen.

Einmal implementiert, bringt das Verfahren - das zeigen die Erfahrungen beim Einsatz existierender Systeme zur modularisierten Erzeugung technischer Dokumente - eine Zeitersparnis von bis zu 50 Prozent in der Redaktionsarbeit. Zu dem drastisch reduzierten Aufwand und der damit verbundenen Kosteneinsparung kommt eine verbesserte Qualität der Dokumente. Auch kleinere Unternehmen, die häufig nur einen Technischen Redakteur beschäftigen, können mit der Modularisierung ihre Abläufe optimieren. Da es nicht erforderlich ist, alle Dokumente in einem Unternehmen auf einmal zu modularisieren, kann das herkömmliche Verfahren so lange parallel gefahren werden, bis Schritt für Schritt je nach Bedarf alle Dokumente auf das neue Verfahren umgestellt sind.

Fazit: Modularisierung und Standardisierung der technische Dokumentationen wird - eine gute Redaktionssoftware vorausgesetzt - den Entstehungsprozess technischer Texte um ein Vielfaches effizienter und damit kostengünstiger machen. Die so erzeugten Dokumente weisen in der Regel eine deutlich verbesserte Qualität durch klar definierte Strukturen auf, was zu einer Steigerung der Kundenzufriedenheit und Kundenbindung führt.