Best Practices für die Dokumentenversionskontrolle
Best Practices für die Dokumentenversionskontrolle: Nummerierungsschema stabil halten, Version, Datum und Freigeber fest platzieren, parallele Bearbeitungen verhindern und jede Prüfung ohne Änderung protokollieren.
Best Practices für die Dokumentenversionskontrolle sind die Gewohnheiten, die ein bestehendes Nummerierungsschema über Jahre von Personalwechseln und Volumen hinweg vertrauenswürdig halten, nicht die Regeln für die Wahl des Schemas selbst.
Kurz gesagt
- Halten Sie das gewählte Nummerierungsschema stabil: eine Umnummerierung zerstört jeden Querverweis, der die alte Nummer zitiert hat.
- Drucken Sie Version, Datum und Freigeber an derselben festen Stelle auf jeder Seite, nicht nur im Dateinamen oder in den Eigenschaften.
- Lassen Sie nie zwei Personen die „aktuelle“ Version parallel bearbeiten, ohne eine Sperr- oder Checkout-Konvention.
- Entscheiden Sie im Voraus, schriftlich, genau, was eine Änderung zur Haupt- statt zur Unterversion macht.
- Behandeln Sie „keine Änderung nötig“ als protokolliertes Prüfungsergebnis, nicht als Schweigen.
- QueryChart ersetzt die Checkout-Konvention durch ein einziges maßgebliches, lebendes Diagramm: siehe /features/version-control.
Ein Schema ist nur so gut wie sein zweites Jahr
Ein Nummerierungsschema scheitert selten im ersten Monat. Es scheitert im zweiten Jahr, wenn die Person, die „ganze Zahlen für ausgegebene Exemplare“ festgelegt hat, weitergezogen ist, ein neuer Dokumentenbeauftragter eine leicht andere Regel für einen dringenden Einzelfall erfindet, und plötzlich zwei Konventionen gleichzeitig durch dasselbe Register laufen. Diese Seite setzt voraus, dass die grundlegende Entscheidung bereits gefallen ist (ein Schema überhaupt zu wählen ist unter /de/guides/versionskontrolle-fuer-dokumente behandelt) und handelt von den wenigen Gewohnheiten, die ein gewähltes Schema am Laufen halten, sobald echtes Volumen, Personalwechsel und Dringlichkeit darauf treffen.
Vier Dinge gehen schief, nachdem das Schema gewählt ist, und keines davon liegt am Schema selbst. Eine bestehende Bibliothek umzunummerieren, um einen vermeintlichen Mangel zu beheben, zerstört jeden Querverweis, Schulungsnachweis und jede vorherige Auditzitierung, die die alten Nummern benannt hat, sodass es meist mehr kostet als mit dem Mangel zu leben. Eine Versionsnummer, die nur in einem Dateinamen oder einem Eigenschaftenfeld lebt, verschwindet, sobald jemand eine Seite ausdruckt oder einen Screenshot weiterleitet, sie braucht also stattdessen eine feste, gedruckte Position. Zwei Autoren, die dieselbe „aktuelle“ Datei am selben Nachmittag bearbeiten, ist überhaupt kein Nummerierungsproblem: es ist eine fehlende Sperr- oder Checkout-Konvention, und kein Schema übersteht das ohne eine solche. Und eine turnusmäßige Überprüfung, die nichts Falsches findet, muss trotzdem eine Spur hinterlassen, sonst ist sie ein Jahr später nicht von einer Überprüfung zu unterscheiden, die nie stattgefunden hat. Nichts davon ist der gesamte Lebenszyklus des Dokuments (Antrag bis Außerkraftsetzung wird vollständig unter /de/templates/dokumentenlenkung-prozess durchgegangen), es ist die Nummerierungsschicht innerhalb dieses Lebenszyklus, gut gemacht statt nur erledigt.
QueryChart beseitigt einen dieser Fehlermodi strukturell statt durch Richtlinie. Es gibt pro Dokument genau ein maßgebliches, lebendes Diagramm statt eines Satzes von Dateien, die sich jemand merken muss zu sperren, jedes Speichern wird automatisch als neuer Eintrag im Änderungsprotokoll erfasst, mit der handelnden Person und dem genauen geänderten Feld, und der Versionsvergleich stellt beliebige zwei Revisionen nebeneinander. Zwei Personen können das „aktuelle“ Exemplar nicht stillschweigend spalten, weil es nur eines gibt, und seine gesamte Historie ist eine Abfrage statt eines Gedächtnistests. Siehe /features/version-control.
Wo diese Praktiken im Leben eines Dokuments auftauchen
Dasselbe 18-zeilige Diagramm zur Dokumentenversionskontrolle, gelesen dafür, was sein Nummerierungsschema trägt, statt für die Nummerierungsschritte selbst.
Das Schema beginnt, bevor irgendjemand etwas prüft
„Erste Entwurfsversion 0.1 vergeben“ geschieht unmittelbar nach „Neues Dokument entworfen“, vor „Entwurf zur internen Prüfung verteilen“ oder „Prüfer bewertet den Entwurf“: das Dezimalschema wird in Zeile zwei festgelegt, nicht erst mitten in der ersten Entscheidung „Änderungen erforderlich?“ erfunden.
Nacharbeit erhöht, sie nummeriert nie um
„Unterversion erhöhen“ und „Entwurf gemäß Kommentaren überarbeiten“ schleifen über einen Zweig namens „Erneute Prüfung“ zurück in die Prüfung, bevor „Finalen Entwurf zur Freigabe einreichen“ und „Freigeber prüft den finalen Entwurf“ folgen: dieselbe Dezimalregel gilt über jeden Durchlauf, sodass das Zitieren von Entwurf 0.3 weiterhin genau eine Kopie benennt.
Eine Entscheidung zieht die Haupt-gegen-Unter-Grenze
„Zur Ausgabe freigegeben?“ ist die einzige Zeile mit einem Weg zu einer ganzen Zahl: Der Zweig Freigegeben erreicht „Hauptversion 1.0 vergeben“, während Abgelehnt zurück zu „Unterversion erhöhen“ schleift: dann fixieren „Versionshistorie-Register aktualisieren“, „Freigegebene Version veröffentlichen“ und „Vorherige Version als überholt markieren“ diese Entscheidung in einer Datei-Zeile, bevor irgendjemand das neue Exemplar liest.
Ein Dokument, das keine Änderung braucht, erhält trotzdem eine Spur
„Änderung nach Veröffentlichung angefragt?“ wird auch beantwortet, wenn die Antwort Nein lautet: dieser Zweig endet bei „Aktuelle Version bleibt in Kraft“, einem benannten Ergebnis statt einer Abwesenheit von Aktivität, während Ja das Dokument bei „Dokument für die nächste Version wieder öffnen“ wieder öffnet, statt eine zweite Kopie daneben zu beginnen.
So funktioniert es
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.
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.
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.
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.
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.
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äufige Fehler
Umnummerieren, um einen Fehler zu beheben
Zwei Jahre später einen Mangel im Schema zu entdecken und das gesamte Register umzunummerieren, um ihn zu beheben, zerstört jede Zitierung, die die alten Nummern benannt hat: Audits, Schulungsnachweise, Querverweise in anderen Dokumenten. Dokumentieren Sie stattdessen die Ausnahme künftig; leben Sie mit dem Mangel im bereits Ausgegebenen.
Die Versionsnummer, die nur im Dateinamen lebt
„Richtlinie_v3_FINAL.docx“ sagt niemandem etwas, sobald sie ohne ihren Namen ausgedruckt, weitergeleitet oder kopiert wird. Setzen Sie Version, Datum und Freigeber in das Dokument selbst, immer an derselben festen Stelle.
Zwei „aktuelle“ Exemplare am selben Nachmittag bearbeitet
Ein Exemplar auf einem gemeinsamen Laufwerk und ein per E-Mail verschicktes Exemplar werden beide bearbeitet, als wäre jedes der Master, und die beiden Änderungssätze überschreiben sich stillschweigend oder gabeln sich. Beheben Sie das mit einer Checkout-Konvention oder, besser, mit einem einzigen maßgeblichen, lebenden Exemplar: siehe /features/version-control.
Eine Überprüfung, die keine Spur hinterlässt, wenn sich nichts geändert hat
Ein Dokument, das überprüft und weiterhin als korrekt befunden wurde, ohne irgendwo einen Eintrag, ist ein Jahr später nicht von einem Dokument zu unterscheiden, das niemand überprüft hat. Geben Sie „keine Änderung nötig“ eine eigene datierte Zeile im Register, so wie der Nein-Zweig einer Entscheidungszeile immer noch ein benanntes Ergebnis erreicht.
Wenden Sie diese Praktiken auf Ihr eigenes Dokument an
Öffnen Sie das Beispiel zur Dokumentenversionskontrolle als eigenes Diagramm, und lassen Sie ein maßgebliches, lebendes Exemplar plus ein automatisches Änderungsprotokoll die Regeln dieser Seite für Sie übernehmen.
Verwandte Anleitungen
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.
