Modularisierung in der Technischen Dokumentation: weniger Aufwand, mehr Qualität
Was bedeutet Modularisierung und welche Vorteile bringt sie in der Technischen Dokumentation? Auf diese und weitere Aspekte rund um die Erstellung von einzelnen Inhaltsbausteinen gehen wir in diesem Blogbeitrag ein.
Modularisierung ist ein entscheidender Erfolgsfaktor für die Arbeit mit Content-Management-Systemen wie SCHEMA ST4. Allerdings stellen sich insbesondere für Umsteiger viele Fragen, wenn sie bisher ihre Texte traditionell linear geschrieben haben. In diesem Blogbeitrag beantworten wir die wichtigsten Fragen für alle, die den Einstieg in das modulare Schreiben finden wollen. Außerdem klären wir, wie Sie bei der Modularisierung am besten vorgehen.
Was ist Modularisierung?
Normalerweise schreiben Autoren einen Text, beispielsweise einen Roman, von Anfang bis Ende. Das ist sinnvoll, weil sich bei den meisten Texten keine oder nur wenige Passagen wiederholen. In der Technischen Dokumentation ist das anders.
Ein Beispiel sind Warnhinweise in einer Anleitung: Wenn beim Umgang mit einem Produkt eine Gefahr besteht, muss die Anleitung davor warnen und zwar nicht nur an einer einzigen Stelle. Schließlich kann dieselbe Gefahr bei unterschiedlichen Bedienvorgängen auftreten. Technische Redakteure 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 Nutzer nur den Teil der Anleitung lesen, den sie gerade benötigen. Darin muss auch der Warnhinweis enthalten sein.
Das heißt: Dieselbe Textpassage kommt in der Anleitung immer wieder vor. Deshalb ist es sinnvoll, diese Passage (zum Beispiel den Warnhinweis) nur einmal zu schreiben und dann an den entsprechenden Stellen immer wieder einzufügen.
Das ist auch deshalb empfehlenswert, weil diese nun isolierte Textpassage vermutlich nicht nur in der Anleitung für ein einziges Gerät gebraucht wird. Andere Geräte haben vermutlich vergleichbare Gefahrenquellen – Redaktionen können diesen Baustein also in den Anleitungen für viele verschiedene Produkte verwenden.
Modularisierung: Das sind die Vorteile für Technische Redakteure
Vorteil #1: Ein Modul ist in x Kontexten einsetzbar
Während man beim linearen Schreiben in Word-Dokumenten oft nur durch Copy & Paste Inhalte in anderen Kontexten wiederverwenden kann, gelingt die Wiederverwendung beim modularen Schreiben wesentlich komfortabler. Module, zum Beispiel Textelemente in Betriebsanleitungen, werden nur einmal erstellt und dann in unterschiedlichen Zusammenhängen wiederverwendet.
Gute Beispiel-Module sind die Funktionsbeschreibung und die Montageanleitung eines Bauteils bzw. spezifischen Abschnitts einer Anlage. Wenn dieses Bauteil bzw. dieser Abschnitt der Anlage auch in anderen Anlagen verwendet wird, kann in der Dokumentation das entsprechende Inhaltsmodul ebenfalls wiederverwendet werden.
- Da ein Textelement nur einmal und nicht mehrfach geschrieben wird, führt dies zu einer deutlichen Zeitersparnis. Außerdem steigt die Textqualität. Beim linearen Schreiben schleichen sich hingegen leicht Variationen der (eigentlich) gleichen Textpassage ein. Manchmal sind diese Variationen belanglos; sie können aber auch Ungenauigkeiten und Fehler enthalten. Das vermeiden Sie, indem Sie die Passage an nur einer Stelle vorhalten und sie dann immer wieder einbinden.
Vorteil #2: Die Übersetzungskosten sinken
Einen der größten Vorteile bietet Modularisierung 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. Dieselbe Textpassage wird nicht wieder und wieder übersetzt. Stattdessen wird sie nur einmal übersetzt und dann an vielen Stellen mehrfach verwendet.
Vorteil #3: Der Aufwand für Aktualisierungen sinkt deutlich
Texte lassen sich viel leichter anpassen. Sehen wir uns einmal an, was notwendig ist, wenn ein Technischer Redakteur eine Passage in linearen Texten überarbeiten muss. In diesem Fall muss er zunächst sämtliche Dokumente identifizieren, in denen diese Passage vorkommt. Danach muss er sämtliche Stellen im Dokument finden, an denen diese Passage genutzt wird. Und zu guter Letzt muss er den Text an allen Stellen in der gleichen Form ändern. Mit einem Modul dagegen braucht er nur das Modul einmalig anzupassen. Die Aktualisierung wird automatisch in allen Dokumenten ü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.
Vorteil #4: Modularisierung erleichtert die Suche und ermöglicht ein smartes Variantenmanagement
Jedes Modul trägt Metadaten bei sich, die Informationen über den Typ des Moduls (zum Beispiel Anleitung, Beschreibung), Zielgruppe und über vieles weitere ausgeben. Als Metadaten bieten sich Informationen wie Produktvarianten oder auch Metadaten aus dem iiRDS-Kontext an. Mit Metadaten können Module also klassifiziert und von computergesteuerten Systemen verwaltet werden.
Gleichzeitig können Sie dank Metadaten schnell und effizient genau das Modul finden, das Sie suchen. Es ist zudem möglich, Suchkriterien zu kombinieren. Das Ergebnis liefert daraufhin alle relevanten Module, zum Beispiel alle Module vom Typ „Anleitung“ für Variante A, die noch nicht übersetzt sind.
Ein anschauliches Beispiel zu den Varianten: Ein Modul umfasst eine Anleitung, wie bestimmte Stammdaten in der Softwarevariante „Premium“ angelegt werden. Dieses Modul gilt auch für die Softwarevariante „Classic“, aber nicht für Softwarevariante „Light“. Sind die Metadaten dieses Moduls gepflegt, können Sie es leichter finden und entsprechend verwenden. Es wäre möglich, anhand der Metadaten automatisch Dokumente zusammenzustellen, die zum Beispiel nur Module für die Variante „Premium“ enthalten.
Auch die Qualitätssicherung kann in Form des redaktionellen und fachlichen Reviews deutlich vereinfacht und beschleunigt werden. Mit einem XML-Redaktionssystem 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.
Vorteil #5: Modularisierung heißt Standardisierung
Wer seinen Content modularisiert, wird früher oder später so einiges standardisieren. Dazu gehören unter anderem einheitliche Textformulierungen, Modultypen und -größen, ein Ablagesystem für die Verwaltung der Module etc. Für Technische Redakteure bedeutet das, dass sie klare Vorgaben für ihre tägliche Arbeit im Redaktionssystem haben, womit Missverständnissen vorgebeugt und gleichzeitig die redaktionelle Arbeit vereinfacht wird.
Modularisierter Content heißt also fast immer auch standardisierter Content und damit geht ein standardisierter Redaktionsprozess einher. Das wirkt sich positiv auf alle nachgelagerten Prozesse aus.
Vorteil #6: Modularisierung ermöglicht flexible Ausgabeformate der Inhalte
Inhalte in einem XML-Redaktionssystem wie SCHEMA ST4 sind 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 zum Beispiel sowohl Teil des Benutzerhandbuchs im PDF-Format sein als auch auf einer HTML-Seite veröffentlicht, die an eine Oberfläche der Software angebunden ist.
So finden Sie die richtige Modularisierung in der Technischen Dokumentation
Idealerweise gelingt es Redaktionen, ihren Dokumentbestand komplett aus wiederverwendbaren Inhalten zusammenzusetzen. In der Praxis wird das nicht immer klappen, denn manchmal wird eine Textstelle nur einmal in einem einzigen Dokument benötigt.
Andere Textpassagen unterscheiden sich nur minimal von Produkt zu Produkt. Das ist ärgerlich, lässt sich aber in vielen Fällen gut handhaben. Schließlich sind diese minimalen Variationen oft systematisch vorhersagbar. Zum Beispiel ändert sich in einem bestimmten Modul nur die Produktbezeichnung oder die Beschriftung eines Oberflächenelements in jedem Enddokument. Für solche systematischen Unterschiede legen Sie am besten Platzhalter in den Modulen an. Erstellen Sie das Enddokument, werden die Platzhalter mit der jeweils notwendigen Variable befüllt.
Bei der Größe der Module sollten Sie einen möglichst hohen Umfang anstreben. Zwar spart die Wiederverwendung Zeit, doch muss jedes Modul verwaltet werden. Je kleiner das Modul ist, desto höher der Verwaltungsaufwand. Im Allgemeinen besteht eine Modulgröße üblicherweise aus zwei bis drei Absätzen. Allerdings spricht auch nichts dagegen, ganze Kapitel als Module zu definieren, wenn sie in identischer Form immer wieder in den Enddokumenten vorkommen. 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.
Fazit: Modulare Inhalte steigern die Effizienz und die Qualität Ihres Outputs
Die Modularisierung von Inhalten führt zu einer Steigerung der Qualität der Dokumentationsprodukte und beschleunigt Redaktionsprozesse. Ein XML-Redaktionssystem wie SCHEMA ST4 funktioniert auf dieser Basis. Es nimmt dank wiederverwendbarer Inhalte Redakteuren viel Arbeit ab. Neue Dokumentationsprojekte für Varianten sind schnell erstellt. Technische Redakteure wissen jederzeit, welche Module in Betriebsanleitungen wo verwendet werden und bereits übersetzt sind. Insgesamt werden die Hauptaufgaben des Redakteurs – Content-Erstellung und -Management – einfacher und effizienter.
