Versionskontrolle einfach gemacht

Text: Matthias Lohrer

Mit einer durchdachten Ablage und Verwaltung von Dokumenten finden alle, was sie brauchen – zügig und punktgenau. Ein Tipp für die Praxis.

Inhaltsübersicht

Lesedauer: 06:15 Minuten

Jede Mitarbeiterin und jeder Mitarbeiter erstellt Dokumente. Nichts leichter als das, aber irgendwann kommt der Zeitpunkt, an dem es plötzlich heißt: Ab sofort unterliegen die Dokumente einer Versionskontrolle. Das kann eine Technische Dokumentation betreffen, ein Formular, eine Prozessdefinition oder auch die AGB. Im Grunde ist kein Dokument davor sicher. Aber wie legt man Dokumente ab, die einer Versionskontrolle unterworfen sind? „Im Content-Management-System“, sagen die einen. „Auf SharePoint, dort ist ein Versionierungssystem“, rufen die anderen. „Irgendwie halt“, meint der Auszubildende. Und der Technische Redakteur denkt sich: „Dafür nutze ich in Word einfach die Änderungsverfolgung.“

Das ist alles nicht falsch. Wer für seine Dokumentenverwaltung ein Content-Management-System zur Verfügung hat, der kann und soll die Versionierung von Dokumenten darüber regeln. Nun hat aber nicht jeder ein solches System zur Verfügung. Und wer eine Anwendung wie SharePoint einsetzt, der kann die entsprechende Funktionalität zwar nutzen. Aber er muss seine Kolleginnen und Kollegen unterweisen und kontinuierlich motivieren, SharePoint auch wirklich so zu nutzen. Natürlich gibt es Unternehmen, die weder das eine noch das andere System nutzen. Die bereits genannte Änderungsverfolgung in Word oder anderen Programmen ist für sich genommen zunächst eine nützliche Funktionalität. Sie garantiert aber ebenfalls keine planvolle Ablage der verschiedenen Versionen.

Wahrscheinlich wird es viele Firmen geben, die die Ablage von versionierten Dokumenten so regeln, wie der Azubi vorschlägt: irgendwie halt. Es ist ja nicht schwierig, die Datei mit der neuen Version anders zu benennen. Anschließend wird man sich schon zurechtfinden. Das kann eine Weile gut gehen, wird aber dann etwas dürftig, wenn die Ansprüche steigen. Und die Ansprüche steigen spätestens dann, wenn ein Unternehmen den Nachweis erbringen will oder muss, dass man bei der Versionierung von Dokumenten planvoll vorgeht.

Was fordern gängige Normen?

Die DIN EN 82079-1 fordert in Abschnitt 5.2 „Identifikation von Gebrauchsanleitungen“: „Gebrauchsanleitungen müssen eine eindeutige Kennzeichnung haben einschließlich … c) Revisionsindex und Datum der Revision, sofern anwendbar.“

Die Qualitätsnorm ISO 9001:2015 fordert im Abschnitt 7.5.3 die Lenkung dokumentierter Information. Tätigkeiten, die in diesem Zusammenhang anfallen, sind

  • die Ablage
  • das Auffinden
  • die Überwachung von Änderungen (Versionskontrolle)

Sieht ein Unternehmen sogar ein Qualitäts-Audit auf sich zukommen, sollte man für die Ablage versionierter Dokumente ein Konzept vorweisen können. Es sollte eindeutig über „irgendwie halt“ hinausgehen.

Ein Ablagekonzept stelle ich in den folgenden Abschnitten vor. Es ist im Prinzip simpel und kostet keinen Cent extra. Außerdem eignet es sich gut für die Arbeit im Team. Hat man es erst einmal eine Weile im Einsatz, dann freut man sich darüber, dass weniger Zeit auf das Suchen entfällt und viele Informationen auf Anhieb verfügbar sind.

