Dokumentationen: Unbeliebt und doch immens wichtig

Ich glaube, dieses Thema kennt jeder in der IT-Branche: das Dokumentieren von Informationen. Doch oftmals ist das Thema erst relevant, wenn es eigentlich schon zu spät ist.

Mit einem Schlag zehn Jahre Wissen verloren

Wir kennen alle das Szenario: Das Tagesgeschäft läuft, man löst Problem für Problem und bei Fragen kann man ganz einfach auf die langjährigen Kollegen zurückgreifen. Doch dann kommt der Tag X und plötzlich stellt sich heraus, dass der oder gar die Kollegen das Unternehmen verlassen werden.

Es bleiben oftmals nur noch wenige Wochen, um das bestehende Wissen irgendwie auf die anderen Kollegen zu transferien und am Ende sammeln sich dann, wenn überhaupt, halbgare Word- oder PDF-Dateien und ein paar Excellisten an, mit denen letztlich die wenigsten Zurückgelassenen wirklich etwas anfangen können. Mit einem Schlag sind dann schon mal zehn Jahre Wissen einfach weg, wie ich schon am eigenen Leib erleben musste.

Was wir wissen, ist ein Tropfen; was wir nicht wissen, ein Ozean .

Isaac Newton

Dieses Zitat von Issac Newton trifft den Nagel auf den Kopf. Mir wurde einmal gesagt: „Du musst nicht alles Wissen, du musst nur Wissen, wo du nachschauen musst.„. Auch diese Aussage finde ich sehr zutreffend. Dies und meine Berufserfahrung hat mich gelehrt, dass Dokumentation nicht nur ein lästiger Beigeschmack der regulären Arbeit ist, sondern eine Hilfe für jeden ist. Auch das Unternehmen profitiert von guten Dokumentationen, denn neue Mitarbeiter können auf diese Art und Weise wesentlich leichter in den Betrieb eingebunden werden.

Den „Ozean“ selbst im Griff haben!

Oft habe ich es jetzt schon am eigenen Leib erlebt, entweder wenn langjährigen Kollegen das Unternehmen verlassen oder wenn man selbst als Frischling in einem Unternehmen beginnt. Dokumentationen sind meist nie vorhandene Raritäten oder veraltet und schlecht bis gar nicht gepflegt.

Im Normallfall bringt, sofern ein Ticketsystem vorhanden ist, eben dieses auch eine Dokumentationsplattform mit. Inwieweit diese wirklich brauchbar ist, ist oftmals ein ganz eigenes Thema für sich. Die meisten bieten meiner Erfahrung nach entweder die Möglichkeit bestehende Dokumente im PDF, Word- oder Excel-Format hochzuladen oder den Text in vordefinierte Textfelder einzugeben. Bei einigen ist es sogar möglich, „Ablauffristen“ für die Dokumente bzw. Einträge zu definieren.

Doch oftmals stellt sich dann ebenso die Frage: Wer ist verantwortlich? Je nach Betriebsart und -größe kann das Thema Dokumentation auch ein Vollzeitjob werden. Dem steht jedoch genauso der Kosten-Nutzen-Faktor gegenüber. Aber wie sagt man so schön?

Hinterher ist man immer schlauer.

Dokumentieren mit einfachen Mitteln

Unabhängig von Art und Größe des Unternehmen spielt bei soetwas auch der Kostenfaktor eine Rolle: Dabei gibt es durchaus ganz brauchbare Alternativen, die sogar fast kostenneutral daherkommen. Das Einzige, was man benötigt, ist ein „Web-Server“. Ob das eine virtuelle Maschine oder ein bestehender Webspace ist, ist dabei nebensächtlich. Selbst ein alter Rechner mit XAMPP kann als Grundlage dienen, ebenso wie eine NAS.

MediaWiki: die eigene Mini-Wikipedia

Dass ich persönlich ein Fan der MediaWiki-Software bin, der Grundlage von Wikipedia, ist kein Geheimnis. Aber warum eigentlich?

