Fachbücher

doculine Archiv

Service

Aktuelle Artikel und Nachrichten rund um die technische Dokumentation finden Sie im Nachfolgemagazin der doculine news, den transline tecNews

Dokumentenmanagement-Systeme: Anforderungen aus der Technikredaktion

Artikel erschienen in
Ausgabe September 1999

Von Christoph Altenhofen

Inhaltsübersicht:

• Arten von Dokumentenmanagement-Systemen
• Aufbau eines Dokumentenmanagement-Systems
• Besondere Anforderungen technischer Redaktionen
  Redaktionelle Aspekte
  Technische Aspekte
  Organisatorische Aspekte
• Fazit

In letzter Zeit wird viel über die erheblichen Einsparpotentiale gesprochen, die Dokumentenmanagement-Systeme (DMS) für die Erstellung technischer Dokumentation bieten können. Aber welchen Anforderungen muss ein DMS genügen, das speziell auf die Bedürfnisse der Technikredaktion zugeschnitten ist? Im folgenden seien zunächst die Arten und der grundsätzliche Aufbau von Dokumentenmanagement-Systemen skizziert. Anschließend geht es darum, aus den technischen, redaktionellen und organisatorischen Aspekten moderner Dokumentationserstellung Aufgabenschwerpunkte abzuleiten, die ein DMS für den Einsatz in der Technikredaktion erfüllen sollte.

Arten von Dokumentenmanagement-Systemen

Dokumentenmanagement-Systeme (DMS) müssen alle Phasen des gesamten Dokumentenlebenszyklus unterstützen. Dieser Zyklus beginnt mit der Erstellung bzw. dem Eingang eines Dokuments und schließt entweder mit seiner dauerhaften Ablage oder mit seiner definierten Vernichtung. Dazwischen liegt die Erschließung des Dokumenteninhalts, die vorübergehende Speicherung, die Langzeitarchivierung, das Retrieval, die Bearbeitung, der Ausdruck und die Übermittlung des Dokuments an andere Stellen.

Grundsätzlich können Dokumentenmanagement-Systeme bezüglich der Schwerpunkte ihrer Funktionalität in drei Gruppen eingeteilt werden:

1. Ablage- und Archivierungs-Systeme
2. Retrieval- oder Recherche-Systeme
3. Vorgangsunterstützungs-Systeme

Komponenten eines Dokumentenmanagement-Systems

Systeme zur Ablage und Archivierung legen ihren Fokus auf die Dokumentenablage. Hierbei wird zwischen der normalen Speicherung (z.B. während des Entstehungszyklus von Dokumenten) und der Langzeitarchivierung unterschieden. Auch die automatische Versionierung von Dokumenten gehört in das Gebiet der Archivierung. Als Archivierungsmedien kommen sowohl magnetische als auch eine Reihe optischer oder magneto-optischer Medien (CD-R, WORM, DVD oder MOD) zum Einsatz.

Retrieval-Systeme legen den Schwerpunkt auf die Bereitstellung von Informationen und Dokumenten, die in Datenbanken und Archiven abgelegt sind. Sie greifen auf den Inhalt der Dokumente zu und eignen sich daher besonders für Aufgaben, bei denen der Zugriff auf Informationen und nicht auf ein spezifisches Dokument notwendig ist. In diese Klasse lassen sich beispielsweise die Volltext-Recherche-Systeme einordnen.

Unter Vorgangsunterstützung wird hier das elektronische Weiterleiten von Dokumenten an weitere Bearbeitungsstationen verstanden, wobei zwei Werkzeugkategorien zu unterscheiden sind: Reine Workflow-Systeme unterstützen solche Vorgänge gemäß einem definierten Ablauf. Daneben bieten auch Groupware-Systeme Funktionalitäten zur elektronischen Weiterleitung von Dokumenten; diese erfolgt hier jedoch nicht automatisch anhand eines vordefinierten Vorgangs, sondern wird vom Bearbeiter explizit angegeben.

Viele Systeme vereinen die verschiedenen Funktionalitäten jedoch auch in unterschiedlichen Ausprägungen miteinander. So existieren etwa Systeme, die schwerpunktmäßig den Bereich der technischen Dokumentation abdecken. Solche Systeme unterstützen die Dokumentationserstellung beispielsweise durch geeignete Anbindungen an Publishing-Systeme bzw. bieten Unterstützung für die modulare Zerlegung oder für SGML/XML.

