Varianten in den Griff bekommen - Wie deklarative Metadaten die automatisierte dynamische Publikation ermöglichen

Veröffentlichung vom 19.05.2005

Wann immer es um moderne Redaktionssysteme für die Technische Dokumentation geht, fallen die Stichworte XML, Informationsmodule, Textbausteine, Single-Source-Publishing, Publikationsstrukturen und Mehrfachverwendung. Um die Verwirrung noch zu erhöhen, wird von Versionen und Freigaben, Varianten und Gültigkeiten sowie Metadaten und Verwendungsnachweisen gesprochen. Dieser Beitrag erklärt, wie der Redakteur diese Technologien optimal einsetzt und flexibel sowie effizient mit Hilfe von deklarativen Metadaten die gewünschten Publikationen aus Textbausteinen dynamisch zusammensetzt, automatisch publiziert und mit hohem Wiederverwendungsgrad pflegt. Screenshots und Beispiele orientieren sich an dem Redaktionssystem e:Content Lifecycle Suite aus dem Hause empolis.

Von Dr. H. Holger Rath

Inhalte

  • XML, Textbausteine und Varianten

    • XML

    • Textbausteine

    • Varianten

  • Deklarative Metadaten

  • Vom Baustein zur Publikation

    • Statische Kompositionen sind suboptimal

    • Dynamische Kompositionen nutzen Textbausteine optimal

    • Regeln, Parameter, Verweise und Text

  • Von der Publikation zum Layout

  • Vorteile der automatisierten dynamischen Publikation

XML, Textbausteine und Varianten

Redaktionssysteme mit XML-Unterstützung ermöglichen die medien- und publikationsneutrale Verwaltung von Textbausteinen, deren Wiederverwendung in unterschiedlichsten Publikationen sowie die automatisierte Generierung der Publikation. Alles in allem eröffnen sich somit große Einsparpotentiale bei der Herstellung technischer Dokumentation.

Die folgenden Abschnitte erläutern, warum die im Redaktionssystem verwalteten Textbausteine im XML-Format abgespeichert werden sollten, welche Systemunterstützung eine effektive Textbausteinverwaltung leisten muss und wieso sich Produktvarianten mit Textbausteinen besser dokumentieren lassen.

XML

XML ist die Grundlage für Single-Source-Publishing und die Wiederverwendung von Textbausteinen. Die Medienneutralität von XML ermöglicht die entkoppelte Erfassung und Pflege der Bausteine von den Publikationen, in denen sie (später) eingebunden werden.

Die strukturierte Erfassung der Textbausteine im XML-Format hat eindeutige Vorteile: Der Redakteur wird bei der Eingabe und Pflege der Inhalte auf allen Strukturebenen vom XML-Editor geführt und kann somit nur gültige Bausteine erstellen. Damit ist sichergestellt, dass alle Textbausteine konsistent nach den gleichen Regeln in der Datenbank des Redaktionssystem abgelegt sind und von anderen Werkzeugen (z.B. Formatier-Werkzeug, Translation Memory System) problemlos und insbesondere vereinheitlicht weiter verarbeitet werden können. Diese Vorteile können weder ein proprietäres Textverarbeitungsprogramm, noch DTP-Formate oder unstrukturierter Text in Datenbanken bieten.

Welches Schema bzw. Dokumenttypdefinition (DTD) für die Strukturierung der XML-Dokumente herangezogen wird, sollte frei von der Redaktion entschieden werden können und nicht vom System vorgegeben sein. Die e:Content Lifecycle Suite erlaubt bspw. die Verwendung beliebiger selbst-definierter Dokumentstrukturen oder den Einsatz vordefinierter Standardstrukturen wie DocBook, DITA oder mumasy.

Textbausteine

Über den Einsatz von XML hinaus gibt es weitere wesentliche Kriterien für eine erfolgreiche Textbausteinverwaltung.

