Keine Regel ohne Ausnahme?
Trotz Modularisierungskonzept und Variantendefinition müssen für so manche Inhalte eigene Lösungen gefunden werden. Zum Beispiel, wenn sie nicht in die Struktur passen. Mit Adobe FrameMaker und einem Modularisierungskonzept lässt sich diese Situation steuern.
Häufig fehlt in Technischen Redaktionen ein Autorensystem. Struktur, Textmenge oder auch das Budget erlauben es nicht. Das Risiko ist groß, dass die Erstellung jeder einzelnen Dokumentation, die vom Standard abweicht, zur Ausnahmeerscheinung wird – möglicherweise dauerhaft.
Ein Schwachpunkt, der sich mit der Zeit bemerkbar macht, ist das Fehlen von definierten Prozessen und Werkzeugen für den Umgang mit solchen Ausnahmen. Ein weiterer, dass Ausnahmen normalerweise größere Spielräume in Anspruch nehmen, als im System dafür vorgesehen. Damit werden Ausnahmen unberechenbar. Die Anforderung, mit Sicherheit festzulegen, dass alle benötigten Inhalte in einer Technischen Dokumentation abgebildet wurden und fachlich richtig sind, kann nicht vollständig erfüllt werden.
Beispiele für Ausnahmen
Von welchen Konstellationen ist hier die Rede? Zunächst vom Publizieren von Inhalten, die aus den verschiedensten Informationsquellen stammen, unterschiedliche Bearbeitungsstufen durchlaufen und noch kurz vor Veröffentlichung tiefgreifend geändert werden müssen. Außerdem von Inhalten, die sich trotz flexiblem Modularisierungskonzept und perfektem Variantenmanagement nicht greifen lassen, weil sie zu speziell sind und nur einmalig benötigt werden. Die Liste möglicher Ausnahmen ist lang.
Für alle Inhalte, die im folgenden Lösungsansatz beschrieben werden, soll gelten, dass das Layout flexibel auf das definierte Corporate Design angepasst wird. Es soll zudem feststellbar sein, woher Inhalte stammen, ob diese auf Richtigkeit überprüft wurden und dass wiederkehrende manuelle Anpassungen bei nachträglichen Änderungen grundsätzlich vermieden werden müssen.
Der kleinste Nenner
Wer eine Lösung für Ausnahmeerscheinungen sucht, wird Modularisierung als grundlegendes Konzept entdecken. Mit diesem Konzept können die Inhalte flexibel bearbeitet, versioniert, leicht übersetzt und für *diverse Varianten übersichtlich gehandhabt werden. Modularisierung und Variantenmanagement, gleichzeitig mit der Forderung gekoppelt, die beschriebenen Ausnahmen integrieren zu können, lassen sich mit Adobe FrameMaker als Werkzeug umsetzen.
Mögliches System
Modularisierung ist die Basis. Allerdings ist sie als Prinzip zu verstehen und nicht als Korsett in Form einer festgelegten XML-Struktur. Bezogen auf Adobe FrameMaker heißt das, ein Modul entspricht einer FrameMaker-Datei. Es kann mit Formaten strukturiert werden oder XML-basiert, kann PDF-Dokumente referenzieren oder Textscans abbilden. Das Modul kann in der Modul-Ablage abgelegt werden oder im Handbuch-Projekt. Weiterhin enthält es immer Metadaten, die eindeutig über den Inhalt, die Version und den Bearbeitungsstatus Auskunft geben. Zusätzlich kann die Datei mit funktionierenden Prozessregeln verwaltet werden, der Inhalt lässt sich aber beliebig zusammenstellen. Zu den Modulen an sich gehört eine Ablage für die Moduldateien, in der sich Technische Redakteure intuitiv zurechtfinden. Die Modulablage wird nach Regeln konzipiert, die flexibel erweitert werden können und mit dem Gebrauch und der Erfahrung mitwachsen.
Varianten und Module verwalten
Für die Kennzeichnung von Varianten kann ein Konzept für das Variantenmanagement entwickelt werden. Die Variantenkennzeichen lassen sich durch Skripte für verschiedene Aufgaben einlesen und auswerten.
Zur Verwaltung von Modulen kann der Redakteur FrameMaker-Bordmittel einsetzen: in einer Buchdatei wird die Struktur der Modulablage nachgebildet und darin alle Module als Buchkomponenten eingefügt. Schaltzentrale der Bearbeitung ist ein Inhaltsverzeichnis, das aus den Modulen die Metadaten zusammenfasst. Vorausgesetzt, die Metadaten in den Modulen sind entsprechend gut gefüllt, kann in diesem Verzeichnis mit Volltextsuche nach einem Modul recherchiert oder sogar eine Volltextsuche über das gesamte Buch ausgeführt werden.
System umsetzen
Strukturierung der Informationen und Erstellen von Templates – den Anfang macht das Analysieren der Inhaltsstrukturen der Dokumente. Es genügt dabei nicht, herauszufinden, ob Absätze Handlungsanweisungen oder technische Daten enthalten. Es wird auch ermittelt, wo die Informationen herkommen, wie häufig sie sich ändern und ob die Informationen in anderer Zusammenstellung und Position im selben Handbuch wieder vorkommen können.
Die Strukturierung der Inhalte ermöglicht es danach, einerseits die Formatierung leicht und gezielt anzupassen und weiterhin spezielle Inhalte aus den Modulen zu extrahieren und in anderer Form zu publizieren. So können Reinigungs- oder Schmiermittel beziehungsweise Wartungsintervalle mit beschreibenden Texten in Kapiteln zur Bedienung vorkommen und gleichzeitig als Schmiermittelliste oder auch Übersicht über alle Wartungsintervalle automatisch aus den Modulinhalten generiert werden.
Die gedankliche, durch Formate realisierte Strukturierung wird damit ganz den konkreten Anforderungen entsprechen und das abbilden, was benötigt wird.
Konzeption der Ablagestruktur und Benennung der Modul-Dateinamen – wenn die Inhalte der Dokumente analysiert und verglichen wurden, dann wird anschließend die Produktstruktur ermittelt und transparent gemacht, in welchen Handbüchern welche Informationen enthalten sind und möglicherweise wiederverwendet werden können. Oft werden so Potenziale erst sichtbar.
Mithilfe der Produkt- und Handbuchstruktur kann dann eine Ablage für die Module konzipiert werden.
Abb. 01 Durch das FrameMaker-Buch lassen sich alle Module direkt öffnen und bearbeiten.
Konzeption von Metadaten
Die Metadaten sind von zentraler Bedeutung und bilden die Schnittstelle vieler Prozesse und Informationen. Ein Beispiel soll das verdeutlichen: Wird von der Konstruktionsabteilung eine Änderungsmitteilung versandt, muss der Technische Redakteur die Information auswerten. Stellt sich dabei heraus, dass Inhalte von Handbüchern angepasst werden müssen, können die betroffenen Module identifiziert werden und in den Metadaten der Status sofort auf „veraltet“ gestellt werden. Mit dem Status wird für die weitere Verarbeitung sowohl in der Modulverwaltung als auch in den Handbüchern signalisiert, dass so nicht publiziert werden kann.
Abb. 02 Im Verzeichnis sind alle Metadaten aller Module zusammengestellt und ermöglichen eine Volltextsuche über diese Inhalte.
Zusammenfügen für konkrete Ausgabe
Es existieren verschiedene Grundkonzepte, um modulare Inhalte zu publizieren: Ein so genanntes Master-Buch kann erstellt werden, in dessen Kapiteln alle Varianten von Modulen in der passenden Reihenfolge bereits referenziert werden. In der konkreten Publikation werden dann die nicht zutreffenden Module entfernt. Weiterhin könnte mit Hilfe von Stücklisten auch ein Handbuch automatisiert zusammengestellt werden. Zusätzlich ist es möglich, für einzelne Handbücher spezielle Inhalte zu integrieren, die ausschließlich projektabhängig sind und deshalb in der Modulablage nicht sinnvoll eingeordnet werden können. Damit können Inhalte ergänzt werden, die sonst als Ausnahme gehandhabt würden.
Nachwachsendes System
Die Modularisierung und Publikation von modular aufgebauten Handbüchern kann eine Technische Redaktion mit Adobe FrameMaker umsetzen. Werden vorher alle Prozesse, Schnittstellen und Inhaltsstrukturen analysiert, entsteht ein Publikationssystem, das mit den Anforderungen wachsen kann. Das System geht flexibel, aber geregelt mit Informationen um, die sonst als Ausnahmen gehandhabt werden.
