Referenzierung

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Bei einer Referenzierung werden Inhalte nicht kopiert und damit vervielfältigt, sondern sie werden einmal erstellt, danach mit einer eindeutigen Kennung versehen und anschließend in den Dokumenten referenziert, in denen die Inhalte zur Verfügung stehen müssen.

Wenn über eine Referenzierung Inhalte wiederverwendet werden sollen, sind dabei folgende zwei Punkte zu berücksichtigen:

  • Inhalte müssen in jeder beliebigen Granularitätsstufe referenziert werden können.
  • Der Zugriff auf die Inhalte muss jederzeit möglich sein.

Wenn mit einer Referenzierung effizient gearbeitet werden soll, muss die Auszeichnung der Inhalte in jeder beliebigen Granularitätsstufe möglich sein. Es müssen einzelne Begriffe ebenso für die Wiederverwendung gekennzeichnet werden können, wie einzelne Satzfragmente oder ganze Absätze. DITA bietet hier mit dem conref-Mechanismus alle Möglichkeiten. Auch über die Referenzierung ganzer Topics, zum Beispiel in Maps, kann dafür gesorgt werden, dass Inhalte in beliebiger Größenordnung wiederverwendet werden.

Wie „Inhalte wiederverwenden mit Maps und conref“ zeigt, ist die Technik des Referenzierens leicht anzuwenden. Das Problem bei der Referenzierung liegt jedoch nicht in der Technik, sondern in der Verwaltung der referenzierten Inhalte.

Denn sollten Inhalte wirklich nur noch über deren Referenzierung wiederverwendet werden, so bedeutet das, dass

  • die entsprechenden Inhalte zunächst einmal eindeutig ausgezeichnet werden müssen,
  • die referenzierten Inhalte abgelegt werden müssen, wenn möglich zentral, damit schnell auf sie zugegriffen werden kann,
  • auf die abgelegten Inhalte wieder zugegriffen werden kann, möglicherweise über eine Suche.

Somit bedeutet die Wiederverwendung von Inhalten über eine Referenzierung vor allem erst einmal einen deutlichen Anstieg des Verwaltungsaufwands, das heißt der Organisation der referenzierten Inhalte. Der Verwaltungsaufwand muss erst betrieben werden, bevor Inhalte tatsächlich wiederverwendet werden können. Vergleicht man den Aufwand mit der Copy&Paste-Methode, bei der sich ohne jeglichen Verwaltungsaufwand sofort das gewünschte Ergebnis erzielen lässt, erscheint die Methode der Referenzierung reichlich blass.

Zudem ist oft der Einsatz von weiteren Werkzeugen notwendig, um die Verwaltung der referenzierten Inhalte zu unterstützen. Redaktionssysteme mit Datenbankanbindung oder Content-Management-Systeme sind dabei Lösungen, die sich nur bei größeren Redaktionsteams rechnen. Wenn hingegen die Technische Redaktion nur mit ein oder zwei Technische Redakteure besetzt ist, gestaltet sich die Suche nach den passenden Werkzeugen deutlich schwieriger. Denn auch wenn ein passendes Werkzeug gefunden wird, muss es zunächst eingerichtet und die Inhalte müssen mit ihm abgelegt werden. Der Aufwand, bis die eigentliche Technische Dokumentation erzeugt werden kann, ist erheblich und steht oft nicht im Verhältnis zum Aufwand, der für Erstellung der eigentlichen Dokumentation benötigt wird.

Wenn DITA neu in einer kleineren Technischen Redaktion eingeführt wird, besteht die Empfehlung häufig darin, zunächst einmal ohne jegliche Werkzeuge auszukommen, um die mit DITA erzeugten Inhalte zu verwalten. Wie die Praxis jedoch zeigt, sind die Grenzen einer überschaubaren Verwaltung schnell erreicht. Früher oder später beginnt dann doch die Suche nach einem passenden Werkzeug, das die Referenzierung und die Verwaltung der referenzierten Inhalte ermöglicht.

Die in DITA verwendete Methode der Referenzierung ist der Garant dafür, dass Informationen tatsächlich nur einmal erstellt werden müssen und dann in beliebigen Dokumenten und Medien wiederverwendet werden können. Die Kehrseite der Medaille ist jedoch ein deutlich gestiegener Verwaltungsaufwand, der beim Umstieg auf DITA häufig nicht in Betracht gezogen oder zumindest stark unterschätzt wird. Auch muss die Arbeitsweise bei der Erstellung von Dokumenten geändert werden, wenn die Inhalte nicht mehr über Copy&Paste, sondern über Referenzierungen wiederverwendet werden sollen. Dies alles kann dazu führen, dass sich die Einführung von DITA schwieriger gestaltet, als zunächst angenommen wurde.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

XLcontent Verlag, Pflegerstraße 40, 81247 München