Aufbau eines Dokumentenmanagement-Systems

Die meisten Dokumentenmanagement-Systeme verwenden eine relationale Datenbank, um die für den Zugriff auf die Dokumente notwendigen Informationen zu halten. Diese Informationen, die man mit Schlagwort, Index oder Attribut bezeichnet, werden bei der Suche nach Dokumenten verwendet und beinhalten die sogenannte Metainformation über ein Dokument, also beispielsweise den Namen des Autors oder dem Dokument zugeordnete Stichworte. Die Datenbank enthält für jeden Dokumenttyp, der im DMS definiert ist, eine eigene Tabelle mit den für diesen Typ spezifischen Informationen. Ebenso ist in dieser Tabelle der Eintrag des physikalischen Ablageorts des betreffenden Dokuments enthalten. Die Dokumente werden somit nicht in der Indexdatenbank, sondern in einem anderen Bereich des DMS abgelegt.

Grundsätzlicher Aufbau eines Dokumentenmanagement-Systems

Neben den beschriebenen Informationen muss das Dokumentenmanagement-System eine Reihe weiterer Informationen halten, die zur Administration des Systems erforderlich sind. Hierzu zählen beispielsweise Informationen über zugelassene Benutzer, deren Zugriffsrechte oder die vorgesehene Archivierungsstrategie. Für die Haltung dieser Informationen wird ebenfalls die relationale Datenbank verwendet.

Die Dokumente selbst stellen für das klassische Dokumentenmanagement-System quasi eine Black Box dar, die nicht weiter interpretiert wird. Dieses Prinzip ermöglicht es, dass ein DMS beliebige Datenformate verwalten kann. Der Zugriff auf die Dokumente kann in diesem Fall natürlich nur über die separat zu definierenden Indexattribute erfolgen.

Besondere Anforderungen technischer Redaktionen

Betrachtet man das Umfeld der Erstellung technischer Dokumentation, so kann man dieses in redaktionelle, technische und organisatorische Aspekte unterteilen. Viele Aspekte lassen sich dabei nicht eindeutig einem Bereich zuordnen bzw. haben entsprechende Auswirkungen in anderen Bereichen. Aus diesem Grund sind im folgenden einzelne Aspekte mehrfach unter verschiedenen Blickwinkeln aufgeführt.

Redaktionelle Aspekte

Technische Dokumentation an sich ist eine hochkomplexe Angelegenheit. So nimmt der Anteil an Multimedia-Inhalten zu. Bei der Verwendung von multimedialen Inhalten ist mit großer Sorgfalt vorzugehen, damit ihr Einsatz sinnvoll ist und den Aufwand zur Erstellung rechtfertigt. Daneben haben Dokumentationen oft einen großen Umfang und müssen Informationen beinhalten, die sich eventuell an unterschiedliche Nutzerkreise (End-Anwender, Techniker etc.) wenden.

Leider wird die Erstellung der technischen Dokumentation noch immer bei so manchem Hersteller von den Entwicklern der Produkte selbst durchgeführt. In einem solchen Fall ist davon auszugehen, dass die Dokumentation aufgrund der Tatsache, dass sie nicht von für diese Aufgabe qualifiziertem Personal erstellt wird, in der Regel keine solch hochwertige Qualität besitzt wie beim Einsatz von speziell ausgebildeten technischen Redakteuren. Außerdem ist es bei diesem Personenkreis, für den die Dokumentation oft ein „notwendiges Übel" darstellt, nur schwer möglich, entsprechende Werkzeuge als Autorensystem einzusetzen, weil eine ausgiebige Schulung der Entwickler durchgeführt werden müsste – was aus finanziellen oder terminlichen Gründen meist nicht umsetzbar ist. Es lässt sich jedoch feststellen, dass dieser Aspekt zunehmend an Bedeutung verliert, da die meisten Hersteller erkannt haben, wie entscheidend eine gute Dokumentation für die langfristige Akzeptanz ihrer Produkte ist.