• Angenehme Arbeitsoberfläche
• Versionsverlauf – MediaWiki vergisst nichts
• Gleichzeitiges Bearbeiten = Bearbeitungskonflikt
• Erstellen von Vorlagen für einheitliche Strukturen
• Einfach erweiterbar dank einem riesen Repository
• HTML-nutzbar neben dem eigenen Wiki-Mark-Up
• Gemeinsam etwas erschaffen können – je nach Verwendungszweck
• Kostenfrei

Es gibt natürlich auch Alternativen zur MediaWiki-Software, wie zum Beispiel das „DokuWiki„, das meineserachtens jedoch recht unkomfortabel in der Handhabung ist.

CMS-Systeme: WordPress, Joomla usw.

Ja, auch mit einem CMS-System wie WordPress kann man eine Dokumentationsdatenbank aufbauen. Das kann je nach Anforderung und Situation durchaus eine interessante Möglichkeit sein. Ob das natürlich empfehlenswert ist, hängt wirklich vom jeweiligen Einsatz ab. Vielleicht möchte man ja auch noch eine interne „News“-Plattform schaffen oder einen anderen Mehrwert für die Mitarbeiter bieten.

Warum es gerne ein Wiki sein darf

Nach mehr als acht Jahren in der IT-Branche mit vorwiegender Support-Erfahrung hat mich keine Dokumentationsplattform mehr begeistern können als die MediaWiki-Software.

Vorlagen können jederzeit selbst erstellt und dem Bedarf angepasst werden. Gleichzeitge Bearbeitung von Beiträgen ist möglich, mit dem Hinweis auf einen Bearbeitungskonflikt, sodass Informationen nicht blind überschrieben bzw. verworfen werden. Flexibel den Anforderungen entsprechend erweiterbar. Inhalte können diskutiert werden und Änderungen sind in den Versionen/History nachvollziehbar.

MediaWiki: Meine Erfahrungen in Unternehmen

Das erste Mal habe ich ein Wiki als Dokumentationsplattform implementiert, als man sich die Frage stellte, in welchem Format man neben dem internen IT-Informationsblog auch Anleitungen für die Anwender einfach und schnell zur Verfügung stellen könnte. Dank MediaWiki verlief das Ganze einfach und intuitiv und konnte charmant in dem Blog-Layout zur Verfügung gestellt werden. Eine Schulung meiner Kollegen durfte natürlich nicht fehlen.

Meine zweite Erfahrung mit einem Wiki in einem Unternehmen lies ein wenig auf sich warten. Bei der Suche nach Dokumentationen über eine bestimmte Inbetriebnahme mit entsprechenden Benutzern und Passwörtern, verwies mich ein Kollege neben einer Ordnerablage auf dem zentralen Server auf eine Installation von DokuWiki. Schnell stellte sich jedoch heraus, dass das Wiki schon lange nicht mehr gepflegt wurde und eigentlich keiner eine Ahnung hatte, wie das DokuWiki eigentlich funktioniert und welche Möglichkeiten es bietet.

Ich stellte das DokuWiki eigenmächtig auf MediaWiki um, erstellt Vorlagen und übernahm die bestehenden Beiträge. Zudem schulte ich meine Kollegen im Umgang.

In meiner letzten Anstellung als Field Service Engineer sah ich mich zu Beginn überfüllten Lagerflächen gegenüber und hatte als Dokumentation gerade mal zwei Excellisten zur Hand. Ich bastelte mir aus defekten Geräten einen funktionierenden PC zusammen und installierte neben Windows noch XAMPP und darauf die MediaWiki-Software. Ich nutzte das System nicht nur zur Dokumentation von Problemen und den Anleitungen zur Lösung dieser, sondern auch als Inventarverwaltung und Dokumentation von Softwarezugriffen.

Das Ganze kam so gut an, dass ich die gleiche Struktur für einen weiteren Standort umgesetzt habe und so meinen dortigen Kollegen ebenso die tägliche Arbeit erleichtern konnte. Auch hier durfte eine kurze Schulung natürlich nicht fehlen.

Für mich ist Dokumentation mittlerweile zur Leidenschaft geworden. Ein gutes Tool erhöht natürlich meine Motivation.