Textbausteine sind self-contained: Der Inhalt eines Bausteins muss „self-contained“, also in sich abgeschlossen sein. Das heißt der Baustein bildet eine logische inhaltliche Einheit, die für sich alleine steht. Dies erfordert unter Umständen eine redaktionelle Überarbeitung der bestehenden, häufig „am Stück“ geschriebenen Dokumente.

Textbaustein-Datenbank: Die Textbausteine müssen zentral in der Datenbank des Redaktionssystems abgelegt und verwaltet werden, damit alle Redakteure einen schnellen Zugriff darauf haben. Gleichzeitig müssen Sperr-Mechanismen (so genanntes Lockings) dafür sorgen, dass Bausteine nicht gleichzeitig von mehreren Redakteuren bearbeitet werden können. Jeder Baustein durchläuft seinen eigenen Freigabe-Prozess, der von einem Workflow-Management des Redaktionssystems überwacht werden sollte.

Textbaustein-Suche: Ziel der Textbausteinverwaltung ist ein möglichst hoher Wiederverwendungsgrad einzelner Bausteine in den Publikationen, um Pflege- und Übersetzungskosten möglichst gering zu halten. Erreicht wird dies mit einer intelligenten Textbausteinsuche. Der Redakteur muss nur die wichtigsten inhaltlichen Stichworte eingeben und die Suche liefert den passendsten Baustein als Ergebnis zurück.

 

Beispiel einer Textbaustein-Verwaltung, Grafik: empolis GmbH


Varianten

Ein Textbaustein beschreibt den Sachverhalt eines bestimmten Produktes oder einer Produkt-Gruppe (z.B. Ausbau eines Bauteils aus einer Baugruppe). So wie die Produkte in verschiedenen Ausführungen, so genannte Varianten, produziert werden, müssen auch die Textbausteine diese Varianten abbilden.

Je nach unterschiedlichen Produkt-Varianten sind eventuell nur einzelne Wörter beziehungsweise Sätze oder aber ganze Bausteine als Textbaustein-Varianten vorzuhalten.

Gerade diese Flexibilität erläutert einen der großen Vorteile von XML gegenüber herkömmlichen Datenbanken in der automatisierten Dokumentationserstellung: Jeder Datenbankdesigner würde die Hände über dem Kopf zusammenschlagen, wollte man innerhalb von Textbausteinen neue Bausteine anlegen.

Deklarative Metadaten

Damit Textbausteine und ihre Varianten leicht verwaltet und gezielt in Publikationen eingebunden werden können, müssen sie mit deklarativen, das heißt beschreibenden Metadaten versehen sein. Während klassische Metadaten Informationen zur Verwaltung des Textbausteins im Redaktionsprozess darstellen (z.B. Autor, Erstellungsdatum, Datum der letzten Änderung, aktueller Bearbeiter, Bildgröße, Workflow-Status), sagen deklarative Metadaten hingegen etwas über den Inhalt des Bausteins aus der Unternehmensperspektive aus.

Typische deklarative Metadaten enthalten Informationen zur Identifikation des Produktes, Gültigkeitsangaben zur Angabe von Produkt-Varianten, Informationen zum Zielmarkt oder Sprachinformationen für Übersetzungen (s. Grafik Deklarative Metadaten eines Textbausteins). Die Metadaten bestimmen letztendlich, in welcher Vielfalt und Flexibilität sich die Bausteine automatisiert in Publikationen einbinden lassen.

Deklarative Metadaten eines Textbausteins, Grafik: empolis GmbH


Vom Baustein zur Publikation

Wie gelangt nun der Baustein in „seine Publikation“ und somit zu „seinen Lesern“? Wie kann die Zuordnung Baustein-zu-Publikation einerseits automatisiert werden und dabei andererseits so flexibel bleiben, dass schnell auf neue Publikationsanforderungen reagiert werden kann? Dazu sollten Publikationen nicht nur statisch, sondern auch dynamisch erstellt werden können.

