Praktisches & Grundsätzliches zur Informatik

Transparente Dokumentenablage

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 zu­grunde 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

Das zweite Ziel zu erreichen werde gefordert,

dass für jedes Dokument D der Ablageordner V Subverzeichnisse old und draft kennt, für die gefordert sei:

Das erste Ziel zu erreichen sei gefordert:

Die File ID aller Dokumente habe die Form


YYYY-MM-DD_TaskID_DocTopic[_Vm.n[.u]]


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 Spezifikationenmuss ein Versionsbezeichner _Vm.n[.u] existieren, und in diesem Fall gilt:

Dass die File ID mit dem Datum YYYY-MM-DD beginnt ist wichtig, da nur so dir-Listings — und der File Explorer — so sortieren, wie es am hilfreichsten ist (neue Ergennisse nicht zu übersehen ist WICHTIG).


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 stel­len 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.
Wissenswertes zu "Transparente Dokumentenablage" zusammengestellt durch Gebhard Greiter.
tags: Dokument1gegreit Default1gegreit Dokumentenablage1gegreit