Die Vorteile von Modularisierung in der Technischen Dokumentation

Ist es sinnvoll, Bedienungsanleitungen für langlebige Produkte zu modularisieren? Ein klares JA, denn Modularisierung, das heißt etwas Großes in kleine Bausteine aufzuspalten, trägt direkt zur Qualitätssicherung der Produkte und der dazugehörigen Bedienungsanleitungen bei. Einmal an einer zentralen Stelle geändert, standardisiert und vor allem modularisiert, kann beispielsweise eine Bedienungsanleitung immer wieder verwendet werden. Wann aber kann man sich diesen Schritt in der Technischen Dokumentation sparen?

Welche Herausforderungen in der Technischen Redaktion machen Modularisierung sinnvoll?

Da die Anforderungen an die Technische Redaktion stetig steigen, müssen auch wir als Redakteure unsere Arbeitsweise laufend anpassen, um den rasanten Entwicklungen in der Industrie gerecht werden zu können. Durch kürzere Lieferzeiten und immer kürzere Produktzyklen sehen sich viele Firmen gezwungen, immer mehr Druck auf uns Technische Redakteure auszuüben. Denn ohne eine Betriebsanleitung darf kein Produkt das Firmengelände verlassen. Da heutzutage auch in der Entwicklung von Maschinen modular gearbeitet wird, indem identische Baugruppen (beispielsweise in der Automobilindustrie) in verschiedenen Maschinen und Anlagen verbaut werden, hat sich eine ähnliche Idee zu einem arbeitsfähigen Konzept in der Technischen Redaktion entwickelt. Denn die Herausforderungen, denen sich die Technischen Redakteure stellen müssen, äußern sich vor allem darin, dass immer mehr Anleitungen in kürzerer Zeit erstellt werden müssen, meist in mehreren Sprachen und mit vermehrten Änderungsdurchläufen. Die Lösung dafür ist das Konzept der Modularisierung und die daraus resultierende Automatisierung von Redaktionsprozessen. Doch was ist Modularisierung überhaupt?

Modularisierung einfach erklärt

Modularisierung bedeutet, etwas Großes in kleine Bausteine aufzuspalten. Diese Bausteine bilden das große Ganze, in diesem Fall eine Betriebsanleitung. Diese einzelnen Bausteine, die Module, werden an einem zentralen Ort abgelegt und verwaltet, beispielsweise in einem Content Management System (CMS). Ein CMS ist dabei vergleichbar mit einer Datenbank. Dies ermöglicht es, die Vielzahl an Modulen zu organisieren, wiederzufinden und zu pflegen. Das Konzept macht es möglich, die vielen kleinen Bausteine nicht nur zu einer Dokumentation, sondern zu möglichst vielen verschiedenen Dokumenten zusammenzustellen und den Zeit- und Arbeitsaufwand so gering wie möglich zu halten. Es bietet den Vorteil der Zeitersparnis und Kostenreduzierung. Erreicht wird dies durch die Wiederverwendbarkeit der Module. Ein Modul muss nur einmal erstellt werden und kann idealerweise für viele verschiedene Dokumente gültig und verwendbar sein. Da die Module an einem zentralen Ort liegen und auch von dort aus verwaltet werden, ist es sehr einfach, technische Änderungen einzupflegen, ohne Redundanzen zu generieren. Ändert sich beispielsweise die Bezeichnung eines Bauteils, kann diese im entsprechenden Modul geändert werden. Diese Änderung zieht sich dann nicht nur durch das Modul selbst, sondern auch durch alle Dokumente, in denen dieses Modul verwendet wird. So wird gewährleistet, dass die neue oder geänderte Information an allen relevanten Stellen vorhanden ist und keine Fehler unterlaufen, weil ein Dokument bei der manuellen Anpassung vergessen wurde.

Vorteile der Modularisierung

Wieso Modularisierung so sinnvoll und hilfreich ist, zeigen unterschiedliche Beispiele aus dem Arbeitsalltag des Technischen Redakteurs. Sobald eine Änderung an einem Dokument notwendig ist, wird diese in die entsprechenden Dokumente eingefügt. Geschieht dies manuell von Hand durch Ändern der verschiedenen Dokumente, schleichen sich häufig Inkonsistenzen ein oder ein komplettes Dokument wird übersehen und enthält somit veraltete Informationen. Diese Fehlerquellen werden durch das Prinzip der Modularisierung deutlich verringert, wenn nicht gar komplett ausgemerzt. Kommt ein neuer Auftrag herein, kann zudem mit einem Grundgerüst (einer vorgefertigten Struktur aus Modulen) begonnen werden, wenn beispielsweise ganze Kapitel als Module eingefügt werden können und nur noch geringfügige Neuerungen oder Handlungen zu beschreiben sind. Zudem reduzieren sich Übersetzungskosten, denn einmal übersetzt kann das Modul 1:1 in verschiedenen fremdsprachlichen Dokumentationen verwendet werden. Durch Reduzierung von Inkonsistenzen werden die Kosten nochmals reduziert, ähnlich wie bei der Pflege der Daten.

Wie wird eine Betriebsanleitung modularisiert?

Dadurch, dass auch in der Produktentwicklung häufig modular gearbeitet wird, sind die technischen Änderungen zwischen mehreren Produktvarianten meist gering, sodass folglich auch in der Dokumentation nur geringfügige Änderungen einzufügen sind. Modularisierung macht dann Sinn, wenn ein Fall wie der hier beschriebe vorliegt und es sich um viele wiederverwendbare Informationen handelt. Betriebsanleitungen, die beispielsweise lediglich aus vier Seiten bestehen und nur einmalig erstellt werden müssen, da es keine weiteren Produkte gibt, eignen sich eher weniger für das Konzept, da keine Möglichkeit der Wiederverwendung gegeben ist. Der Arbeitsaufwand bei der Erstellung der Module mag zu Anfang mehr erscheinen, jedoch stellt sich nach einiger Zeit eine deutliche Verringerung des Zeit- und Kostenaufwands ein, da das Erstellen von Anleitungen teilweise automatisiert werden kann.

