Fehler verbreiten sich in der technischen Dokumentation unkontrolliert
Im ersten Teil 4.0 (https://www.because-germany.com/der-weg-zu-informationen-4-0/) haben wir Thomas G. und Markus F. das ganze Wochenende über arbeiten lassen, um Fehler in der bestehenden Dokumentation einer ihrer größten Kunden ihres Unternehmens zu beheben. Da sich die Fehler im Laufe der Jahre in einer Vielzahl von Dokumenten ausgebreitet haben, mussten sie enorme Anstrengungen unternehmen, um diese überhaupt zu finden – und sie können sich nicht sicher sein, wirklich alle Fehler gefunden zu haben. Sie verbrachten Stunden damit die Dokumentation über Copy und Paste zu überarbeiten.
Am Montagmorgen hatten sie nicht den Mut, ihrem Manager zu sagen, dass sie an den Korrekturen so lange gesessen hatten und dass sie noch lange nicht fertig waren. Auch wenn die Übersetzungen der Korrekturen am Montagnachmittag von der Übersetzungsagentur geliefert würden, müssten Thomas G. und Markus F. Tage damit verbringen, die Übersetzungen manuell in die Dokumentationen einzufügen und das würde den ganzen Wochenplan durcheinanderbringen.
Nach dieser Tour de Force wuchs ihre Frustration und somit auch die Entschlossenheit, dieses Problem ein für alle Mal zu lösen.
Da Thomas G. auf dem Markt keine Redaktionssoftware finden konnte, die das Verwalten der Veränderungen einfach lösen kann, beschloss er über die Arbeitsweise der technischen Dokumentation nachzudenken.
Am folgenden Montagmorgen kommt Thomas G. deshalb gut gelaunt ins Büro und erzählt Markus F., was er inzwischen herausgefunden hat:
Single source content
Das Problem ist, erklärt Thomas G., dass er und Markus F. seit Jahren keine qualitativ hochwertigen Originalinhalte erstellt haben. Und warum? Um immer schnell auf Abruf neue Dokumentation zusammenzustellen und das durch Copy und Paste und ohne wirkliche Methode.
Deshalb wurden oft neue Inhalte geschrieben, statt diese wiederzuverwenden. Das hatte unnötige Übersetzungskosten zur Folge und war nicht unbedingt fördernd für die Qualität der Dokumentation. Das macht den ganzen Prozess sehr ineffizient.
Um das Problem zu beheben, müssen sie ihre Arbeitsweise ändern. Die Lösung heißt Single Source Content: Jeder Originalinhalt ist eine eindeutige Quelle und wird nicht dupliziert, sondern mit anderen Originalinhalten kombiniert, um verschiedene Kategorien von Dokumenten zu erstellen.
Aber wie kann man Teile verschiedener Dokumente wiederverwenden, ohne die Software zu wechseln? Thomas G. weiß nicht wie und überlässt das Problem Markus F., der eine Lösung finden soll, die es ihm ermöglicht, die Dokumente zusammenzustellen.
Module und Fragmente
Nach einigen Versuchen erkennt Markus F., dass das Prinzip der Single-Source-Inhalte zwangsläufig mit der Generierung von eigenständigen Content-Modulen kombiniert werden muss, die flexibel zusammengestellt werden können.
Das erste praktische Problem, das Markus F. zu lösen hat, ist die Menge der Informationen, die in jedem Modul enthalten sind. Einige sehr lange Informationsblöcke (z.B. einige Standardkapitel) werden vollständig wiederverwendet und haben mehrere Seiten.
Andere Inhalte sind hingegen Textfragmente, die in der gesamten technischen Dokumentation mehrfach wiederholt werden.
Markus F. merkt aber direkt, dass diese Vorgehensweise mit ihrer Software nicht umsetzbar ist. Um Module in ihrer Software zu erstellen, beschließen Thomas G. und Markus F., ihre Module auf eine Seite zu reduzieren. Dieser Kompromiss hindert sie jedoch daran, Fragmente zu erstellen, die in den verschiedenen Modulen dupliziert werden. Außerdem sind nicht alle Module genau eine Seite lang. Deshalb sind einige Seiten halb leer und somit ist das Layout der Dokumentation nicht mehr sehr leserfreundlich.
Module und Fragmente
Thomas G. ist mit dieser Lösung nicht zufrieden, erkennt aber, dass es der einzige Weg ist, Markus F. aus dem Teufelskreis des Kopierens und Einfügens herauszuholen, ohne eine neue Software einzuführen.
Der erste praktische Schritt ist also die Katalogisierung und Reorganisation – und diesmal mit Sorgfalt!
Nach einer Woche Arbeit identifiziert Thomas G. die Inhalte und Markus F. erstellt die Module. Thomas G. und Markus F. arbeiten mit Begeisterung am System der Ordner und Unterordner, das es ihnen endlich ermöglicht, Module wiederzuverwenden.
Aber die Erstellung und Organisation der Module, die einem Puzzle gleichen, gestaltet sich schwieriger als erwartet. Im nächsten Teil werden wir sehen, wie es Thomas G. mit Hilfe von Metadaten und Taxonomien gelingt, ein Datenvolumen zu bändigen, das trotzdem wieder zu Problemen führen wird und Markus F. schließlich beginnt, die Aktivitäten des manuellen Layouts aufzugeben.
In Zusammenarbeit mit Georgiana Munteanu