Things done wrong: Dokumentation

Homer Simpson
Nachdem ich letztens in einem Meeting den Hattrick im “Salz in die Wunde” streuen geschafft habe, als ich auf die Frage ab wann ein System als produktiv gilt geantwortet habe: “Sobald es dokumentiert ist, gesichert und überwacht wird”, wollte ich mich diesmal dem Thema Dokumentation annehmen. Eigentlich ein simples Thema (das für mich zu jedem Projekt dazugehört) kann hier doch viel schief laufen.
Der Inhalt ist meist die einfachste Hürde. Hier hilft es sich im Vorfeld einfach über Zielgruppe und Ziel einig zu sein. Der Unterschied beispielsweise zwischen Installationsdokumentation für den Administrator oder Betriebshandbuch für die Hotline ist doch relativ groß. Bei der Installationsdokumentation sammelte ich üblicherweise nur die ausgeführten Befehle in Themenblöcken und erkläre nur grob warum und wieso, da grundsätzliche Kenntnisse der Funktion vom Linuxadministrator erwarte. Ein Betriebshandbuch ist dagegen ein ganz andere Sache, notfalls fange ich sogar mit Erklärungen an was den Linux überhaupt so ist und sammle Screenshots zu den wichtigsten graphischen Funktionen. Was ich auf alle Fälle allerdings vermeide ist es frei verfügbare Dokumentation unnötig zu duplizieren. Die meisten “Open Source”-Projekte liefern auch hier sehr gute Arbeit ab und halten diese auch aktuell, was oftmals bei eigener Dokumentation nicht der Fall ist oder zumindest zusätzlichen Aufwand bedeutet. Warum dies meist so ist, soll das Hauptthema dieses Blogposts sein.
(mehr …)

Dirk Götz
Dirk Götz
Senior Consultant

Dirk ist Red Hat Spezialist und arbeitet bei NETWAYS im Bereich Consulting für Icinga, Puppet, Ansible, Foreman und andere Systems-Management-Lösungen. Früher war er bei einem Träger der gesetzlichen Rentenversicherung als Senior Administrator beschäftigt und auch für die Ausbildung der Azubis verantwortlich wie nun bei NETWAYS.

TWiki lokal installieren

Neulich hatte ich ja schon mal einen Post geschrieben, dass Wikis eine sehr praktische Sache zum Ablegen von Texten oder Dokumentationen sind. Einen Nachteil haben sie aber in der Regel: Da es sich um eine Webanwendung handelt, braucht man auch einen Internetzugang um darauf zugreifen zu können. Eine Alternative wäre es, dass Wiki zusammen mit einen lokalen Webserver zu installieren und dann einfach via http://localhost darauf zuzugreifen. Auch dafür empfiehlt sich TWiki, da es im Gegensatz zu MediaWiki keinen zusätzlichen SQL Server braucht. Praktisch, dass es auf der TWiki Download Page auch Pakete für Windows oder Mac OS X gibt.

Julian Hein
Julian Hein
Executive Chairman

Julian ist Gründer und Eigentümer der NETWAYS Gruppe und kümmert sich um die strategische Ausrichtung des Unternehmens. Neben seinem technischen und betriebswirtschaftlichen Background ist Julian häufig auch kreativer Kopf und Namensgeber, beispielsweise auch für Icinga. Darüber hinaus ist er als CPO (Chief Plugin Officer) auch für die konzernweite Pluginstrategie verantwortlich und stösst regelmässig auf technische Herausforderungen, die sonst noch kein Mensch zuvor gesehen hat.

Welches Wikisystem für das Intranet?

In dem Blogartikel Einfachere Dokumentation durch Wikis vor ein paar Tagen hatte ich geschrieben, dass sich ein Wikisystem sehr gut für die Ablage von IT Dokumentation eignet und welche Vorteile ein solches Wikisystem dafür bietet. Heute geht es darum welches System am besten geeignet ist:
Das bekannteste ist sicher MediaWiki, denn es kommt bei der Wikipedia zum Einsatz. Jetzt könnte man folgern, dass es damit auch für den internen Einsatz prädestiniert ist. Das ist aber nicht der Fall, denn MediaWiki wurde ganz speziell für die Wikipedia und deren Bedürfnisse entwickelt. Es ist vor allem auf eine sehr große Anzahl von Artikeln, Redakteuren und Leser optimiert und es liegt ein großer Fokus auf dem Schutz vor Vandalismus. Diese Features und ein rein auf Lexikonartikel optimiertes System werden aber in einem Firmenintranet nicht wirklich benötigt. Auf der anderen Seite fehlen in MediaWiki aber wichtige Collaboration Funktionen wie geschützte Bereiche, Ablage von Binärdateien oder Workflows.
Wesentlich besser geeignet sind TWiki oder Dokuwiki. Beide haben Features, die viel besser zur Ablage von Dokumentationen passen. Neben den normalen Grundfunktionen jeden Wikis, sind das vor allem eine wesentlich bessere Unterstützung für hierarchische Inhalte, Kategorien und Order. Die Inhalte lassen sich in diesen beiden Systemen einfach wesentlich besser strukturieren. Zugriffsregelungen erlauben es Teilbereiche des Wikis nur für bestimmte User freizugeben, so dass Arbeitsgruppen oder Abteilungen ihre eigenen, geschützten Bereiche einrichten können. Und zuletzt verfügen beide über einen Plugin Mechanismus, mit dem sich die Funktionen der beiden Wikis noch wesentlich erweitern lassen. Selbst kleinere Webanwendungen wie ein Ticket- oder ein Inventarsystem lassen sich so innerhalb des Wikis einfach nachrüsten.
Fazit: MediaWiki ist zwar das bekanntere System, es ist aber für ein online Lexikon optimiert. Dokuwiki und TWiki sind wesentlich besser für den Einsatz in einem Intranet geeignet, denn sie bieten viel weitergehende Funktionen.

Julian Hein
Julian Hein
Executive Chairman

Julian ist Gründer und Eigentümer der NETWAYS Gruppe und kümmert sich um die strategische Ausrichtung des Unternehmens. Neben seinem technischen und betriebswirtschaftlichen Background ist Julian häufig auch kreativer Kopf und Namensgeber, beispielsweise auch für Icinga. Darüber hinaus ist er als CPO (Chief Plugin Officer) auch für die konzernweite Pluginstrategie verantwortlich und stösst regelmässig auf technische Herausforderungen, die sonst noch kein Mensch zuvor gesehen hat.

Einfachere Dokumentation durch Wikis

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.

Julian Hein
Julian Hein
Executive Chairman

Julian ist Gründer und Eigentümer der NETWAYS Gruppe und kümmert sich um die strategische Ausrichtung des Unternehmens. Neben seinem technischen und betriebswirtschaftlichen Background ist Julian häufig auch kreativer Kopf und Namensgeber, beispielsweise auch für Icinga. Darüber hinaus ist er als CPO (Chief Plugin Officer) auch für die konzernweite Pluginstrategie verantwortlich und stösst regelmässig auf technische Herausforderungen, die sonst noch kein Mensch zuvor gesehen hat.