Das Konzept der Modularisierung kann auf ganze Dokumente, Kapitel, Absätze, Sätze, Wörter oder Daten angewandt werden. Hierbei muss darauf geachtet werden, welche und wie viele Produktvarianten es gibt und wie sinnvolle Module erstellt werden können. Bis wohin Modularisierung Sinn macht, muss jedes Mal neu entschieden werden. Teilweise ist es nützlich, ein gesamtes Kapitel als Modul anzulegen, da es immer gleich ist. Als Beispiel kann man das Kapitel „Zu dieser Betriebsanleitung“ anführen, in dem generelle Informationen zum Umgang mit der Betriebsanleitung beschrieben sind. Somit entfällt die erneute Erstellung, wenn ein neuer Auftrag kommt und eine Technische Dokumentation erstellt werden muss.

Sinnvoll kann es auch sein, kleinere Bausteine wie Warnhinweise anzulegen, denn diese können öfters in der Dokumentation vorkommen und die doppelte oder dreifache Erstellung kann sich der Technische Redakteur sparen. Zu klein sollte jedoch nicht modularisiert werden, da der Verwaltungsaufwand dadurch deutlich zunimmt, man sich häufig verstrickt und sich irgendwann nicht mehr in seinem System zurechtfindet. Daher ist es wichtig, klare Regeln festzulegen, was genau wie in Module aufgespalten wird und was nicht. Die Grundregeln bestehen darin, dass immer nur ein Thema pro Modul behandelt wird und der Inhalt dieses Themas innerhalb dieses Moduls abgeschlossen ist.

Die Module müssen leicht wiederauffindbar sein, gerade wenn mehrere Technische Redakteure im Team arbeiten. Schon bei der Erstellung muss außerdem über die Wiederverwendbarkeit des Moduls nachgedacht werden. Wenn Module allgemeingültig formuliert sein sollen, ist es wichtig, dass weitestgehend auf Nennung von spezifischen Produktinformationen verzichtet wird. Es sollten möglichst neutrale Formulierungen verwendet werden, sodass das Modul so häufig wie möglich verwendet werden kann.

Wie behalte ich bei den Modulen den Überblick?

Mit den meisten Content Management Systemen ist es möglich, Produktvarianten in Modulen abzubilden, indem mehrere Fragmente zum selben Thema aber zu unterschiedlichen Produktvarianten in einem Modul zusammengefasst werden. Dies kann durch die Vergabe von Metadaten geschehen, die die einzelnen Module klassifizieren und die sich später bei der Ausgabe als Datei durch das Setzen von Filtern im CMS ausgeben lassen. Auch die Versionierung und die Erkennbarkeit, in welchem Dokument ein Modul verwendet wird, sind wichtige Aspekte, denn nicht immer ist eine Änderung eines Moduls in jedem Dokument sinnvoll, da in diesem vielleicht noch ein älterer Stand aktuell ist und auch bleiben soll. Die Anschaffungskosten eines solchen CMS reichen von gering bis sehr hoch. Das Prinzip eines solchen Systems ist generell aber immer dasselbe.

Die Funktionen sind im Allgemeinen:

• Inhalte erfassen und bearbeiten • Module wiederverwenden • Module verwalten • Module auffinden und auflisten • Module anzeigen • Inhalte mit Verweisen verknüpfen • Inhalte freigeben und versionieren • Inhalte übersetzen und lokalisieren • Dokumente in verschiedenen Formaten ausgeben

Kothes, Lars (2010, 233): Grundlagen der Technischen Dokumentation. Anleitungen verständlich und normgerecht erstellen. Berlin Heidelberg: Springer

Auch mit Microsoft Word ist es möglich, modulare Dokumentationen zu erstellen. Dies funktioniert durch die Verlinkung von Dokumenten, die einmalig erstellt und an einem zentralen Ort abgelegt werden müssen. Sinn macht dieses Prinzip, wenn nicht allzu viele verschiedene Produkte produziert und vertrieben werden und die Kosten für ein CMS nicht getragen werden können. Generell empfiehlt sich jedoch der Kauf eines solchen Systems, denn der Nutzen ist enorm und auch die Variantensteuerung wird erheblich vereinfacht.

Fazit Zusammenfassend ist die Modularisierung in der Technischer Dokumentationen sinnvoll, jedoch muss auf die Produktspannweite geachtet werden. Nur bei einem hohen Wiederverwendungswert ist das Prinzip der Modularisierung sinnvoll. Wird es dann aber konsequent angewandt, bietet es Zeit- und Kostenersparnisse und eine Entlastung der Technischen Redakteure. Sie können sich somit um die Erstellung anderer Dokumente kümmern. Außerdem wird bei Neuerstellung einer Betriebsanleitung nicht mehr bei 0 begonnen, da das Grundgerüst aus Modulen schon steht.

Kontakt: 0431 - 888 2111 0

E-Mail: marketing@scope-engineering.de

  • YouTube
  • Twitter
  • XING
  • LinkedIn

© 2020 SCOPE Engineering GmbH

Impressum

Datenschutz

Kontakt

SCOPE Engineering Website       I       test!t     I     t(ea)talk     I     Dezentrales Arbeiten