Im ersten Schritt zeige ich, welche Informationen wo liegen. Im zweiten Schritt spiele ich einen kompletten Änderungszyklus durch; aber zunächst ein Blick auf die Ablagestruktur (Abb. 01).

Struktur und Funktion

Abb. 01 Ablagestruktur und Funktion des Ablageorts. Quelle Matthias Lohrer

Wie sollte die Ablage definiert werden?

Die Ablage der Dokumente erfolgt im Dateisystem. Für das Dokument, das in mehreren Versionen vorhanden ist, muss es zunächst einen Heimatordner geben. Die Betriebsanleitung für einen Maschine namens „Printer“ könnte beispielsweise hier liegen: D:\BA_Printer.

Unterschätzen Sie diesen ersten Schritt nicht. Es ist unglaublich viel gewonnen, wenn wirklich alle Beteiligten wissen, an welcher Stelle sie die gültige Version eines bestimmten Dokuments finden können. Das bedeutet auch, dass das Dokument künftig nur noch hier liegen darf. Löschen Sie alle Kopien des Dokuments in Ihren Dateisystemen. Für Ihr Dokument gibt es künftig nur noch einen gültigen Ort, und das ist der Heimatordner. Er enthält drei weitere Ordner mit diesen Namen:

  • A_Archiv
  • B_AktuellesDokument

C_NaechsteVersion

Wenn man den Ordner B_AktuellesDokument öffnet, zeigt er Folgendes:

  • BA_Printer.pdf
  • BA_Printer.docx
  • Change (Ordner)

Die Datei „BA_Printer.pdf“ enthält das aktuell gültige Dokument im PDF-Format. Diese PDF-Datei wurde aus der hier abgelegten Word-Datei „BA_Printer.docx“ erstellt. Die Änderungsverfolgung der Word-Datei ist hier deaktiviert, weil alle Änderungen übernommen wurden. Der Ordner „Change“ enthält alle Materialien, die beim Erstellen dieser Version verwendet wurden.

Hier findet sich kein Hinweis auf irgendeine Versionsnummer. Das ist aus folgendem Grund gewollt: Dokumente werden verlinkt, beispielsweise auf einem SharePoint-Server, Inter- oder Intranet oder auch in anderen Systemen. Wenn das aktuell gültige Dokument im Dateinamen keinen Hinweis auf die Versionsnummer enthält, dann ist das praktisch bei einer Aktualisierung. Denn wenn man die Datei austauscht, funktionieren alle Links auf die Datei auch nach der Aktualisierung.

Manchmal muss man detailliert nachverfolgen können, was sich zur jeweiligen Vorversion geändert hat. Das lässt sich über den Ordner „Change“ herausfinden. Wenn man den Ordner öffnet, dann findet man hier wieder die Datei „BA_Printer.docx“. In dieser Word-Datei ist die Änderungsverfolgung aktiviert. Sie enthält alle Änderungen zur direkten Vorversion. Außerdem liegen hier beliebige weitere Dateien und Ordner mit Informationen, die irgendwie in diese Version eingeflossen sind. Das können zum Beispiel Ordner mit Fotos, Screenshots oder weitere Unterlagen sein, die für diese Version relevant waren. (Inf. 01).

Versionsmanagement

So viel zum Ordner „B_AktuellesDokument“, nun zum Ordner „A_Archiv“: Unterhalb davon liegen Ordner für die bislang erstellten Versionen, zum Beispiel

  • Version01
  • Version02
  • Version03 …

Wenn man einen dieser Ordner öffnet, findet man die gleiche Struktur vor wie in „B_AktuellesDokument“. Auch hier bietet der Ordner „Change“ Zugriff auf die Veränderungen zur jeweiligen Vorversion.

