Best Practices für die Dokumentenversionskontrolle

So funktioniert es

1. Frieren Sie das Nummerierungsschema ein, sobald echte Dokumente davon abhängen

   Behandeln Sie eine Änderung am Schema selbst (von ganzen Zahlen zu semantischer Versionierung wechseln, oder neu definieren, was eine Dezimalzahl bedeutet) als Projekt, nicht als Feinschliff: Sie entwertet jeden bestehenden Querverweis, Schulungsnachweis und jede vorherige Auditzitierung. Taucht ein Mangel auf, dokumentieren Sie die Ausnahme künftig, statt die Bibliothek umzunummerieren.

2. Setzen Sie Version, Datum und Freigeber an eine feste Stelle auf jeder Vorlage

   Wählen Sie eine einzige Position (Kopf- oder Fußzeile) und backen Sie sie in die Dokumentvorlage ein, sodass jeder Autor sie ohne Entscheidung nutzt. Eine Versionsnummer im Dateinamen oder in den Dokumenteigenschaften übersteht keinen Ausdruck, keinen Screenshot und keine E-Mail-Weiterleitung; eine auf der Seite gedruckte schon.

3. Geben Sie der „aktuellen“ Version eine Sperr- oder Checkout-Konvention

   Entscheiden Sie, wer die aktuelle Version gleichzeitig zur Bearbeitung offen haben darf, und wie ein zweiter Autor erfährt, dass es schon jemand hat: ein Checkout-Kennzeichen im Register, eine gesperrte Datei oder ein einziges maßgebliches, lebendes Exemplar, bei dem immer nur ein Speichervorgang gewinnen kann. Ohne das ist es kein hypothetischer Fall, dass zwei freigegebene Bearbeitungen auf derselben Version landen.

4. Schreiben Sie die Haupt-gegen-Unter-Regel auf, bevor das erste Dokument sie braucht

   Legen Sie im selben Dokument, das das Nummerierungsschema definiert, genau fest, was den Ganzzahlschritt auslöst: allein die formale Freigabe, oder Freigabe plus eine wesentliche Überarbeitung. Ein Team, das das von Fall zu Fall entscheidet, endet mit zwei verschiedenen Dokumenten, die beide Version 2.0 heißen.

5. Erfassen Sie jede turnusmäßige Überprüfung, auch die, die nichts ändern

   Geben Sie dem Prüfschritt eine Entscheidungsform mit einem beschrifteten Ausgang „keine Änderung“, der einen datierten Eintrag ins Register schreibt, so wie „Änderung nach Veröffentlichung angefragt?“ „Aktuelle Version bleibt in Kraft“ erreicht, statt einfach nichts zu tun. Ein fehlender Eintrag sollte bedeuten, dass die Prüfung nicht stattfand, nicht dass währenddessen nichts geschah.

6. Lassen Sie ein maßgebliches, lebendes Exemplar das Sperrproblem ganz beseitigen

   Öffnen Sie das Dokument als QueryChart-Diagramm statt als Satz per E-Mail verschickter Dateien, und es gibt nur eine aktuelle Version zu bearbeiten: jedes Speichern wird automatisch als neuer Eintrag im Änderungsprotokoll erfasst, sodass eine Checkout-Konvention nichts mehr durchzusetzen hat. Siehe /features/version-control.

Häufig gestellte Fragen

Was ist der größte Fehler bei der Dokumentenversionskontrolle, den man vermeiden sollte?

Das Schema als fest zu behandeln, nur bis jemand einen Grund findet, es zu ändern. Eine bestehende Bibliothek umzunummerieren (selbst um einen echten Mangel zu beheben) zerstört jeden Querverweis, Schulungsnachweis und jede Auditzitierung, die die alten Nummern benannt hat, und dieser Preis übersteigt fast immer die Kosten, mit einem unvollkommenen Schema zu leben. Beheben Sie Probleme künftig mit einer dokumentierten Ausnahme, nicht indem Sie das bereits Ausgegebene anfassen.

Wie verhindere ich, dass zwei Personen dieselbe „aktuelle“ Version gleichzeitig bearbeiten?

Fügen Sie entweder eine explizite Checkout-Konvention hinzu (ein Kennzeichen im Register, das zeigt, wer das Dokument offen hat, damit ein zweiter Autor weiß, dass er warten muss), oder beseitigen Sie die Möglichkeit strukturell, indem Sie genau ein maßgebliches, lebendes Exemplar führen statt Dateien, die per E-Mail oder über ein gemeinsames Laufwerk verschickt werden. QueryChart tut Letzteres: Jedes Dokument ist ein lebendes Diagramm, jedes Speichern versioniert automatisch, und es gibt kein zweites Exemplar, das sich abspalten könnte. Siehe /features/version-control.

Was sollte als Haupt- gegenüber einer Unterversion zählen?

Es gibt keine universelle Regel, weshalb es genau deshalb schriftlich festgelegt werden muss, bevor das erste Dokument es braucht, statt von Fall zu Fall beurteilt zu werden. Eine gängige Konvention bindet den Hauptschritt, die ganze Zahl, allein an die formale Freigabe (jede Entwurfsrevision dazwischen, wie substanziell auch immer, bleibt eine Dezimalzahl), sodass „wie groß war die Änderung“ nie in dem Moment diskutiert werden muss, in dem eine Versionsnummer vergeben wird.

Muss ich eine turnusmäßige Überprüfung protokollieren, die keine Änderungen ergab?

Ja: eine unprotokollierte Überprüfung ist nicht von einer Überprüfung zu unterscheiden, die nie stattgefunden hat. Geben Sie dem Prüfschritt in Ihrem Prozess eine Entscheidungsform mit einem beschrifteten Ausgang für „keine Änderung nötig“, der trotzdem einen datierten Eintrag ins Register schreibt, genau wie die Entscheidungszeile eines Diagramms jeden Zweig protokolliert, den sie nimmt, nicht nur die, die zu etwas Neuem führen.