Strukturierungsmethoden im Überblick
Einführung
Für die Strukturierung der Dokumentation gibt es ganz unterschiedliche Ansätze. Manche dieser Ansätze sind stark formalisiert in Form einer oder mehrerer DTDs abgebildet, für andere gibt es nur ein methodisches Konzept, das entsprechend den Anforderungen angepasst werden muss. Der Vortrag greift die wichtigsten Ansätze auf, erläutert diese und gibt Hinweise auf deren Einsatzgebiet.
Die Bedeutung der Struktur
Die meisten Redaktionssysteme arbeiten auf der Basis von XML. Dies bedeutet, dass die Dokumentstruktur im Redaktionssystem hinterlegt ist. Die Dokumentstruktur, die in Form einer DTD oder eines Schemas im System hinterlegt ist, ist Dreh- und Angelpunkt für viele Prozesse:
- Der Editor muss die DTD kennen, damit das Dokument validiert werden kann und der Technische Redakteur beim Schreiben entsprechend unterstützt wird.
- Die Datenbank muss wissen, auf welcher hierarchischen Ebene das Dokument modularisiert wird.
- Der Publikationsprozess muss wissen, wie die einzelnen Elemente in den verschiedenen Zielmedien dargestellt werden (oder auch ausgefiltert werden).
Die Entscheidung für eine bestimmte Dokumentstruktur hat also weit reichende Konsequenzen für das gesamte System. Auch sind nachträgliche Änderungen an der Strukturvorgabe immer mit zum Teil erheblichen Kosten verbunden, da alle Prozesse, die auf der DTD beruhen, angepasst werden müssen.
Standardisierungsmethoden vs. Standards
Was ist der Unterschied zwischen Standards und Standardisierungsmethoden? Standardisierungsmethoden sind Ansätze, mit denen der individuelle Bedarf an Dokumentstrukturen ermittelt werden kann, so dass daraus die eigene DTD entwickelt werden kann, die optimal an die eigenen Bedürfnisse angepasst ist. Methodische Ansätze, die Regeln definieren, wie die eigene Dokumentationsstruktur zu finden ist, sind vielfältig. Ansätze, die eine weite Verbreitung gefunden haben, sind selten. Im Folgenden werden zwei Ansätze betrachtet:
- Information Mapping®
- Funktionsdesign
Schon seit der Einführung von SGML hat man versucht, Standards für Dokumentationsstrukturen zu definieren. Diese Standards sind entweder branchenspezifisch oder versuchen, sehr universell zu sein. Die branchenspezifischen Standards sind sehr umfangreich und daher sowohl aufwändig in der Umsetzung in einem Redaktionssystem als auch aufwändig bei der Einführung in einer Redaktion. Die universellen Standards bieten sehr große Freiräume – sonst wären diese ja auch nicht universell – die dann aber an die jeweiligen spezifischen Unternehmensanforderungen angepasst werden müssen.
Branchenspezifische Standards
- ATAiSpec 2200
- AECMA/ASD S1000D
- mumasy
Universelle Standards
- DocBook
- DITA
Was ist die passende Struktur?
Wie schon am Anfang beschrieben, ist die Dokumentstruktur, also die DTD, maßgeblich mit dafür verantwortlich, wie komplex die Editierapplikation und die Publikationsapplikation(en) werden. Auch auf die Modularisierbarkeit und damit auf die Anforderungen in der Verwaltung hat die DTD Einfluss. Sie ist der Dreh- und Angelpunkt für viele Prozesse, die im Redaktionssystem stattfinden. Was ist denn nun die passende Struktur für meine konkreten Anforderungen? Beantworten Sie sich hierzu die folgenden Fragen:
- Gibt es eine Vorgabe, die eingehalten werden muss (z. B. S1000D)?
- Wie sind die Dokumente bisher strukturiert? Was könnte daran verbessert werden? Was muss erhalten bleiben?
- Gibt es einen Standard, der die meisten Anforderungen abdeckt oder muss eine spezifische Struktur entwickelt werden?
Wenn hier keine Vorgaben existieren, kann die Entscheidung für eine Struktur auch davon abhängig gemacht werden, was im zukünftigen System standardmäßig enthalten ist, mit welchem System also am einfachsten ein passendes Ergebnis erzielt werden kann. Die Vergleichbarkeit der Angebote, die die Systemhersteller dann anhand des Lastenheftes abgeben, wird dadurch allerdings schlechter.
Download
Sie können die Vortragsfolien downloaden: Strukturierungsmethoden_im_Ueberblick (PDF, ca. 2 MB)