In vielen unserer Projekten entsteht immer wieder die Anforderung nach einem (neuen) Dokumentationssystem. Entweder weil der Kunde noch gar nichts in diesem Bereich einsetzt oder mit dem bestehenden System unzufrieden ist. Wir benutzen selbst ein Wiki und empfehlen das auch unseren Kunden. Aus mehreren Gründen:
- Dokumentation ist in der Regel eine sehr unbeliebte Aufgabe, die kein Administrator gerne erledigt. Folglich sollten die Einstiegshürden möglichst niedrig und die Dokumentation mit möglichst wenig Arbeit verbunden sein. Wikis sind webbasiert, einfach zu erreichen, leicht zu bedienen und damit einfach schneller als andere Systeme. Je schneller und einfacher es für einen Admin ist einen Change zu dokumentieren, umso höher ist die Wahrscheinlichkeit, dass es auch gemacht wird.
- Durch die flexible Struktur eines Wikis, können auch neue Bereich oder Themen einfach eingepflegt werden, ohne auf eine komplizierte Hierarchie Rücksicht zu nehmen. Es ist immer noch besser der Inhalt ist drinnen, aber an der falschen Stelle, als gar nicht eingepflegt. Die Inhalte können immer noch später umsortiert werden.
- Im Gegensatz zu anderen Alternative ist eine Suchfunktion bereits out-of-the-box eingebaut und muss nicht extra implementiert werden. Inhalte lassen sich so auch ohne absolute Ordnung leicht wiederfinden.
- Die meisten Wikisysteme gestatten die Anbindung externer Authentifizierungsmechanismen, so dass keine zusätzlichen Useraccounts oder Passwörter verwendet werden müssen. Im internen Netz kann die Anmeldung durch Kerberos vielleicht sogar komplett entfallen.
- Die Versionierung der Wikiartikel erlaubt es später Änderungen an der Dokumentation nachzuvollziehen oder einfach auf einen alten Stand zuzugreifen. Fehler und versehentliche Löschungen können so jederzeit einfach wieder rückgängig gemacht werden. Ebenso können Diffs erstellt werden, die genau alle Änderungen zwischen zwei Versionsständen wiedergeben.
- Da das System HTML basiert ist, lassen sich die Inhalte einfach über normale Hyperlinks in anderen Anwendungen verlinken. Beispielsweise kann man in Nagios Links direkt zur Dokumentation der jeweiligen Ressource einbauen.
- Die meisten Wikis sind Open Source und können deswegen einfach angepasst werden, wenn es später individuelle Zusatzanforderungen an das Wiki geben sollte. Ganz zu schweigen von den wegfallenden Lizenzkosten.
Natürlich sollte man nicht verschweigen, dass ein Wiki auch ein paar Nachteile mit sich bringt: In der Regel kann jeder alle Texte einsehen oder verändern und es ist schwierig in einem Wiki genaue und vor allem verbindliche Strukturen vorzugeben. Wobei das in einer offenen, wissensbasierten Firma nicht wirklich ein Nachteil sein muss.
In Summe überwiegen also definitiv die Vorteile eines Wikis und ich werde in ein paar Tagen die wichtigsten und bekanntesten Wiki Systeme vorstellen und ihre jeweiligen Vor- und Nachteile als Dokumentationssysteme erläutern.
0 Kommentare