Doku-Tipp N°3: Das Gleiche – in 100 verschiedenen Versionen

Arbeiten Menschen in einem Dokumentationsprojekt zusammen – auf Datei-Basis-  so kommt es unweigerlich zu einer klassischen Situation:

Ein zunehmendes Chaos mit Datei-Versionen.

Das Problem ….

Je mehr Personen an einem Dokument arbeiten und je mehr Revisionszyklen durchgeführt werden, umso höher wird der Aufwand alle Änderungen zu überblicken / einzufordern und in eine Endversion einzupflegen. Das kann sehr schnell zu einer nicht mehr bewältigbaren Aufgabe werden. Dabei können enorme Mehrfachaufwände, Doppelgleisigkeiten, Fehler, Zeitverzögerungen – und eine ganze Menge Frustration entstehen.

Die Lösung ….

Schon ab zwei Projektteilnehmer/innen und häufigen Überarbeitungszyklen, wird diese Problematik ohne spezialisierte Software unangenehm spürbar.

Moderne Textverarbeitungsprogramme bieten zwar Funktionen , wie Änderungsverläufe, die Korrekturen aller Beteiligten im herumgereichten Dokument farblich anzeigen und verwalten lassen. Diese werden im Kontext jedoch schnell unübersichtlich.  Exzessive Korrektur Zyklen im “Änderungen-verfolgen-Modus” (in MS-Word) können das Seitenlayout so stark verzerren, dass es immer schwere fällt, sich noch auf den (korrekten) Inhalt im Kontext zu konzentrieren.

Außerdem sind geordnete “Roll-Backs” auf frühere (korrektere) Versionen schwer möglich, falls ein Dokument “zu-Tode-korrigiert” wurde und/oder MS-Word (wieder einmal) einen “bösen Zauber” mit den Text-Formatierungen aufführte.

Überhaupt sollte man sich vor jedem professionellen Dokumentationsprojekt fragen, ob ein herkömmliches Textverarbeitungsprogramm, wie z.B. MS-Word / Open Office etc.. überhaupt den Aufgaben gewachsen sein wird.

DMS Systeme hingegen verfügen über Versionierungsfunktionen auf Dateibasis, zusätzlich zu Änderungsverlaufsfunktionen. Auf diese Art lassen sich nicht nur Änderungen aller Projektmitarbeiter/innen nachverfolgen, sondern auch auf frühere, passendere Dokument-Versionen “zurückschalten”, falls ein irreparables Malheur im Dokument auftritt.

Eine andere, simple und pragmatische Möglichkeit ist, nur eine zentrale (online) Version zu erlauben, Abänderungen werden nur an dieser Version durchgeführt und pro Benutzer mitprotokolliert.

Erst nach Fertigstellung wird ein Dokument (wenn nötig) als Datei exportiert.

Siehe dazu Wiki-Systeme oder auch Google Docs etc..

Leider fördern gängige Wiki-Systemen oder Google Docs nicht die Standardisierung (Vereinheitlichung) / Wiederverwendung von Text(abschnitten), wie sie bei technischen Dokumentationen erforderlich ist / sein sollte.

Bei Wikis gibt es in der Regel keinen funktionellen Ansatz bestehende, genehmigte Texteinheiten wiederzuverwenden, somit erhöhen sie ebenfalls die Wahrscheinlichkeit, dass neue syntaktische und inhaltliche Fehler eingestreut oder ein unpassendes “wording” verwendet wird, dass in der Organisation nicht üblich / genehmigt wurde.

Überlegenheit bieten hier textbausteinartige / kataloghafte Text-Datenbanken. Sie ermöglichen den Benutzern eine Übersicht über bestehende, genehmigte Texte und können so neue oder ähnliche

Dokumente schnell (weiter)entwickeln. Durch Bündeln und Verknüpfen mit inventarisierten “Text-Assets” lassen sich schnell neue Dokumente “zusammenbauen”.  Diese Text-Assets sind versioniert und bleiben einzigartig (unique).

Bei ähnlichen Dokumenten können anhand der Wiederverwendung von einzigartigen Text-Assets sehr schnell inhaltliche Updates durchgeführt werden. Dies ist besonders bei Funktionsbeschreibungen von ähnlichen Produkten sehr praktisch und aufwandsschonend. Ein weiterer Vorteil.

In der Regel sind Systeme mit den oben beschriebenen Eigenschaften teuer und komplex.

Ist Ihr Dokumentationsprojekt zu komplex und festgefahren?
Es gibt einen Ausweg – er ist hier >

Anfrage senden