Gleichzeitig findet die Erstellung der technischen Dokumentation häufig unter großem Zeitdruck statt. Dieser Aspekt, der dazu führt, dass höchste Ansprüche an ein System zur Unterstützung der redaktionellen Arbeit gestellt werden, ist dabei nicht auf den Fall der Erstellung durch Entwickler beschränkt. Auch die meisten Technikredaktionen klagen über diesen Zeitdruck, der ihnen oftmals nicht mehr die Gelegenheit gibt, die erstellte Dokumentation mit der eigentlich erforderlichen Sorgfalt nochmals zu prüfen. Neue Systeme, die in diesem zeitlich hoch angespannten Umfeld zum Einsatz kommen sollen, müssen die Arbeit mit einer entsprechend hohen Zuverlässigkeit wirkungsvoll unterstützen.

Komplexe technische Dokumentation wird oftmals von mehreren Autoren gleichzeitig erstellt. Die notwendigen Unterstützungsmöglichkeiten zur gegenseitigen Abstimmung und Zusammenarbeit, wie beispielsweise gemeinsame Datenbestände mit Zugriffsschutz, sind jedoch oft nicht implementiert. Dies hat zur Folge, dass die zur Erstellung notwendige Abstimmung aufwendiger ist, als sie beim Einsatz entsprechender Systeme wäre.

Außerdem kann es vorkommen, dass unterschiedliche Autorengruppen für unterschiedliche Medien eingesetzt werden. Dies hat zur Folge, dass Inhalte unter Umständen mehrfach – beispielsweise für Papier, Online-Hilfe und CD-ROM – erstellt werden. Mögliche Einspareffekte durch Vermeidung dieser Redundanz sind mit dem Einsatz eines medienneutralen Datenformats realisierbar. Der Aufwand, den eine Umstellung der existierenden Dokumentation auf ein medienneutrales Format bedingt, wird bisher noch vielfach gescheut – auf lange Sicht erscheint er jedoch unter wirtschaftlichen Gesichtspunkten ratsam.

Die Problematik verschiedener Versionen der prinzipiell gleichen Dokumentation wird noch verschärft durch die in der Regel erforderliche Mehrsprachigkeit. So werden die einzelnen Dokumentationen eventuell an unterschiedliche Übersetzungsbüros vergeben, ohne dass bereits in anderen Dokumentationen übersetzte Teile erkannt und wiederverwendet werden. Auch hier existieren somit nicht unerhebliche Einsparpotentiale.

Technische Aspekte

Bei technischer Dokumentation existieren in hohem Maße Querverweise innerhalb von Dokumenten wie auch Beziehungen zwischen unterschiedlichen Publikationen. Hier ist ein Werkzeug, das die Erstellung und Verwaltung solcher Querbeziehungen unterstützt, als sehr hilfreich anzusehen.

Zudem ist es wünschenswert, dass Werkzeuge, die im Unternehmen an verschiedenen Stellen zum Einsatz kommen, bei der Dokumentationserstellung eingebunden und als Datenquellen genutzt werden können. So ist etwa eine Integration von CAD-Werkzeugen, mit denen beispielsweise komplexe Anlagen entworfen werden, sinnvoll. Auch die Integration von EDM- (Engineering Data Management) oder PPS-Systemen (Produktplanung und -steuerung) ist ein wichtiges Hilfsmittel, um die Erstellung typgerechter Dokumentation zu unterstützen.

Zunehmend kommen in technischen Redaktionen Werkzeuge zum Einsatz, die strukturierte Dokumente unterstützen. Dies bedingt, dass die Werkzeuge zur Verwaltung dieser Dokumente ebenfalls eine Strukturierung unterstützen sollten, da sonst Informationen bei der Ablage verloren gehen. Diese Informationen können beispielsweise dazu dienen, Dokumente bzw. Dokumentteile anhand von Werten in bestimmten Elementen recherchierbar zu machen.

Auch durch den verstärkten Einsatz von Multimedia-Inhalten verbreitert sich das Spektrum integrierbarer Werkzeuge. Hier ist beispielsweise die Integration von Audio- oder Video-Daten in ein technisches Dokument zu nennen. Aber auch die Möglichkeit, CBT-Informationen (CBT = Computer Based Training) mit einer Dokumentation zu verknüpfen, stellt eine neue Herausforderung für Dokumentenmanagement-Systeme dar.

