Modularisierung in der Technischen Dokumentation

Effiziente Technische Dokumentation von Modellvarianten durch Metadaten

Die Industrie macht es vor: Kaum ein Produktionsprozess läuft heute noch ohne die Verwendung stan­dar­di­sier­ter Komponenten ab, also Modulen, die in un­ter­schied­li­chen Modellvarianten immer wieder ver­ar­bei­tet werden. Bestes Beispiel dafür ist die Automobilbranche. Ein Konzern mit meh­re­ren Marken unter seinem Dach schafft ein Chassis für Kleinwagen, das bei drei Marken je­weils mit un­ter­schied­li­chen Karosseriedesigns und sons­ti­gen Ausstattungen ver­se­hen, sowie unter ver­schie­de­nen Namen ver­kauft wird. Das Modul „Chassis“ ist bei allen Varianten gleich. Auf diese Weise kann der Konzern die Entwicklungs- und Produktionskosten massiv senken.

Kosten senken und Aufwand minimieren durch Modularisierung

Dieses Prinzip lässt sich auch auf die Technische Dokumentation an­wen­den oder bildet viel­mehr die Voraussetzung, wenn ein prak­ti­ka­bles Redaktionssystem vor­be­rei­tet und ge­schaf­fen werden soll. Hier be­stehen die Module al­ler­dings nicht aus ma­te­ri­el­len Gegenständen, son­dern aus Text- und ge­ge­be­nen­falls Grafikbausteinen. Damit Kosten und Aufwand ge­senkt werden können, müssen die ein­zel­nen Module für die Dokumentation mög­lichst vieler Produkte passen. Das kann sehr ein­fach sein, aber auch schwie­rig bis un­mög­lich. Bedeutsam ist dabei die Frage, wie die Größen und die Inhalte der Module fest­ge­legt werden sollen.

Module und Modulgrößen sinnvoll festlegen

Ein Kapitel „Grundlegende Sicherheitshinweise“, bei­spiels­wei­se für eine Smartphone-Modellserie kann für jede Gerätevariante völlig iden­tisch sein und als ein Modul im Redaktionssystem ab­ge­legt werden. Ähnliches gilt für Beschreibungen zur Reinigung und Pflege. Falls mög­lich, lassen sich auch dif­fe­ren­zier­te Sachverhalte durch sprach­li­che Feinheiten an­ein­an­der an­pas­sen. Beispiel: Ein Hersteller bat­te­rie­be­trie­be­ner Radios pro­du­ziert zwei Geräte. Modell A braucht sechs Batterien, das klei­ne­re Modell B nur vier. In den Anleitungen könnte es bei­spiels­wei­se heißen: „Legen Sie die sechs mit­ge­lie­fer­ten Batterien ein“ oder „Legen Sie die vier mit­ge­lie­fer­ten Batterien ein“. In dem Fall haben Sie zwei Textvarianten für zwei Anleitungen. Sie können aber auch schrei­ben: „Legen Sie alle mit­ge­lie­fer­ten Batterien ein.“ Dann haben Sie ein Modul, das Sie für jedes Gerät und für jede Anleitung nutzen können. Bringt der Hersteller später noch Radios mit zwei oder acht Batterien auf den Markt, kann das Modul in deren Bedienungsanleitungen eben­falls un­ver­än­dert in­te­griert werden.

Bei den ge­nann­ten Beispielen han­delt es sich um Module in den Größen „Ganzes Kapitel“ und „Ganzer Satz“. Es können aber auch ein­zel­ne Wörter ein Modul dar­stel­len, etwa Farbbezeichungen für Gehäuse. Eine Redaktion für Technische Dokumentation muss des­halb die Produktpalette eines Kunden und ihre Funktionen genau kennen, um die Modulgrößen sinn­voll festzulegen.

Modulverwaltung mit Metadaten

Der zweite wich­ti­ge Aspekt ist die Verwaltung und Pflege der de­fi­nier­ten Module. Dazu müssen sie nach ihrer Art ka­ta­lo­gi­siert und mit be­stimm­ten Schlüsseln ver­se­hen werden. Diese Metadaten können sich zum Beispiel aus Komponenten zu­sam­men­set­zen, die fol­gen­de Fragen beantworten:

  • Welchen Inhalt hat das Modul?
  • Für welche tech­ni­sche Dokumentation wird es verwendet?
  • Wie ist der Dokumentenstatus?
  • Wer ist der ver­ant­wort­li­che Redakteur?
  • Welche Übersetzungen in andere Sprachen sind be­reits vorhanden?
  • usw.

Wann lohnt sich eine Modularisierung, wann nicht?

Für Produkte, die nur eine kurze Lebenserwartung am Markt haben, ist ein auf­wän­di­ges Modularisierungsverfahren nicht an­ge­bracht. Gleiches gilt für Maschinen und Produktionsanlagen, die von einem Hersteller ganz spe­zi­fisch auf einen Kunden und dessen in­di­vi­du­el­le Arbeitsprozesse zu­ge­schnit­ten werden, also Einzelanfertigungen mit später nicht mehr ver­wen­de­ten Komponenten. Die Modularisierung tech­ni­scher Dokumentationen trägt aber er­heb­lich zur Kostensenkung bei, wenn es sich um lang­le­bi­ge Produkte und Produktreihen han­delt, die von Generation zu Generation nur ge­ring­fü­gig ver­än­dert und immer wieder aus glei­chen Teilen zu­sam­men­ge­stellt werden. Dadurch lassen sich Fehler ver­mei­den und ver­al­te­te Informationen schnell nach­bes­sern. Darüber hinaus er­ge­ben sich auch im Übersetzungsbereich deut­li­che Kostenreduktionen.