Modularisierung im CMS: Wie finde ich den richtigen Weg?

In unserem vergangenen Beitrag „Die Vorteile von Modularisierung in der Technischen Dokumentation“ haben wir gelernt, dass Modularisierung in der technischen Dokumentationen sinnvoll ist, wenn man dabei die Produktspannweite beachtet.

Modularisierung trägt ganz klar zur besseren Qualitätssicherung bei. Denn so können Textbausteine, die einmal standardisiert und an einer zentralen Stelle abgelegt wurden, in verschiedenen Bedienungsanleitung immer wieder verwendet werden. Wenn man es richtig macht... Denn nur ein sorgfältiger und gut durchdachter Modularisierungsprozess von Textbausteinen kann Kosten sparen und den dafür notwendigen Aufwand im Rahmen halten. Die Module müssen letztendlich für viele verschiedene Produkte passen. Und das ist nicht einfach.

Um ein solches Projekt erfolgreich umzusetzen muss zunächst ein Fahrplan erstellt werden. Dieser benennt, was genau modularisiert werden soll. Hier kann ein Redaktionssystem äußerst hilfreich sein. Viele Unternehmen setzen schon jetzt ein CMS, wie z.B. SCHEMA ST4 ein. Aber welche Vorteile hat ein solches Content Management System? Einige wirklich wichtige möchte ich hier auflisten:

1. Wiederverwendbarkeit: Einzelne Bausteine können gespeichert werden und auch Bilddateien können mit Stichworten versehen und so leichter auffindbar gemacht werden

2. Layout: Die Arbeit des Technischen Redakteurs ist nicht ein schickes, sondern ein inhaltlich richtiges und gut strukturiertes Handbuch oder eine Bedienungsanleitung zu erstellen. Mit einem CMS kann er sich voll und ganz auf den Inhalt konzentrieren.

3. Qualitätssicherung: Arbeitspakete, die einer Prüfung bedürfen können über eine Freigabestruktur (mit Namen und Datum) kontrolliert und mit Freigabestatus versehen werde.

Man sieht, die Vorteile der Nutzung eines CMS sind bedeutend. Jedoch kann das beste System nur dann erfolgreich arbeiten, wenn es auch richtig gefüttert wurde. Und hierfür ist die Modularisierung ein entscheidender Erfolgsfaktor.

Was Modularisierung ist und warum ich diese anwenden sollten, wurde bereits in unserem Beitrag „Die Vorteile von Modularisierung in der Technischen Dokumentation“ behandelt.

Wie aber finde ich die richtige Modularisierung?

Struktur – Struktur – Struktur! Als Nutzer eines CMS haben wir eine ganz einfache Traumvorstellung. Wir wollen einen Dokumentbestand komplett aus einer Vielzahl von Modulen zusammenzusetzen können. In der Praxis klappt das aber nicht immer. Denn einerseits müssen die Module logisch sortiert und auffindbar sein. Andererseits kann es bei einer Vielzahl an Textbausteinen zu langen Suchvorgängen kommen. Das passiert immer dann, wenn diese nicht richtig abgelegt oder sortiert wurden. Und noch eine Stolperfalle gibt es: Manche Textstelle wird nur einmal in einem einzigen Dokument gebraucht. Wer jetzt aber meint, dass eine Modularisierung keinen Sinn, irrt sich! Denn minimale Variationen lassen sich durchaus systematisch vorhersehen. Zum Beispiel wenn sich in einem Modul nur bei jedem Enddokument die Produktbezeichnung oder die Beschriftung eines Oberflächenelements ändert. Für solche systematischen Unterschiede kann man dann nämlich Platzhalter in den Modulen anlegen. Erstellt man das Enddokument, werden die Platzhalter dann mit der jeweils notwendigen Variable befüllt.

Um Module also leicht und zeitsparend im CMS auffindbar zu machen, sollten folgende Dinge brachtet werden.

1. Bei der Größe der Module sollte man mit einer Modulgröße von zwei bis drei Absätzen arbeiten oder ganze Kapitel als Module definieren, wenn sie in identischer Form immer wieder in den Enddokumenten auftauchen.

2. Die Verwaltungsstruktur der Dokumente im System muss strikt eingehalten werden

3. Alle Nutzer müssen in das CMS eingeführt werden und die Versionierungsvorgaben beachten

Was bedeuten modulare Inhalte für das CMS?

Die Modularisierung von Inhalten führt zu einer Steigerung der Qualität der Dokumentationsprodukte und der Redaktionsprozesse. Verwendet man ein XML-Redaktionssystem wie SCHEMA ST4, kann dieses strukturierte, modulare Inhalte automatisch interpretieren und beispielsweise pro Zielformat gezielt Layouts festlegen. Somit steuert man jedes Ausgabeformat, jede Fremdsprache zentral und geht durch wählbare Layoutformate auf Nummer sicher.

Wir sehen: Modularisierung ist ein mächtiges Werkzeug, um Anleitungen zu erstellen. Mit dem CMS und einem gut ausgearbeiteten Plan kann man hiermit durchaus effizient arbeiten. Der Redakteur kann sich viel mehr seinen eigentlichen Aufgaben widmen und Inhalte erstellen bzw. auf Vollständigkeit prüfen.