Ein modularer Aufbau der Dokumentation ermöglicht es, gleiche Teile unterschiedlicher Dokumente nur einmal im System zu halten und in verschiedenen Dokumentationen einzubinden. So können mögliche Fehlerquellen, die bei Aktualisierungen latent vorhanden sind, ausgeschaltet werden. Allerdings findet der modulare Aufbau technischer Dokumentation bislang noch vergleichsweise selten Anwendung.

Technische Dokumentation wird in zunehmendem Maße auf verschiedenen Medien publiziert. Hier ist es erforderlich, ein Werkzeug zu verwenden, das die integrierte Bearbeitung dieser unterschiedlichen Medien erlaubt. Idealerweise werden die Dokumente in einem medienneutralen Format im Redaktionspool gehalten und erst bei der Publikation auf ein spezielles Ausgabemedium – etwa Papier, WWW oder CD-ROM – mit spezifischen Informationen versehen, die für das jeweilige Publikationsmedium erforderlich sind. So ist es beispielsweise denkbar, Anmerkungen auf Papier als Fußnote und bei der CD-ROM-Version als Pop-up-Fenster zu realisieren.

Organisatorische Aspekte

Wenn hier auch ein Umdenken feststellbar ist, so wird bei der Erstellung der Dokumentation häufig noch immer ein Prozess verfolgt, der stark auf das Medium Papier ausgerichtet ist. Eine Ausrichtung, die sich auch auf die eingesetzten Werkzeuge bezieht. Hier wäre eine stärkere Hinwendung zu einer Philosophie der Erstellung von Informationen anstatt von Kapiteln wünschenswert. So spielt es bei der Publikation auf unterschiedlichen Medien keine Rolle, wie Abbildung und Bildunterschrift zueinander angeordnet sind. Es ist sogar denkbar, bei einer elektronischen Publikation Abbildungen erst auf spezielle Interaktion durch den Betrachter in einem Pop-up-Fenster zu präsentieren.

Heutige Dokumentation ist oft noch sehr monolithisch aufgebaut. Dies hat zur Folge, dass Anwender mit großen Mengen von Papier versorgt werden, jedoch nur einen unzureichenden Leitfaden erhalten, welche Informationen in einem gegebenen Umfeld relevant sind und wo diese Informationen zu finden sind. Bedenkt man zudem, dass oftmals die komplette Dokumentation einer Produktfamilie aus logistischen Gründen komplett an den Anwender übergeben wird, ist leicht ersichtlich, dass eine individualisierte Dokumentation für mehr Anwenderzufriedenheit sorgen würde.

Aufgrund fehlender Unterstützung für eine modulare Dokumentation müssen gleiche Inhalte oftmals mehrfach erstellt werden, was erheblichen Mehraufwand zur Folge hat. Auch erschwert dies eine Vereinheitlichung der Dokumentationserstellung und führt bei Aktualisierungen zu Inkonsistenzen – insbesondere wenn die Erstellung dieser an sich gleichen Informationen durch unterschiedliche Autoren erfolgt. Und nicht zuletzt beeinträchtigt diese Arbeitsweise die Qualität und den Zeitaufwand bei der Übersetzung.

Fazit

Fasst man die oben diskutierten Aspekte zusammen, so lassen sich die folgenden Aufgabenschwerpunkte für Dokumentenmanagement-Systeme im Umfeld der Technikredaktion festhalten:

Auf dem Markt adressieren bereits einige Produkte eben diese Anforderungen. Dennoch ist die Umstellung herkömmlicher Dokumentationserstellung auf neue Techniken mit einem nicht zu unterschätzenden anfänglichen Aufwand verbunden. Dieser Aufwand, der stark von der gegenwärtigen Dokumentations-Basis abhängt, bezieht sich dabei auch oft auf organisatorische Änderungen, die den Erstellungsprozess beeinflussen. Mittel- bis langfristig ist der Umstieg auf Dokumentenmanagement-Systeme jedoch in jedem Fall auch wirtschaftlich vertretbar – wenn nicht sogar unabdingbar.

Letzte Änderung: 31.10.2005 | Presse-Service | Disclaimer
© doculine Verlags-GmbH, ein Unternehmen der transline Gruppe