Wer mit einem CMS arbeitet und vielleicht sogar mit SCHEMA ST4, dem ist modularer Content bekannt. Inhalte bestehen in diesen Systemen aus einzelnen Bausteinen oder Modulen, die zusammengesetzt das Gesamtdokument ergeben. Ein einzelnes Modul kann aber auch für sich alleine stehen und als einzelne HTML-Seite am Bedienpult einer Anlage oder auf einem Tablet angezeigt werden. Dieses grundlegende Konzept der Modularisierung ist sehr wichtig für Technische Redaktionen und bringt viele Vorteile mit sich. Wir möchten Ihnen heute fünf davon vorstellen.
Während man beim linearen Schreiben von z. B. Word-Dokumenten oft nur durch Copy & Paste Inhalte in anderen Kontexten wiederverwenden kann, wird es beim modularen Schreiben wesentlich komfortabler. Ein Modul wird einmal erstellt und dann in unterschiedlichen Kontexten wiederverwendet. Ändert der Redakteur den Inhalt des Moduls, wird diese Änderung dynamisch an allen Wiederverwendungsstellen übernommen. Die Verknüpfung zwischen dem Modul und seinen Wiederverwendungen gilt über alle verwendeten Fremdsprachen, Varianten und Dokumentarten hinweg. Das Modul steht dabei für sich, um in verschiedenen Kontexten verwendet werden zu können.
Gute Beispiel-Module sind die Funktionsbeschreibung und die Montageanleitung eines Bauteils bzw. spezifischen Abschnitts einer Anlage. Wenn dieses Bauteil bzw. dieser Abschnitt der Anlage in anderen Anlagen auch verwendet wird, kann in der Dokumentation das entsprechende Modul ebenfalls wiederverwendet werden.
Jedes Modul trägt Metadaten bei sich, die mit ihrer jeweiligen Ausprägung Informationen über den Typ des Moduls (z. B. Anleitung, Beschreibung), dessen Zielgruppe und über vieles Weitere ausgeben. Als Metadaten bieten sich viele Informationen wie zum Beispiel Produktvarianten oder auch Metadaten aus dem iiRDS-Kontext an. Mit Metadaten können Module also klassifiziert und von computergesteuerten Systemen verwaltet werden - und gleichzeitig kann man dank Metadaten schnell und effizient genau das Modul finden, das man sucht. In einer Suche über Metadaten sucht man in allen Modulen nach Metadaten oder einer Kombination von Metadaten. Das Suchergebnis liefert daraufhin alle relevanten Module. Zum Beispiel alle Module vom Typ "Anleitung" für Variante A, die noch nicht übersetzt sind.
Für ein anschauliches Beispiel kurz zurück zu den Varianten: Eine Anleitung, wie man bestimmte Stammdaten in der Softwarevariante A (z. B. "Premium") anlegt, gilt auch für Softwarevariante B ("Classic"), aber nicht für Softwarevariante C ("Light"). Sind die Metadaten dieses Moduls entsprechend gepflegt, kann man es anhand dieser Kriterien finden. Darüber hinaus wäre es möglich, anhand dieser Metadaten von einem System automatisch Dokumente zusammenstellen zu lassen, die zum Beispiel nur Module für Variante A enthalten.
Wer seinen Content modularisiert, wird früher oder später so einiges standardisieren. Dazu gehören unter anderem einheitliche Textformulierungen, Modultypen und Modulgrößen, ein Ablagesystem für die Verwaltung der Module etc. Für Technischen Redakteure bedeutet das wiederum, dass sie klare Vorgaben für ihre tägliche Arbeit im CMS haben, womit Missverständnissen vorgebeugt und gleichzeitig die redaktionelle Arbeit vereinfacht wird.
Modularisierter Content heißt also fast immer auch standardisierter Content und damit einher geht ein standardisierter Redaktionsprozess. Das wirkt sich positiv auf alle nachgelagerten Prozesse aus.
Zwei weitere Pluspunkte, wenn modulare Inhalte einheitlich aufgebaut sind und eine wiedererkennbare Struktur haben:
Die Modularisierung, Klassifizierung und Standardisierung von Inhalten führen zu einer Steigerung der Qualität der Dokumentationsprodukte und der Redaktionsprozesse.
Inhalterstellung mit einem XML-Redaktionssystem wie SCHEMA ST4 ist medienneutral. Das bedeutet, dass Inhalt, Struktur und Layout Ihrer Ausgabeformate unabhängig voneinander erstellt und bearbeitet werden. Das ermöglicht, dass Inhalte beliebig zusammengestellt werden und erst danach abhängig von dem angestrebten Ausgabeformat ein jeweils individuelles Layout erhalten.
So wird im Falle Software-Dokumentation ein Modul vom Typ Anleitung z. B. sowohl Teil der Dokumentstruktur des Benutzerhandbuchs im PDF-Format sein, als auch Teil einer HTML-Seite, die an eine Oberfläche der Software angebunden ist.
Sie sehen, die Vorteile des modularen Arbeitens sind miteinander verwoben, und unsere Auflistung zählt im Grunde alle Parameter des modularen Arbeitens auf. Die wichtigsten positiven Effekte haben wir Ihnen hier gezeigt, aber Ihnen werden bei der Arbeit damit sicherlich noch weitere auffallen.
"Der Support hat gerade angerufen. In der letzten Auslieferung der Wartungshandbücher sind noch die alten Komponenten…
„Aus eins mach viele!" Das hört sich fast schon ein wenig nach Hexerei an. In unserem XML-Redaktionssystem SCHEMA ST4…
Redaktionelle Arbeit ist spannend! Inhalte optimieren und strukturieren, deren Verwaltung modellieren, das Layout wei…