Vorlage: Versionskontrolle für Dokumente
Eine Vorlage zur Dokumentenversionskontrolle: Wie ein Entwurf über Unterversionen (0.1, 0.2 …) die Prüfung durchläuft, erst bei formaler Freigabe eine ganze Zahl erhält und wie spätere Revisionen die abgelöste Version ersetzen.
Was ist vorlage: versionskontrolle für dokumente?
Eine Versionsnummer ist die Kurzform, die allen sagt, welches Exemplar eines Dokuments sie gerade in der Hand haben und ob darauf Verlass ist. Diese Vorlage folgt der Konvention, die die meisten Qualitäts- und Dokumentenlenkungssysteme verwenden: Eine Dezimalzahl – 0.1, 0.2, 0.3 und so weiter – kennzeichnet einen Entwurf, der noch die interne Prüfung durchläuft, und eine ganze Zahl – 1.0, 2.0, 3.0 – kennzeichnet eine Version, die tatsächlich freigegeben und ausgegeben wurde. Die Regel ist einfach zu formulieren und in der Praxis leicht zu brechen, denn nichts hindert jemanden daran, einen Entwurf aus Gewohnheit mit der nächsten ganzen Zahl zu bezeichnen – genau die Verwechslung, die ein Nummerierungsschema verhindern soll.
Dieses Diagramm ist nicht der Lebenszyklus der Dokumentenlenkung. Antrag, Erstellung, formale Freigabe, Veröffentlichung und turnusmäßige Überprüfung – das gesamte Verfahren, das ein Dokument von Anfang bis Ende durchläuft – ist das Flussdiagramm zum Dokumentenlenkungsprozess unter /de/templates/dokumentenlenkung-prozess, und diese Vorlage setzt voraus, dass dieses Verfahren bereits existiert. Was dieses Diagramm herausgreift, ist ein einzelner Mechanismus innerhalb dieses Lebenszyklus: wie sich die Versionsnummer selbst bewegt – und es ist bewusst enger gefasst als ein Änderungsprotokoll. Festzuhalten, wer welche Zeile wann geändert hat, gehört in ein flaches Änderungsregister; dieses Diagramm befasst sich ausschließlich damit, welche Nummer ein Dokument an welchem Punkt seines Lebens tragen darf.
Die Nummerierung endet nicht mit der Erstveröffentlichung. Ein veröffentlichtes Dokument, das eine weitere Änderung braucht, durchläuft für die nächste Version denselben Prüf- und Freigabezyklus, statt ein neues Dokument zu beginnen, und die abgelöste Version wird als überholt markiert statt gelöscht – sodass jeder, der später eine alte gespeicherte oder ausgedruckte Fassung öffnet, auf einen Blick sieht, dass sie nicht mehr gültig ist.
Was dieses Flussdiagramm abdeckt
In dieser Vorlage
- Fünf Swimlanes für die Rollen, die mit der Versionsnummer zu tun haben – Autor, Prüfer, Versionsverantwortlicher, Freigeber und Leser –, über fünf Phasen: Entwurf, interne Prüfung, Überarbeitung, Freigabe sowie veröffentlicht und in Kraft.
- Entwurfsnummerierung: Ein neues Dokument erhält die Entwurfsversion 0.1, noch bevor es überhaupt in Umlauf geht, sodass schon das erste gesehene Exemplar eine nachvollziehbare Nummer trägt.
- Die Prüf- und Erhöhungsschleife: Die Entscheidung „Änderungen erforderlich?“ leitet einen Entwurf über „Unterversion erhöhen“ und „Entwurf gemäß Kommentaren überarbeiten“, bevor er zur erneuten Prüfung zurückgeht – so wird aus 0.1 die 0.2, aus 0.2 die 0.3, und die Nummer selbst hält fest, wie viele Zyklen ein Entwurf bereits durchlaufen hat.
- Das Tor zur Hauptversion: „Zur Ausgabe freigegeben?“ ist die einzige Entscheidung im Diagramm, die zur Vergabe einer ganzen Zahl führt. Ein abgelehnter Entwurf kehrt in den Unterversionszyklus zurück, statt trotzdem ausgegeben zu werden.
- Veröffentlichung und Ablösung: Das Versionshistorie-Register wird aktualisiert, die freigegebene Version wird am gelenkten Ablageort veröffentlicht, und die abgelöste Version wird als überholt markiert – all das, bevor ein Leser die neue Fassung überhaupt öffnet.
- Die Schleife nach der Veröffentlichung: Die Entscheidung „Änderung nach Veröffentlichung angefragt?“ leitet ein in Kraft befindliches Dokument für die nächste Version zurück in denselben Prüf- und Freigabezyklus, statt ein gültiges Dokument als unveränderlich zu behandeln.
Wann Sie diese Vorlage verwenden sollten
- Sie entwerfen oder dokumentieren ein Versionsnummernschema und müssen den Unterschied zwischen einer Entwurfsrevision und einer ausgegebenen Version zeigen, nicht nur behaupten.
- Prüfer zitieren immer wieder einen nicht ausgegebenen Entwurf, als wäre er die freigegebene Version – etwa wenn der dritte Prüfzyklus wie eine formale Ausgabe behandelt wird, weil beide irgendwann als „Version 3“ bezeichnet wurden.
- Sie legen fest, wo die Grenze zur Hauptversion verläuft – bei formaler Freigabe, bei einer wesentlichen inhaltlichen Überarbeitung oder nach einem festen Ausgabekalender – und wollen ein konkretes Beispiel als Grundlage, bevor Sie die Regel festschreiben.
- Sie müssen einem Auditor oder einem neuen Dokumentenbeauftragten erklären, warum eine überholte Version im Register weiterhin auffindbar ist, statt einfach gelöscht zu werden.
- Sie konfigurieren Regeln zur Versionsnummerierung in einem Dokumentenmanagementsystem oder einer Vorlagenbibliothek und wollen den Mechanismus abgebildet haben, bevor Sie ihn aufbauen.
So funktioniert es
Legen Sie Ihre Dezimal- und Ganzzahl-Konvention fest
Legen Sie fest und halten Sie schriftlich fest, dass Entwurfsversionen eine Dezimalzahl und ausgegebene Versionen eine ganze Zahl tragen – oder wählen Sie ein anderes Schema, falls Ihres davon abweicht. Wichtiger als das genaue Schema ist, dass es einmal festgelegt und überall angewendet wird, wo eine Versionsnummer erscheint: in Kopf- und Fußzeilen ebenso wie im Register.
Legen Sie fest, was als neuer Prüfzyklus zählt
Legen Sie die Regel hinter „Unterversion erhöhen“ fest: Erhöht jeder Korrekturdurchgang die Nummer, oder nur eine erneute Ausgabe des Entwurfs nach vorgenommenen Änderungen? Teams, die bei jedem Kommentarstrang erhöhen, landen bei Entwürfen jenseits der zwanzig; Teams, die nur bei erneuter Ausgabe erhöhen, halten die Zählung aussagekräftig.
Legen Sie die Regel für die Hauptversion fest
Formale Freigabe ist der Auslöser, den dieses Diagramm bei „Hauptversion 1.0 vergeben“ verwendet, aber manche Organisationen erhöhen die Hauptnummer auch bei einer wesentlichen Überarbeitung ohne vollständige erneute Freigabe. Wählen Sie eine Regel und wenden Sie sie konsequent an, denn eine vermischte Regel ist genau das, was Versionsnummern jede Aussagekraft nimmt.
Legen Sie fest, was mit einer überholten Version geschieht
Entscheiden Sie bei „Vorherige Version als überholt markieren“, wo diese frühere Version danach verbleibt: archiviert im Register mit ihrem Ablösedatum, oder aus dem gelenkten Ablageort entfernt, aber für einen festen Zeitraum aufbewahrt. Beides ist vertretbar; eine nicht dokumentierte Antwort ist es nicht.
Legen Sie fest, wie eine Änderung nach der Veröffentlichung nummeriert wird
Legen Sie bei „Dokument für die nächste Version wieder öffnen“ fest, ob eine Änderung an einem in Kraft befindlichen Dokument den Unterversions-Entwurfszyklus bei der nächsten ganzen Zahl neu startet oder die Dezimalzählung ab der letzten Hauptversion fortsetzt. Das ist die Regel, die die meisten Teams zu dokumentieren vergessen, bis die zweite Revision bereits läuft.
Häufig gestellte Fragen
Was ist der Unterschied zwischen einer Unter- und einer Hauptversion eines Dokuments?
Eine Unterversion, geschrieben als Dezimalzahl wie 0.1 oder 0.2, kennzeichnet einen Entwurf, der sich noch in der internen Prüfung befindet und nicht zur Anwendung freigegeben wurde. Eine Hauptversion, geschrieben als ganze Zahl wie 1.0 oder 2.0, kennzeichnet eine Version, die ein Freigeber tatsächlich unterzeichnet hat und die am gelenkten Ablageort veröffentlicht wurde. Die Unterscheidung existiert, damit die Angabe „Version 2“ immer ein ausgegebenes Dokument bedeutet – nie einen Entwurf, der sich zufällig im zweiten Prüfzyklus befindet.
Erzeugt jede Runde von Prüfkommentaren eine neue Versionsnummer?
Das legt Ihre Organisation als Regel fest, es ergibt sich nicht von selbst aus dem Nummerierungsschema. Viele Teams erhöhen die Unterversion nur, wenn ein Entwurf für eine weitere Prüfrunde erneut ausgegeben wird, nicht bei jedem einzelnen Kommentar, sodass die Nummer eine aussagekräftige Zählung der Entwurfszyklen bleibt statt eine Zählung der Bearbeitungen.
Was geschieht mit einer Version, sobald sie überholt ist – wird sie gelöscht?
Nein. Eine überholte Version wird im Versionshistorie-Register entsprechend markiert und in der Regel für eine festgelegte Aufbewahrungsfrist behalten, da sie den Nachweis liefert, was an einem bestimmten Datum gültig war. Sie wird aus dem gelenkten Ablageort entfernt, damit niemand versehentlich danach arbeitet – ein vollständiges Löschen würde jedoch den Nachweis vernichten, den ein Auditor oder eine Vorfalluntersuchung später benötigen könnte.
Wie unterscheidet sich das von einem Dokumentenlenkungsprozess oder einem Änderungsprotokoll?
Das Flussdiagramm zum Dokumentenlenkungsprozess unter /de/templates/dokumentenlenkung-prozess ist der vollständige Lebenszyklus, den ein Dokument durchläuft – Antrag, Erstellung, Prüfung, Freigabe, Ausgabe, Verteilung und turnusmäßige Überprüfung –, und diese Vorlage setzt voraus, dass dieser Lebenszyklus bereits existiert. Ein Änderungsprotokoll ist ein flaches Register einzelner Änderungen: wer was wann bearbeitet hat. Dieses Diagramm steht zwischen beiden: Es ist ausschließlich der Mechanismus, der festlegt, welche Nummer – Unter- oder Hauptversion – ein Dokument an welchem Punkt dieses Lebenszyklus tragen darf.
Wo dieser Prozess einzuordnen ist
In den meisten Unternehmen folgt dieser Prozess auf Flussdiagramm Dokumentenlenkung: Erstellung, Freigabe, Ausgabe und übergibt an Entscheidungsbaum Dokumentenfreigabe: Vorlage für den Workflow.
Er ist ein Schritt in Dokumentenlenkung.
Schritt 1: Flussdiagramm Dokumentenlenkung: Erstellung, Freigabe, Ausgabe
Flussdiagramm zur Dokumentenlenkung mit den Bahnen Autor, Prüfer, Freigeber, Dokumentenbeauftragter und Anwender: Erstellung, Freigabe, Ausgabe und turnusmäßige Überprüfung.
Schritt 2: Vorlage: Versionskontrolle für Dokumente Sie sind hier
Eine Vorlage zur Dokumentenversionskontrolle: Wie ein Entwurf über Unterversionen (0.1, 0.2 …) die Prüfung durchläuft, erst bei formaler Freigabe eine ganze Zahl erhält und wie spätere Revisionen die abgelöste Version ersetzen.
Schritt 3: Entscheidungsbaum Dokumentenfreigabe: Vorlage für den Workflow
Entscheidungsbaum für den Workflow der Dokumentenfreigabe: redaktionelle oder inhaltliche Änderung, Pflichtprüfer je Dokumentenart, zweite Freigabe und Kenntnisnahme bei Veröffentlichung.
Schritt 4: Ablaufdiagramm: Dokumenten-Change-Control-Workflow
Schritt 5: Flussdiagramm Richtlinienprüfung: Auslöser bis Kenntnisnahme
