5 Vorteile von modularem Content
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.
1 Modul ist in x Kontexten einsetzbar
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.
Module sind dank ihrer Metadaten leichter zu finden und zu verwalten
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.
Modularisierung heißt Standardisierung - und damit besserer Überblick
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 Qualitätssicherung kann in Form des redaktionellen und fachlichen Reviews deutlich vereinfacht und beschleunigt werden. Mit einem XML-Redaktionssystem zum Beispiel beschränken sich Reviews nur noch auf Inhalte, die noch nicht freigegeben wurden. Dank Metadaten an jedem Modul weiß das Redaktionssystem, ob Inhalte bereits redaktionell oder fachlich freigegeben wurden oder nicht.
- Redakteure (und in Content-Delivery-Szenarien auch die Endnutzer) finden leichter, wonach sie suchen.
Modulare Inhalte steigern die Qualität Ihres Outputs
Die Modularisierung, Klassifizierung und Standardisierung von Inhalten führen 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 pro Variante und auch Fremdsprache zentral und es gibt dank dieser standardisierten Layouts bei der Produktion keine "bösen Überraschungen" mehr (wie man es manchmal von Grafiken in Word kennt). Gleicher Informationsaufbau, gleiche Struktur, gleiches Layout und Design.
- Durch die Wiederverwendung modularer Inhalte muss man für neue Projekte oder Varianten weniger neue Inhalte erstellen. XML-Redaktionssysteme nehmen den Redakteuren dabei den Verwaltungsaufwand ab. Sie wissen jederzeit, welche Module wo verwendet werden. Sie wissen auch, welche Module bereits in welche Sprache übersetzt wurden und welche nicht. So werden Dauer und Kosten der Übersetzung stark reduziert und die Qualität erhöht.
- Da sich die Standards über die Module hinweg durchziehen und die Module ggf. schon übersetzt sind, werden die eigentlichen Hauptaufgaben des Redakteurs, Content-Erstellung und Content-Management, einfacher und effizienter: Sind alle Module für das aktuelle Projekt vorhanden? Wenn nicht, welche fehlen und müssen noch erstellt werden? Welche Module benötigen welches Zieldokument für das Projekt?
Modularisierung ermöglicht flexible Ausgabeformate der Inhalte
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.
Andere Artikel von Quanos
Das könnte Sie auch interessieren
Projektkonfigurator in SCHEMA ST4 bei Caterpillar
Caterpillar assoziieren die meisten wohl mit den bekannten Baumaschinen. Weniger bekannt ist, dass dort viele weitere…
Sicher zum Sicherheitshinweis
Von den vielen Contentmodulen, aus denen eine Anleitung entsteht, sind Warnhinweise wahrscheinlich die sensibelsten. …
SCHEMA ST4 im Web – eine gute Idee?
Das Bild der Technischen Redaktion hat sich genau wie das vieler anderer Büro-Jobs massiv geändert. Mobiles Arbeiten …