Statische Kompositionen sind suboptimal

Eine statische Komposition einer Publikation durch manuell gesetzte Verweise auf die einzubindenden Textbausteine ist weder flexibel noch wiederverwendbar (s. Grafik Statische Komposition versus dynamische Komposition von Publikationen, linker Teil).

Selbst wenn bei der Auflösung der Verweise Gültigkeitsinformationen berücksichtigt und nur die Bausteine eingebunden werden, deren Varianteninformation diesen entsprechen, ist die Erstellung und insbesondere die Pflege der Komposition mit hohem manuellen Aufwand verbunden. Und das selbst für sehr ähnliche Publikationen.

Für Redaktionen, die sehr wenige Publikationen mit sehr unterschiedlichem Aufbau erstellen, muss dies kein Nachteil sein. Der Redakteur komponiert die Publikation aus den Bausteinen, die er zuvor manuell im Redaktionssystem zusammengesucht hat, und veröffentlicht das Dokument. Da die nächste Publikation anders aufgebaut ist, besteht für ihn gar keine Notwendigkeit, bestehende Publikationen wiederzuverwenden.

Ganz anders in Redaktionen, die mehrere Publikationen mit gleichem Aufbau herausgeben. Ein gutes Beispiel ist ein Laptop-Hersteller. Jede Bedienungsanleitung eines Laptops ist gleich aufgebaut. Teile der Inhalte werden in allen Anleitungen (wieder-)verwendet, andere Inhalte sind produkt-spezifisch. Die statische Komposition würde die Redaktion zwingen, jede einzelne Anleitung mittels statischer Links zusammenzusetzen. Selbst wenn die Redakteure „wissen“, wo jeder Baustein abgelegt ist, muss der Vorgang doch wieder und wieder mühevoll und fehlerträchtig durchlaufen werden.

Statische Komposition versus dynamische Komposition von Publikationen, Grafik: empolis GmbH


Dynamische Kompositionen nutzen Textbausteine optimal

Eine dynamische Komposition hingegen „beschreibt“, aus welchen Textbausteinen sich die Publikation zusammensetzt, ohne dabei jeden einzelnen Baustein explizit zu verlinken. Diese Beschreibung kann man mit einem generalisierten Inhaltsverzeichnis der Publikation vergleichen und man bezeichnet sie als Publikationsvorlage. Die Beschreibung erfolgt über Regeln, die angeben, welche Bausteine in die Publikation „passen“. In den Regeln werden die deklarativen Metadaten herangezogen, um die gewünschten Textbausteine zu adressieren. Soll die Publikation mit Inhalten gefüllt werden, werden die Bausteine, die die Regeln erfüllen, automatisch eingebunden (s. Grafik Statische Komposition versus dynamische Komposition von Publikationen, rechter Teil).

Eine Publikationsvorlage kann für mehrere konkrete Publikationen (z.B. mehrere Versionen eines Handbuchs oder mehrere Varianten eines Handbuchs für ähnliche Produkte) wiederverwendet werden. Es müssen lediglich einige Parameter in den Regeln angepasst werden und schon werden andere Bausteine eingebunden und somit eine andere Publikation erzeugt (s. Grafik HTML-Vorschau auf zwei Handbücher basierend auf der selben Publikationsvorlage Laptop-Handbuch).

Für jede Art von Publikation (z.B. Service Handbuch, Bedienungsanleitung, Reparaturanleitung) lässt sich eine solche Publikationsvorlage erstellen, die dann bei jedem konkreten Publikationsprozess herangezogen wird. Jede Vorlage und auch die daraus abgeleiteten Publikationen werden im Redaktionssystem abgelegt und verwaltet.

HTML-Vorschau auf zwei Handbücher basierend auf der selben Publikationsvorlage „Laptop-Handbuch“, Grafik: empolis GmbH


Regeln, Parameter, Verweise und Text

