Wie man Transparenz der Dokumenten-Ablage garantiert
Vor allem in Software-Projekten ist immer wieder zu beobachten, dass etwas schief lief, nur weil Team-Mitglieder ein exististierendes Dokument nicht kannten (oder ihrer Arbeit eine schon überholte Version zugrunde gelegt haben).Vor allem Tester suchen meist gar nicht erst nach aller für sie relevanten Dokumentation, da sie nur schwer zu finden ist und der Tester nicht weiß, was wirklich an Spezifikationen existiert. Das kann fatal sein, reduziert aber mindestens ganz deutlich den Wert seiner Arbeit.
Dem entgegenzuwirken bedarf es einer strikt einzuhaltenden Konvention für
- Namensgebung im Filesystem (der Dokumentenablage) und
- klarer Unterscheidung zwischen aktuellen und nicht mehr aktuellen Versionen der Dokumente.
dass für jedes Dokument D der Ablageordner V Subverzeichnisse old und draft kennt, für die gefordert sei:
- die aktuelle Version des Dokuments (die gegenwärtige Default-Version) liegt in V,
- sämtliche älteren Version liegen in V/old,
- sofern an einem Nachfolger der Default-Version gearbeitet wird, muss der in V/draft zu finden sein.
Die File ID aller Dokumente habe die Form
wo stets YYYY-MM-DD den Tag nennt, an dem die entsprechende Datei zur Default-Version erklärt wurde.
Für Dokumente mit Zeitbezug — Besprechungsprotokolle, Reports — muss die Teilprojekt ID mit der Silbe ZB_ beginnen. Eine Versionsnummer sollte dann nicht vorhanden sein (um hiermit auszudrücken, dass Vorgängerversionen der Default-Version nicht aufbewahrt werden).
Für alle anderen Dokumente — Verträge, Vertragsbestandteile, technische Spezifikationen — muss ein Versionsbezeichner _Vm.n[.u] existieren, und in diesem Fall gilt:
- Für jede unmittelbar auf ein Review folgende Version wird m hochgezählt und n auf Null gesetzt.
- Wenn der Zusatz .u steht, hat er den jeweils letzten Bearbeiter des Dokuments zu identifizieren.
Ein zusätzlicher Vorteil:
Die strikte Einhaltung oben beschriebener Konventionen garantiert auch, dass man — z.B. jede Nacht neu — automatisch alle noch aktuelle Dokumentation auffinden, nach HTML transformieren und so online und durch viele automatisch erzeugbare Hyperlinks verbunden über ein projekteigenes Info-Portal zur Verfügung stellen kann. Derart aufbereitete Präsentation aller Dokumente wird wesentlich häufiger konsultiert und ist deswegen wertvoller als solche, die aufzufinden man Dateien suchen und öffnen muss.
Ein kleines Beispiel hierfür — das Resultat der Entwurfsphase im Projekt WissDB — kann man sich hier ansehen.
stw5308DTD — Dokument . Transparenz . Default — News?
Mehr + B G E + S H A + More