Systeembeheer documentatie
Als beheerders ergens een broertje aan dood hebben, is het wel aan het schrijven en bijhouden van documentatie. De ervaring leert dat documentatie na de (verplichte) oplevering zelden wordt bijgehouden.
Dit komt meestal door twee redenen:
- De beheerders zien het nut van de documentatie niet in, want ze hebben er weinig profijt van;
- De documentatie is lastig aan te passen en het is ondankbaar werk.
Het is daarom zaak aan beide aspecten aandacht te besteden. Documentatie is voor beheerders handig als ze snel de informatie kunnen vinden die ze zoeken.
Zoeken
Een mooi voorbeeld is Google. In Google kun je een antwoord op een technische vraag meestal binnen 30 seconden vinden, door het ingeven van goede steekwoorden. Het opzoeken van informatie in documentatie op een netwerkschijf, met een meestal moeilijk te doorgronden directory tree, duurt veel langer. Dit frustreert gebruikers, zodat men het wiel liever opnieuw uitvindt dan dat men de documentatie raadpleegt.
Het aanpassen van documentatie begint ook met het zoeken naar de documentatie. Zoals hierboven beschreven, is dit de eerste hinderpaal. Bovendien is na het aanpassen van documentatie niet duidelijk wat er nu precies is veranderd en wie dat heeft gedaan. Om deze redenen wordt documentatie meestal helemaal niet bijgewerkt.
Wiki's
Moderne technieken kunnen deze problemen voor een groot deel oplossen. Het gebruik van Wiki’s met een zoekfunctie bijvoorbeeld, lost bovenstaande problemen op. Het succes van wiki’s is het best af te lezen aan de vrije tijd die vele mensen steken aan het vrijwillig documenteren op http://www.wikipedia.org
Murdoc
Ook mijn open source project Murdoc is een handig systeem om documentatie bereikbaar te maken. Het is zelfs mogelijk om systemen zichzelf automatisch dagelijks te laten documenteren.
Murdoc bevat ook een standaard directory indeling waarmee systeembeheer documenten kunnen worden gerangschikt.
This entry was posted on Maandag 16 Oktober 2006