Neben den bereits erwähnten Regeln (z.B. müssen für die Bedienungsanleitung eines T42-Laptops folgende Bedingungen an deklarativen Metadaten erfüllt sein: „Sprache = Deutsch“, „Baureihe = T“, „Modell=T42“, „Baugruppe = Display“, „Bausteintyp = Einleitung“) kann eine Publikationsvorlage so genannte Parameter enthalten, die in den Regeln zum Einsatz kommen. Typischerweise werden Angaben, die für die gesamte oder zumindest weite Teile der Publikation gelten, als Parameter hinterlegt (z.B. Sprache, Baureihe, Modell). Über Parameter kann die Vorlage schnell und unkompliziert an neue Publikationen angepasst werden (z.B. lediglich den Parameter Modell auf „T43“ setzen, um eine Bedienungsanleitung für einen T43-Laptop zu erhalten).

Es kann durchaus möglich sein, dass ein bestimmter Textbaustein fest in allen Publikationen einer Vorlage eingebunden sein soll. Dazu kann ein statischer Link aus der Vorlage auf den Baustein gesetzt werden. Dies sollte natürlich relativ selten passieren, da sonst die Dynamik des Ansatzes verloren geht.

Damit die eingebundenen Bausteine in der Publikation nicht übergangslos aneinandergereiht stehen, können kürzere Textpassagen (z.B. Überschriften) in die Vorlage eingefügt werden.

Von der Publikation zum Layout

Nachdem die Bausteine in die Publikation eingebunden und beim Review gegebenenfalls manuelle Korrekturen vorgenommen wurden, kann die Publikation in ihr Ziel-Layout (eigenes CD/CI oder spezielles Branding) und die Ziel-Formate (Papier, PDF, HTML, WinHelp) gebracht werden. Jeder Publikationsvorlage werden die sinnvollsten der verschiedenen Formatier-Prozesse zugeordnet, die bei der Produktion aufgerufen werden können.

Anschließend wird die gesamte Publikation mit all ihren Bausteinen dem Formatier-Prozess in XML übergeben. Das heißt jedes XML-fähige Formatier- Werkzeug (z.B. Adobe FrameMaker, Advent 3B2, Antenna House XSL Formatter, XSL/FOP) kann die aus der e:Content Lifecycle Suite exportierten Daten in das gewünschte Zielformat bringen. Ob dies vollautomatisch im Hintergrund passiert (beispielsweise HTML-Generierung) oder noch manuell eingegriffen wird (zum Beispiel Umbruchskontrolle und Bildplatzierung bei Papier/PDF), hängt von der gewünschten Vorgehensweise und natürlich vom gewählten Formatier-Werkzeug ab.

Auch die automatische Generierung von Inhaltsverzeichnis, Abbildungsverzeichnis, Schlagwortregister etc. übernimmt das Formatier-Werkzeug, das die dazu notwendigen Informationen aus den XML-Inhalten erhält.

Vorteile der automatisierten dynamischen Publikation

Zusammenfassend lassen sich folgende Vorteile einer dynamischen und vorlagen-gesteuerten Publikation feststellen:

  • Reduzierung des Erstellungs- und insbesondere des Pflegeaufwands

  • Minimierung von Übersetzungskosten

  • Verminderung von Fehlerquellen

  • Optimierung der Time-to-Market

  • Hohe Flexibilität und damit einfache Generierung „neuer Publikationen“

  • Gleichbleibende Qualität in entsprechendem CI/CD

Diese Vorteile lassen sich lediglich mit Redaktionssystemen für die Technische Dokumentation realisieren, die verschiedene Schlüsselkriterien erfüllen: XML Unterstützung, Textbaustein-Verwaltung, deklarative Metadaten, dynamische Komposition von Publikationen, verschiedene Layouts und Medien, Übersetzungs-Management. Die im Fachbeitrag als Beispiel dienende empolis e:Content Lifecycle Suite bietet diese als Standard-Funktionen an.