Bedeutung der Musterdokumentation

Sollen ihre Dokumente eine komplett neue Struktur bekommen oder nach einem neuen Konzept gestaltet werden? Grund dafür könnte sein, dass Sie in einem Redaktionssystem Varianten verwalten wollen und deshalb die Dokumente modularisieren müssen. In diesem Fall empfehlen wir statt eines theoretischen Ansatzes die Erstellung einer Musterdokumentation. Erfahren Sie hier wie solch eine Musterdokumentation realisiert werden kann:


Systematische Modularisierung

Die Anforderungen, denen mit einem Redaktionssystem begegnet werden soll, bedingen fast alle, dass die Dokumente modularisiert werden. Oder anders herum ausgedrückt: Dokumente müssen modularisiert werden, um wiederverwenden zu können – um Kosten zu sparen bei der Erstellung, bei der Übersetzung, bei der Beschreibung von Varianten – aber modularisierte Dokumente können nur in einem Redaktionssystem sinnvoll erstellt, übersetzt und verwaltet werden.

Dokumente einfach klein zu schneiden, ist aber nicht die Lösung. Um das Optimierungspotenzial, das in der Modularisierung steckt, vollständig nutzen zu können, muss die Modularisierung systematisch – nach einem Konzept – erfolgen.

Folgende Anforderungen muss das Modularisierungskonzept erfüllen:

  • hoher Wiederverwendungsgrad: Die Module müssen möglichst klein sein, um Erstellungs- und Übersetzungskosten zu sparen.
  • Produktvarianten abdecken können: Die Granularität der Module muss es erlauben, die für unterschiedliche Produktvarianten notwendigen Informationsvarianten sinnvoll zu verwalten.
  • lesbare Dokumente: Trotz der Modularisierung müssen die Dokumente für den Anwender weiterhin einen Zusammenhang vermitteln.
  • navigierbare Dokumente: Die Links zwischen den Modulen müssen ebenfalls einer festen Systematik unterliegen, die der Anwender implizit "lernt".
  • erstellbare Dokumente: Trotz der Modularisierung müssen der Redakteur und der Übersetzer die Dokumente noch in einem sinnvollen Kontext erstellen und übersetzen können.

Grundkonzepte aus ARAKonzept

ARAKonzept schließt ein Konzept für systematische Modularisierung ein.

Es basiert auf einigen der Qualitätskriterien für funktionale Dokumente:

  • Topic-Orientierung
  • Sequenzierung auf Basis von Frage-Antwort-Mustern
  • Verlinkungsstrategien

Einführung eines Redaktionssystems mit modularisierten Dokumenten

Wenn im neu eingeführten Redaktionssystem alle Dokumente modularisiert sein sollen, ist der Zeitpunkt der Systemeinführung auch der ideale Zeitpunkt, die Dokumente zu modularisieren und im System gleich mit systematisch modularisierten Dokumenten zu beginnen.

Ein Ansatz dazu ist die theoretische Entwicklung von modularen Strukturen und die Abbildung dieser Strukturen in einer DTD oder einem Schema. Nachteil dieses Ansatzes ist die notwendige theoretische Durchdringung aller möglichen Strukturen – z. B. bedingt durch Produktvarianten – im Vorhinein.

Die Musterdokumentation als praxisorientierter Ansatz

Ein praxisorientierter Ansatz zur Entwicklung eines Modularisierungskonzepts ist die Erstellung einer Musterdokumentation, in der die Dokumentation so aufgebaut wird, wie man es sich für die Zukunft für alle Dokumente wünscht. Zur Musterdokumentation benutzen wir ein beliebiges flexibles System, in dem Strukturen frei ohne Vordefinitionen aufgebaut werden können. Erst wenn sicher ist, dass die Musterdokumentation auch für weitere Produkte trägt, werden die Strukturen in das eigentlich gewählte System übertragen.

Die Erstellung der Musterdokumentation ist auch eine sehr wertvolle Basis für den Redaktionsleitfaden und die Schulung der Redakteure, da das Lernen am Beispiel meist leichter fällt als das theoretische Lernen.