Wie dokumentieren Sie denn Ihre Dokumentation?

Was ist Doku-Doku?

"Doku-Doku" meint die Dokumentation von technischer Dokumentation. Erforderlich wird Doku-Doku vor allem bei umfangreichen und pflegeintensiven Handbüchern und Online-Hilfen, deren Entstehungsprozess durch das Einarbeiten von vielfältigen und definierten Input-Quellen gekennzeichnet ist.

Die Aktualität von Doku-Doku

Branchen übergreifend verlangen immer mehr Firmen Doku-Doku und zwar gegenüber Dienstleistern wie auch intern. Dies ist Ausdruck der gestiegenen Bedeutung von technischer Dokumentation, in der aktuellen wirtschaftlichen Situation aber vor allem Anzeichen eines verschärften Kostendrucks. Dient Doku-Doku im ersten Fall nur der Qualitätskontrolle, kommt im zweiten Fall die Effizienzkontrolle hinzu. Angesichts des Trends gerade großer Firmen zum Outsourcing erhält die Doku-Doku ihre besondere Bedeutung.

Qualitäts- und Effizienzkontrollen

Fällig werden Kontrollen entweder laufend, bei Abgaben oder bei Übergaben. Und immer dann, wenn Dokumente keine intensive Lektüre durch Fachpersonal erfahren können, sich aber auch nicht durch den "Augenschein" von Verwaltungspersonen kontrollieren lassen.

Was bedeuten solchen Qualitäts- und Effizienzkontrollen konkret? Sie bedeuten, dass zu beliebigen Zeitpunkten - d.h. schnell - zusätzlich zu den zu erstellenden Dokumenten idealerweise eine einzige ausdruckbare Datei existiert, die übersichtlich alle relevanten Informationen enthält.

Zwei Hauptfragen stellen sich: nach den relevanten Informationen - den Qualitäts- und Effizienzkriterien - und nach Techniken und Tools, mit denen Doku-Doku erstellt, verwaltet und ausgegeben werden kann.

Qualitäts- und Effizienzkriterien

Die Qualitäts- und Effizienz-Kriterien lassen sich unterteilen nach den geläufigen Kategorien Projekt-, Dokumenten- und Content-Management. Die folgende Auflistung der Kriterien gibt ein exemplarisches Bild von der Breite der von Doku-Doku zu erfüllenden Anforderungen:

Projekt-Management

Termin-Treue und Kosten-Treue
Personal und Tätigkeiten

Dokumenten-Management

Dokumenten- und Datei-Typen (Tools)
Ablage, Historie und Versionierung

Content-Management

Ort, Thema, Umfang
Art und Herkunft des Input
Status der Bearbeitung
Richtigkeit, Verständlichkeit
Aufbau, Inhaltsverzeichnis
Index, Glossar, Verweissystem
Konventionen, Layout und Effekte

Doku-Doku-Techniken

Die Auflistung der Kriterien erscheint weniger interessant als die Frage, wie man sie dokumentieren, d.h. schriftlich mitteilen kann.

Richtigkeit und Verständlichkeit

Zuerst ist festzuhalten, was sich der Doku-Doku entzieht: der Nachweis der Richtigkeit und Verständlichkeit. Zwar könnten hierzu Beispiele ausgegeben werden - wofern nicht spezielle Tools für das Scannen der gesamten Dokumentation existieren. Doch ist es unmöglich, komplette Dokumente diesbezüglich formal zu dokumentieren und so die Lektüre durch eine kompetente Person zu ersetzen.

Dokumentenvergleich

Als eine Möglichkeit bietet sich der Dokumentenvergleich an, wie er gerade von Textverarbeitungsprogrammen unterstützt wird. Das Resultat ist eine Datei, die alle Änderungen zwischen zwei Ständen desselben Dokumentes markiert. Doch abgesehen von der technischen Unzuverlässigkeit des Dokumentenvergleichs bei großen und stark veränderten Dokumenten, sind Änderungsmarkierungen schwer lesbar und wenig aussagekräftig - müssten also nachträglich überarbeitet und kommentiert werden, was wenig praktikabel erscheint und das Dokument extrem aufbläht.

Versionierung und Historie

Die Erfordernis einer nachträglichen Kommentierung ergibt sich auch bei üblichen Verfahren der Versionierung und Historie-Dokumentation. Zu wissen, welcher Stand eines Dokumentes - und im Idealfall einer detaillierten Informationseinheit - wie alt ist bzw. von welcher Person zu welchem Zeitpunkt geändert wurde, gibt keine Auskunft zum Inhalt: d.h. zum Zustand der Änderung, ihrer Referenz auf den Input u.ä.

Kontext-Referenz

Der Kommentierung im Gesamtkontext des Dokumentes, d.h. am Ort der Änderung selbst, steht die Extraktion der Änderungen an einen anderen Ort (Datei) gegenüber. Das vermag den Arbeitsfortschritt besser zu dokumentieren; Nachteil ist, dass der Kontext der Änderung fehlt und nur durch eine externe Referenz adressiert werden kann (Angabe von Topic bzw. Seite/Zeile).

Instantane Kommentierung

Die Kommentierung kann nur während oder im direkten Anschluss der redaktionellen Arbeit erfolgen, muss aber die Möglichkeit späterer Bearbeitung bieten. Ideal ist eine vom Tool unterstützte "Verpflichtung" der Redakteure, eine vorgenommene Änderung durch Angabe definierter Kriterien zu kommentieren.

Fehlerquellen

Gleichwohl muss allen Beteiligten der Qualitäts- und Effizienzkontrolle klar sein: Es besteht für einen Großteil der Kriterien - es sind wohl die eigentlich wichtigen - die Möglichkeit der willentlichen oder unwillentlichen Fehl- oder Mindereingabe.

Fazit

Das Ideal einer einzigen Doku-Doku-Datei gestaltet sich so, dass diese in einer Rubrik Angaben zum Projekt-Management enthält, in einer zweiten Rubrik Angaben zum Gesamtbestand der Dokumente und in einer dritten Rubrik einerseits Angaben zu globalen, z.B. formalen oder technischen Änderungen, andererseits zu inhaltlichen Änderungen, die anhand definierter Kriterien strukturiert sind. Es ergibt sich das Bild einer komplexen, tabellarischen Übersicht.

Doku-Doku-Tools

Stellt sich die Frage, welches Tool in der Lage ist, die genannten Kriterien zu erfüllen. Die Messlatte ist hoch, denn zu den aufgestellten kommen weitere Kriterien hinzu wie

Aufwand (Anschaffung, Einrichtung, Pflege, Kompatibilität)
Flexibilität (Server-basiert, Datenbank-basiert, Multi-User-Fähigkeit, externer Zugriff)
Ausrichtung (Handbuch, Online-Hilfe, Single-Source)

Orientiert man sich an üblichen Management-Systemen, so kommen die folgenden Kandidaten (in ihrer klassischen Ausprägung) aus verschiedenen der genannten Gründe grundsätzlich nicht in Frage:

Projektmanagement-Systeme
Dokumentenmanagement-System
Content-Management-Systeme
Versionsverwaltungs-Systeme

Interessant erscheinen dagegen Redaktions-Systeme, die die Vorteile der genannten Systeme zu vereinen versuchen. Ein Beispiel ist RoboSource Control von RoboHelp X5. Allerdings sind mit solchen Tools immer Grundsatzentscheidungen verbunden sind, die einschränkend wirken und händisch erstellte, tabellarische Verfahren flexibler sein lassen.

Vortragspräsentation (PDF)