Technische Dokumentation: Modularisierung mit System(en)

Modulare Dokumentation bringt Vorteile: “Einmal geschrieben, mehrmals verwendet” reduziert nicht nur den Aufwand (Zeit und Kosten), sondern erhöht auch die Sicherheit der Prozesse und die Qualität der Inhalte. Änderungen erfolgen nur einmal an einer zentralen Stelle und nicht mehrmals in vielen Bedienungsanleitungen.

Obwohl bei Redakteuren und Verantwortlichen weitgehend Konsens über den Nutzen einer Modularisierung herrscht, lässt die Umsetzung oft auf sich warten. Das ist kein Wunder, denn diese Umsetzung bedeutet zuerst einmal Aufwand, bis man vom Ergebnis profitiert.

Wie groß soll ein Modul sein? In der Praxis findet man eine große Bandbreite von Modulgrößen: vom einzelnen Kapitel bis zum kleinsten Textabschnitt. Je kleiner das Modul, desto größer der Verwaltungsaufwand. Ein Modul zu erstellen, ist ein Verwaltungsakt. Dieses Modul muss eine Bezeichnung erhalten. Weitere Informationen wie Status, Version, Attribut werden mit eingepflegt. Bei der Wiederverwendung des Moduls steigt tendenziell der Aufwand im umgekehrten Verhältnis zur Modulgröße. Empfehlenswert sind daher Einheiten, die größer als eine Seite (z. B. ab Überschriftsebene 2 oder 3) sind.

Aber Modul ist nicht immer gleich Modul, denn es geht um unterschiedliche Informationstypen und -zwecke, was wiederum die Granularität und den Inhalt der Module beeinflusst. Es gibt zum einen weitgehend produktübergreifende Module mit allgemeinen Informationen, die relativ groß sein können (ein ganzes Kapitel). Beispiele hierfür sind allgemeine Sicherheitshinweise, Hinweise zum Transport oder zur Entsorgung oder in einem Softwarehandbuch ein Abschnitt über die Schreibkonventionen. Auf der anderen Seite gibt es Module, die eine bestimmte Funktion oder eine konkrete Handlung beschreiben. Diese Module sind oft etwas kleiner.

Hat man ein Konzept über die Größe der Module festgelegt, dann muss man noch diese Module erstellen. Aus vorhandenem Material lassen sich wiederverwendbare Teile identifizieren und vereinheitlichen. Komponenten von Maschinenfamilien, Fahrzeugen, Anlagen, Softwareprodukten werden selten komplett neu entwickelt. Auch in der Fertigung gibt es modulare Entwicklungskonzepte. Diese Tatsache kann sich der Redakteur zunutze machen. Aus vorhandenen Dokumentationen kann er folgende Modultypen generieren:

  • Einmalige Module, die nur für eine Anlage gelten.
  • Module allgemeiner Natur wie Sicherheitshinweise, die in allen Dokumentationen eingesetzt werden.
  • Module, die potenziell in mehreren Dokumenten wiederverwendbar sind.

In der letzten Gruppe steckt das größte Potenzial. Die Herausforderung besteht nun darin, aus den vielen unterschiedlichen Formulierungen universell einsetzbare Module zu erstellen. Im Grunde haben wir hier folgende Situationen:

  1. Die Unterschiede zwischen den einzelnen Varianten sind relativ gering. Sie sind zum Teil rein sprachlich (unterschiedlicher Stil und Terminologie). In solchen Fällen ist die Vereinheitlichung der Versionen zu einem einzigen Modul relativ einfach zu bewältigen.
  2. Es gibt deutliche Informationsunterschiede, obwohl die Funktion oder die Komponente verwandte Aufgaben erfüllen soll. Diese Unterschiede können sein: andere Bezeichnungen oder Maße, zusätzliche Funktionen oder Leistungen bei einer Produktvariante, besondere Bedienhinweise von Fall zu Fall, andere Abbildungen. Hier hat man grundsätzlich die Option, a) entweder zwei Module zu produzieren, wenn die Unterschiede nicht überbrückbar sind, b) mit bedingtem Text zu arbeiten (wenn die eingesetzten Werkzeuge dies unterstützen) oder c) die Varianten klar als Alternative im Modul darzustellen: “Wenn Sie die Maschine ABC123 haben, dann Handlung 1, wenn Sie die Maschine ABC456 haben, dann Handlung 2.”

Zwangsläufig geht das Thema Standardisierung mit dem Thema Modularisierung einher. Wir würden hiermit den Rahmen dieses Artikels sprengen, aber das bedeutet:

  • Es gibt eine standardisierte Terminologie, die alle an der Dokumentation Beteiligten verwenden. In dieser Terminologie werden auch verbotene Benennungen erfasst.
  • Es gibt einen Style Guide mit Anweisungen über Satzlänge, Anzahl der Nebensätze, Formulierung von Befehlen usw. Es gibt zusätzlich Qualitätssicherungsmaßnahmen, um zu gewährleisten, dass unterschiedliche Autoren einheitliche Dokumente produzieren.
  • Es gibt standardisierte Layoutvorlagen.
  • Es gibt einen standardisierten Informationsaufbau, z. B. über die Art und Weise wie Handlungsanweisungen formuliert sind.

Wie soll ein modulares System aussehen? Je nach Investitionsbereitschaft, Beschaffenheit der Dokumentation und Prozessen gibt es unterschiedliche Ansätze. Eine schlichte Lösung besteht in der Verwaltung von Mikro-dokumenten, die einzeln zusammengelegt sind. Zur Ablage und Benennung der Mikrodokumente (ein Dokument = 1 Modul) dient eine Nomenklatur, die Produkte und deren Einsatz widerspiegelt. Größer ausgelegte Lösungen basieren auf Redaktionssystemen, für die es wiederum eine große Bandbreite von Varianten gibt [1] .

Wenn das Konzept einmal steht, ist die Umsetzung die größte Hürde. Bei mangelnden internen Ressourcen kann man immer einen externen Dienstleister mit der Migration der Dokumentation bzw. mit Teilaufgaben beauftragen, was aber nicht ganz ohne interne Ressourcen für die Betreuung geht. Zu empfehlen ist ein Start mit einem überschaubaren und nicht zeitkritischen Pilotprojekt, um zuerst Erfahrungen zu sammeln und das Konzept zu verfeinern.

[1] “Effizientes Informationsmanagement durch spezielle Content-Management-Systeme”, CMS-Studie (2. Auflage), tekom 2008, Prof. Wolfgang Ziegler, Daniela Straub

[D.O.G. Dokumentation ohne Grenzen GmbH. Quelle: D.O.G. news 4/2011, Wiedergabe mit freundlicher Genehmigung von Dr. François Massion.]