IT Dokumentation und deren Management

worel

Well-Known Member
Hallo!

Nachdem wir alle aus der IT kommen, weiß evtl. jemand etwas darüber zu berichten.
Wir stehen vor der großen Aufgabe, unsere Dokumentationen zu allen möglichen Systemen, Verfahren etc. zu konsolidieren. Jetzt ist die Frage, ob es dafür Toolseitig Unterstützung gibt. Also ein zentrales Management über IT Dokumentationen.

Es passiert immer dasselbe:
irgendjemand schreibt ein neues Dokument, das ist dann gerade ein paar Wochen aktuell und wird dann links liegen gelassen. Unzählige Beispiele gibt es dazu!
Immer wieder geschiehts dass für jeden Schmarrn ein Dokument aufgerissen wird. Das wird dann nicht wirklich richtig eingeordnet, niemand findets mehr. Die Info ist maximal für den Verfasser brauchbar. So soll es eben nicht sein!

Wie macht ihr das im größeren Umfeld? Itil uä.?
 
Das Problem existiert auch an meinem Aktuellen Arbeitsplatz. Jetzt wird, zumindest in dieser Abteilung darauf umgeschwänkt flüchtige Dokumentation in einem Wiki zu machen. Größere Dokumente (normalerweise mit Word verfasst) landen in einem CVS. Wie gut die Leute damit klarkommen hängt dann von der Verzeichnisstruktur ab.

Ich gehe aber davon aus, dass das nur von dem Software entwickelnden Leuten genutzt werden wird. Damit jeder das Nutzt müsste im allseits verwendeten (und verhassten) Notes direkt ein komfortabler CVS-Browser integriert sein, der dann als Dokument-Archiv tituliert wird.

Wenn ich's mir aussuchen könnte, würde ich sagen, neue Dokumentation über CVS in docbook entwickeln. Andere Dokumente sind aber auch im CVS gut aufgehoben. Die Frage ist ob man den Leuten vermitteln kann, dass der Vorteil der Versionierung und der möglichkeit der gemeinsamen Arbeit an der Dokumentation die Vorteile des WYSIWYG überwiegen.
 
Mir gefällt der Ansatz einer Lotus Notes-Datenbank immer noch gut. Man muss die Leute nur hinreichend antreiben/zwingen, ihre Dokumentation dort rein zu schreiben und nicht auf irgendwelche Dateisysteme nach ihrer persönlichen Ordnung.

Wenn kein Notes vorhanden ist kann man als billige Alternative auch ein Wiki verwenden. Leider hat man dann aber wieder mit dem Nachteil zu kämpfen, dass viele nicht von ihrer Word-WYSIWYG-Bequemlichkeit abrücken wollen und keinen Wiki-Code zur Textauszeichnung schreiben wollen. Und Bilder in Wikis erst hochzuladen und dann selbst in die Artikel einzubinden ist meist auch zu kompliziert.

Meine Präferenzliste daher (bevorzugtes oben):
- zentrale Notes-DB
- internes Wiki
- Word/Excel/etc.-Dateien auf irgendwelchen SMB-Shares

Nach Möglichkeit sollte man eine Vorschrift erstellen, dass nur genau eine Möglichkeit genutzt werden darf. Das ist imho wichtiger, als die Form, in der die Doku erstellt und abgelegt wird.
 
Wir machen sowas in Atlassian Confluenz ( http://www.atlassian.com/software/confluence/ ). Das Ding integriert sich über Shar Points in MS Office, wodurch die Endanwender ihre bekannte Office-Software weiternutzen können. Wem Word nicht liegt, kann direkt bearbeiten (im Browser) oder seinen bevorzugten Editor verwenden. Wenn die Doku einmal eingestellt ist, steht sie für immer zur Verfügung, die integrierte Versionierung sorgt dafür, dass man jeder Zeit auf alte Revisionen zurückkommt. Das klingt nun recht hochtrabend, aber im Prinzip ist das nichts weiter als ein gepimptes Wiki. In der Praxis scheitert auch hier wieder viel an der Faulheit der Nutzer, dass sie einfach nicht einstellen oder Chaos produzieren.
 
Hi

Es gibt Open Source DMSes, leider alles ausschliesslich Web basierend was meinen anforderungen nicht gerecht wird.

Gruss
bsdagent
 
Ich kann nur so viel sagen: "Dokumentation lügt!"

Ein ganz bekannter und zutreffender Spruch. Selbst Kommentare im Sourcecode können von heute auf morgen falsch sein, weil jemand was geändert hat und die Kommentarzeile darüber nicht angepasst hat.

Dokumentation wird bei uns in einem DMS abgelegt. Und wenn eine Software von AMS (Application Management Service, eine Abteilung) released werden soll (die Entwickler releasen nie etwas selber), fragt AMS immer nach ob auch die Doku nachgepflegt wurde. Eigentlich müssen wir sogar dokumentieren, wie und was wir dokumentiert haben. "Ohne Weg, kein Ziel!". Wenn da AMS drauf pocht, und man das nicht gemacht hat, steht man im Regen.

Es muß also mehrere Instanzen geben, und jemand der ganz frech auch mal ein Release nicht freigibt, weil die Doku nicht aktuell ist.

So wird bei uns verfahren. Nur zu dumm, das manchmal die Entwickler auch AMS sind... also eine Doppelrolle inne haben. ;) Aber das ist ein anderes Thema. :D
 
Zuletzt bearbeitet:
Bei einem guten DMS kannst du auch die Gültigkeitsdauer eines Dokuments festlegen und es dann automatisch invalidieren bzw. zur überarbeitung dem Verantwortlichen ins Postfach legen lassen.
 
Zurück
Oben