Modularisierung für Einsteiger

Normalerweise schreibt man einen Text, beispielsweise einen Roman, komplett von Anfang bis Ende. Das ist deshalb sinnvoll, weil sich bei den meisten Texten keine oder nur wenige Passagen wiederholen. In der Technischen Dokumentation (aber auch bei vielen anderen beruflichen Schreibaufgaben) ist das anders.

Das erklärt sich am einfachsten, wenn man sich einmal die Warnhinweise in einer Anleitung ansieht. Wenn beim Umgang mit einem Produkt eine Gefahr besteht, dann muss die Anleitung auch vor dieser Gefahr warnen. Dabei reicht es nicht, nur an einer einzigen Stelle zu warnen. Denn dieselbe Gefahr kann ja bei ganz unterschiedlichen Bedienvorgängen auftreten und wir können nicht davon ausgehen, dass der Kunde oder die Kundin die Anleitung immer komplett von Anfang bis Ende durchliest. Normalerweise ist es eher so, dass man nur den Teil der Anleitung liest, den man gerade braucht. Und in diesem Teil muss dann auch der Warnhinweis enthalten sein.

Im Endeffekt führt das nun dazu, dass dieselbe Textpassage in der Anleitung immer wieder vorkommt. Deshalb ist es sinnvoll, diese Passage (also z.B. den Warnhinweis) nur einmal zu schreiben und dann an den entsprechenden Stellen immer wieder einzufügen.

Das ist auch deshalb sinnvoll, weil die Textpassage, die wir so isoliert haben, vermutlich nicht nur in der Anleitung für ein einziges Gerät gebraucht wird. Andere Geräte haben vermutlich vergleichbare Gefahrenquellen – man kann den Baustein also in den Anleitungen für viele verschiedene Produkte verwenden.

Ein Vorteil der Modularisierung ist nach dem Beispiel oben bereits klar zu sehen: Eine ausgegliederte (modularisierte) Passage muss nur einmal geschrieben werden, obwohl sie in den fertiggestellten Dokumenten an vielen verschiedenen Stellen vorkommt. Das kann in der Summe und bei großen Dokumentmengen schon eine deutliche Zeitersparnis ausmachen.

Die Zeitersparnis beim Schreiben ist dabei allerdings nur ein Aspekt. Viel wichtiger ist, dass sich das Modul leichter überarbeiten lässt. Sehen wir uns einmal an, was notwendig ist, wenn ich dieselbe Passage in linearen Texten überarbeiten muss. In diesem Fall muss ich zunächst sämtliche Dokumente identifizieren, in denen diese Passage vorkommt. Danach muss ich sämtliche Stellen finden, an denen diese Passage auftaucht. Und zu guter Letzt muss ich den Text an allen Stellen in der gleichen Form ändern. Mit einem Modul dagegen brauche ich nur einmal zu ändern und das richtige Modul wird dann automatisch in alle Dokumente übernommen.

Außerdem ist Modularisierung wünschenswert, weil dadurch immer ein einheitlicher Standard eingehalten wird. Beim linearen Schreiben schleichen sich leicht Variationen der (eigentlich) gleichen Textpassage ein. Manchmal sind diese Variationen belanglos; sie können aber auch Ungenauigkeiten und Fehler enthalten. Das vermeidet man, wenn man die Passage nur an einer Stelle vorhält und dann immer wieder einbindet.

Den größten Vorteil bietet Modularisierung allerdings bei der Übersetzung. Übersetzungskosten können oft ein Mehrfaches der Kosten für die Originalanleitung ausmachen. Durch die Wiederverwendung, die die Modularisierung ermöglicht, entfällt ein großer Anteil des Übersetzungsvolumens. Denn dieselbe Textpassage wird nicht immer wieder und wieder übersetzt. Stattdessen wird sie nur einmal übersetzt und dann an vielen Stellen mehrfach verwendet.

Idealerweise schafft man es also, seinen Dokumentbestand komplett aus einer Vielzahl von Modulen zusammenzusetzen. In der Praxis wird das nicht immer klappen. Denn manchmal wird eine Textstelle wirklich nur einmal in einem einzigen Dokument gebraucht.

Dann gibt es wieder Textpassagen, die sich nur minimal von Produkt zu Produkt unterscheiden. Das ist ärgerlich, lässt sich aber in vielen Fällen handhaben. Denn oft sind diese minimalen Variationen systematisch vorhersagbar. Zum Beispiel ändert sich dann in dem Modul nur bei jedem Enddokument die Produktbezeichnung oder die Beschriftung eines Oberflächenelements. Für solche systematischen Unterschiede legt man am besten Platzhalter in den Modulen an. Erstellt man das Enddokument, werden die Platzhalter dann mit der jeweils notwendigen Variable befüllt.

Bei der Größe der Module sollte man einen möglichst hohen Umfang anstreben. Denn auch wenn die Wiederverwendung Zeit spart, kostet sie doch an einer anderen Stelle. Jedes Modul muss für das Enddokument aufgefunden (und danach verwaltet) werden. Je kleiner das Modul ist, desto höher wird aber der Verwaltungsaufwand. Das lässt sich mit einem Extrembeispiel nachvollziehen: Im Prinzip könnte man ja jedes einzelne Wort einer Anleitung als eigenes Modul definieren. Aus diesen Modulen könnte dann die Anleitung zusammengesetzt werden. Allerdings wäre der Aufwand, die einzelnen Wörter zu finden viel höher als der Nutzen, den man durch die Wiederverwendung haben könnte. Dasselbe gilt auf allen Ebenen: Je kleiner das Modul, desto höher die Wiederverwendung, aber desto höher auch der Verwaltungsaufwand. Im Allgemeinen wird man deshalb bei einer Modulgröße von zwei bis drei Absätzen landen. Allerdings spricht auch nichts dagegen, ganze Kapitel als Module zu definieren, wenn sie in identischer Form immer wieder in den Enddokumenten auftauchen. Das ist zum Beispiel bei den Hinweisen zur Entsorgung oder bei den Garantiebedingungen so, die in (nahezu) gleicher Form in allen Anleitungen verwendet werden. Wo also die optimale Modulgröße liegt, entscheidet sich am konkreten Dokumentmaterial und an der Wiederverwendbarkeit der Content-Elemente.

Modularisierung ist ein mächtiges Werkzeug, um effizient Anleitungen zu erstellen. Aber auch bei anderen Textsorten kann es sinnvoll sein zu modularisieren. Doch bevor man sich zu diesem Schritt entscheidet, sollte man prüfen, ob der eigene Content dazu geeignet ist. Denn auch bei modularer Texterstellung entstehen Aufwände. Dieser Blogpost gibt Ihnen erste Informationen, für die Beurteilung Ihres Contents. Im Zweifelsfall kann aber auch eine Bewertung durch externe Content- und Modularisierungsexperten sinnvoll sein.