Wissen >> Modularisierung

Modularisierung

Modularisierung: Inhalte zerlegen

Ganz allgemein gesprochen heißt Modularisierung, dass ein Ganzes in Teile aufgeteilt wird. In der Technische Dokumentationn wird dies umgesetzt, indem Inhalte von z. B. Handbüchern oder Bedienungsanleitungen in kleine Bausteine (sog. Module) zerlegt werden. Diese Bausteine können einzelne Absätze, ganze Kapitel oder Abbildungen sein.

Anschließend sind in einem Baustein alle wichtigen Informationen zu einem bestimmten Thema enthalten. Diese in sich schlüssigen Informationseinheiten können dann nach dem Single-Source-Publishing in mehreren Dokumenten und an verschiedenen Stellen wiederverwendet werden. So entsteht ein Handbuch aus mehreren zusammengesetzten Modulen.

Beispiel 1

Ein einfaches Beispiel für ein solches Modul ist das Impressum. Es ist in jedem Dokument eines Herstellers enthalten und hat immer denselben Inhalt. Bei der Modularisierung wird das Impressum einmalig erstellt und nach dem Single-Source-Prinzip in jedem Handbuch wiederverwendet.

Beispiel 2

Für ein komplexeres Beispiel der Modularisierung gehen wir von einem Produkt mit verschiedenen Variationen aus: Für drei Varianten einer Maschine soll jeweils eine Betriebsanleitung erstellt werden. Anstatt nun drei verschiedene Anleitungen separat zu entwickeln, versucht man das Gerüst eines Dokuments zu entwerfen, das allen Baureihen genügen kann. Anschließend zerlegt man dieses Grundgerüst in Module, sodass allgemeingültige und variantenabhängige Teile voneinander getrennt sind.

Die Modularisierung erfolgt also keinesfalls willkürlich. Stattdessen muss vorher eine Analyse des Produkts bzw. Dokuments stattfinden, die viel Planung und Weitsicht erfordert. Sie wird von speziell ausgebildeten Technischen Redakteuren vorgenommen.

Einsparungen durch Wiederverwendbarkeit

Diese Vorgehensweise spart Zeit und Geld – insbesondere bei der Übersetzung! Denn gleichartige Inhalte müssen nur einmalig erstellt (und übersetzt) werden und können an entsprechender Stelle einfach eingesetzt werden.

Auch die Erstellung neuer Dokumente für ähnliche Produkte wird durch Modularisierung erheblich beschleunigt. Nicht zuletzt wird auch die Qualität aller Dokumente gesteigert, da sie ein einheitliches Erscheinungsbild haben und der Wiedererkennungswert für den Leser steigt.

Daher bietet Modularisierung in folgenden Fällen die größten Vorteile:

  • Mehrere Varianten eines Produkts oder ähnliche Produkte werden dokumentiert.
  • Dokumente werden in verschiedenen Zielformaten im Print- oder Online-Bereich benötigt.
  • Dokumentation wird in unterschiedliche Sprachen übersetzt.