Es bleibt der Zweig „C_NaechsteVersion“. Dieser Ordner kann leer sein, wenn noch keine Informationen für eine kommende Version vorliegen. Der Ordner kann auch bereits die Datei „BA_Printer.docx“ enthalten, wobei hier die Änderungsverfolgung aktiviert ist. Diese Datei bearbeitet die Technische Redakteurin oder der Redakteur, wenn die kommende Version erstellt wird. Wer auch immer etwas zur kommenden Version beizutragen hat, kann die entsprechenden Dokumente in diesem Ordner ablegen. Hier kann man nach Belieben eigene Ordner erstellen, etwa für Screenshots und Fotos.

Damit ist die Ablagestruktur bereits erklärt. Als Nächstes soll ein Änderungszyklus durchgespielt werden.

Wie werden Änderungen verwaltet?

Nehmen wir an, von der Betriebsanleitung für den Printer ist die Version 3 aktuell gültig. Nun überarbeitet die Entwicklungsabteilung die Bedienoberfläche der Steuersoftware. Der Softwareentwickler erstellt Screenshots von den geänderten Seiten. Dann öffnet er den Zweig „D:\BA_Printer\C_NaechsteVersion“, erstellt hier einen Ordner „Screenshots“ und legt die Dateien mit den Screenshots darin ab.

Außerdem will die Geschäftsführung im Kapitel über Garantiebedingungen Änderungen vornehmen. Eine entsprechende E-Mail legt die Technische Redakteurin oder der Redakteur ebenfalls im Zweig „C_NaechsteVersion“ ab. Irgendwann ist es so weit: Die Version 4 der Betriebsanleitung von Printer soll erstellt werden. Nun werden die Schritte abgearbeitet, die unter „Eine neue Version erstellen“ dargestellt sind (Inf. 02).

Variantenmanagement

Wo liegen die Vorteile?

Die geschilderte Vorgehensweise ist einfach, kostenlos und macht kaum zusätzliche Arbeit. Alle Daten, die hier strukturiert abgelegt werden, fallen im normalen Arbeitszyklus sowieso irgendwann an. Für die Ablage der Daten gibt es einerseits eine vordefinierte Struktur. Andererseits hat man genügend Freiheiten, relevante Informationen in der jeweils passenden Form abzulegen.

Was sind die Nachteile?

Natürlich muss man daran denken, zum richtigen Zeitpunkt die richtigen Dateien an den richtigen Ort zu kopieren oder zu verschieben. Daher sollte die Vorgehensweise im Redaktionsleitfaden oder im Qualitätshandbuch definiert sein. Da alles über das Dateisystem organisiert wird, besteht die Gefahr, dass man beim Kopieren oder Verschieben Verzeichnisse verwechselt und das System in Unordnung bringt.

Wenn alle Kollegen Schreib- und Leserechte für diese Ordner haben, ist die Gefahr natürlich besonders groß. Daher sollten die Zugriffsrechte eingeschränkt werden. Das ganze Team darf zum Beispiel überall Leserechte haben. Schreibrechte bekommt das Team aber jeweils nur auf und innerhalb des Ordners „C_NaechsteVersion“. Denn hier soll jeder Kollege relevante Informationen ablegen können.

Wo liegt letztlich der Nutzen?

Wer „mal so eben“ Dokumente unter Versionskontrolle stellen muss, der findet hier ein praktikables Verfahren, das man noch vor der Mittagspause aus dem Ärmel schütteln kann. Aber die beteiligten Mitarbeiterinnen und Mitarbeiter müssen das Verfahren auch leben.

Aus eigener Erfahrung kann ich sagen: Je länger man das System im Einsatz hat, desto besser wird es. Sitzt man zum Beispiel in einem Meeting und bespricht Änderungen, dann weiß man ohne großes Nachdenken sofort, wo die Änderungen hingehören. Also gleich die Datei in C_NaechsteVersion öffnen, bearbeiten, die Änderungen in der Runde diskutieren und das Dokument speichern. So viel Effizienz beeindruckt die übrigen Teilnehmer und sorgt für einen pünktlichen Feierabend.

Versionkontrolle einfach gemacht