Ein Redaktionssystem gehört zur Grundausstattung vieler Technikredaktionen. Damit das System seinen Zweck erfüllt, müssen die Inhalte sinnvoll erfasst, strukturiert und publiziert werden. Ein Aspekt spielt dabei eine besondere Rolle: die richtige Modularisierung des Contents. Was genau sich hinter diesem Begriff verbirgt und worauf es bei der praktischen Umsetzung ankommt, erklären wir Ihnen im folgenden Beitrag.
Warum überhaupt modularisieren?
Mehr Produktvarianten, mehr Sprachen, knappe Deadlines:
Die steigenden Anforderungen bei der Dokumentationserstellung verlangen von Technischen Redakteur:innen einen hohen Output. Ein ganz entscheidender Erfolgsfaktor ist dabei das richtige Content-Management. Im Kern bedeutet das: Die Inhalte im Redaktionssystem sollten so organisiert sein, dass sie möglichst effizient wiederverwendet werden können. Die Voraussetzung dafür ist eine sinnvolle Modularisierung der Inhalte.
Wie funktioniert Modularisierung?
Einzelne Content-Module anstatt eines großen fortlaufenden Dokuments – im Redaktionssystem wird üblicherweise modular gearbeitet. Bei den Modulen handelt es sich um Informationsbausteine wie z. B. Unterkapitel, Absätze, Wörter oder Bilder. Je nach Zielgruppe, Produktvariante oder Medienformat lassen sich die einzelnen Module zu individuellen Informationsprodukten kombinieren. Ein zentraler Vorteil der Modularisierung: Bereits erstellte Inhalte können Sie durch unkompliziertes Referenzieren gezielt in anderen Dokumenten wiederverwenden. Das macht es sehr einfach, technische Änderungen in eine Dokumentation einzupflegen, ohne Redundanzen zu generieren. Ändert sich zum Beispiel der technische Wert einer Komponente, brauchen Sie nur das entsprechende Modul anzupassen.
Die Änderung wird nun automatisch an allen Stellen übernommen, an denen eine Verknüpfung zum Originalmodul angelegt ist. Mit diesem Vorgehen reduzieren Sie nicht nur den Erstellungsaufwand, sondern erhöhen auch die Sicherheit Ihrer Prozesse und die Qualität Ihrer Inhalte.
Module und Topics
Besonders effektiv ist dieser modulare Ansatz bei der Verwendung sogenannter Topics. Dabei handelt es sich um Module, die genau ein Thema behandeln und inhaltlich in sich abgeschlossen sind. Topics erfüllen den konkreten Informationsbedarf, den User:innen in einer bestimmten Situation haben – z. B. wenn in einer Software eine Fehlermeldung erscheint. Dadurch, dass Topics unabhängig voneinander sind, können sie leicht in unterschiedlichen Kontexten kombiniert und wiederverwendet werden. Sie werden häufig in der Software-Dokumentation, z. B. in Form von Online-Hilfen, eingesetzt.
Variantenmanagement in der Praxis
Module eignen sich hervorragend dazu, unterschiedliche Varianten eines Produkts sauber zu dokumentieren, wie folgendes Beispiel zeigt: Ein Roboterhersteller vertreibt seinen neuen 6-Achs-Roboter in drei unterschiedlichen Größen. Anstatt für jede der drei Varianten eine eigene Anleitung zu erstellen, erfasst der Technische Redakteur alle Inhalte in einem sogenannten Masterdokument. Module mit größenspezifischen Informationen – etwa zur Montage oder zum Gefahrenbereich – werden im Redaktionssystem mit einem Filter versehen. Bei der Publikation einer Anleitung braucht der Redakteur nur noch den Filter mit der gewünschten Robotergröße auszuwählen, um das richtige Dokument auszuspielen.
Beispiel für Filter in einem Redaktionssystem
Das Prinzip des Masterdokuments ist nur eine von vielen Möglichkeiten, Content-Varianten im Redaktionssystem abzubilden. Wie genau der Content im System strukturiert und verwaltet wird, hängt wesentlich vom verwendeten Informationsmodell ab. Dieses Modell legt fest, nach welchen konkreten Regeln die Module erstellt und klassifiziert werden. Einige der bekanntesten Standards für die Technische Dokumentation sind:
- DITA
- PI-Mod
- DocBook
- S1000D
Wie modularisiere ich richtig?
Beim Thema Modularisierung werden wir oft gefragt: Wie groß sollten die Module einer Anleitung idealerweise sein? Die Antwort hängt zum einen von den Produktvarianten ab, die es zu beschreiben gilt. Weitere wichtige Faktoren sind zum anderen der Umfang und die inhaltliche Struktur der Dokumentation. Kurzum: Das richtige Modularisierungskonzept zu finden, ist eine sehr individuelle Aufgabe.
Grundsätzlich können Sie sich aber folgenden Zusammenhang merken: Wer seinen Content in viele kleine Module aufteilt, wird diese gut in unterschiedlichen Projekten wiederverwenden können. Dafür sollten Sie einen höheren Arbeits- und Zeitaufwand für das Erstellen und Verwalten der Module einplanen.
Bei größeren Modulen sinkt dieser Aufwand, allerdings besteht hier das Risiko, dass die Module projektspezifischen Content enthalten und daher nicht so vielseitig wiederverwendet werden können.
Wie Sie sehen, braucht es Know-how und redaktionelle Erfahrung, um hier das richtige Maß zu finden.
Wann sollte ich modularisieren?
Langlebige Produkte mit einer großen Variantenvielfalt, die immer wieder erweitert wird, lohnen sich besonders für die modularisierte Dokumentationserstellung. Aber auch bei einer überschaubaren Anzahl an Produkten und Ausführungen ist es sinnvoll, über ein passendes Konzept zur Modularisierung nachzudenken. Individuelle Einzelanfertigungen – z. B. im Sondermaschinenbau – eignen sich dagegen weniger für eine modulare Arbeitsweise. Hier kann es wirtschaftlicher sein, die Anleitung in einem einzelnen großen Dokument zu erstellen und nicht unnötig Zeit mit der Verwaltung von Modulen zu verschwenden, die sich ohnehin nicht wiederverwenden lassen.
Standardisierung – das Zauberwort für modulares Content-Management
Standardisierung ist das A und O in der Technischen Dokumentation. Beim Thema Modularisierung heißt das:
Module vom gleichen Typ – z. B. Sicherheitshinweise oder Handlungsanweisungen – sollten einheitlich strukturiert und formuliert werden. Das steigert die Qualität Ihrer Dokumentation und sorgt dafür, dass Sie Module vielseitig einsetzen können.
Gerade bei sprachlichen Feinheiten lohnt ein genaues Hinschauen, denn hier schlummert oft großes Verbesserungspotenzial. Im folgenden Beispiel bietet es sich etwa an, die Angabe der Schraubenanzahl durch den neutralen Ausdruck „alle Schrauben“ zu ersetzen. Dadurch lässt sich der Text ggf. bei anderen Produktvarianten wiederverwenden.
Neutrale Formulierungen können die Wiederverwendung von Modulen erhöhen.
Wichtig dabei ist: Standardisierung sollte nicht allein dem Selbstzweck dienen, sondern konkrete Vorteile bei der Dokumentationserstellung schaffen. Achten Sie zudem darauf, dass beim Vereinheitlichen von Formulierungen keine wichtigen Informationen verloren gehen. Hier hat im Zweifelsfall das Individuelle Vorrang vor dem Standard.
Mit professioneller Unterstützung zur richtigen Modularisierungsstrategie
Schneller und mit weniger Aufwand zu einem besseren Ergebnis: Wer seinen Content richtig modularisiert, kann das Potenzial, das im Redaktionssystem steckt, voll ausschöpfen. Bei der Erarbeitung eines passenden Modularisierungskonzepts sind Weitsicht und ein strategisches Vorgehen gefragt.
Sie haben Fragen rund um das Thema Modularisierung von Technischer Dokumentation oder benötigen konkrete Unterstützung? Kontaktieren Sie mich gerne und wir besprechen gemeinsam die individuelle Situation Ihrer Redaktion.
