Schrijven van documentatie

Elke beheerder moet er zo nu en dan mee aan de slag, documentatie. Veel collega’s bestempelen het als noodzakelijk kwaad, onnodig of zelfs tijdrovend. Maar hoe digitaal we anno 2016 ook leven het is en blijft een van de belangrijkste taken voor systeembeheerders. Maar wordt te vaak vergeten of verkeerd aangepakt.

Vaak zien we dat beheerders binnen een organisatie gestuurd en geleefd worden door de hectiek van de dag. Hierdoor schiet het er vaak bij in om alles netjes op papier te zetten. Maar wanneer heb je er dan tijd voor? Waarschijnlijk als de vakantie periode is aangebroken.  Echter is de kans vrij groot dat je dan alle kleine (maar zeer belangrijke) details allang vergeten bent. Waardoor het schrijven van documentatie juist veel meer tijd dan nodig kost.

De beste documentatie maak je direct tijdens het inrichten en configureren, zodat je alle kleine details direct op papier kunt zetten. Hierdoor zal je ze nooit meer vergeten en alle belangrijke zaken staan direct op papier.
Door het direct op te schrijven kun je ook gemakkelijker je werkzaamheden reproduceren mocht je tijdens een implementatie tegen problemen aanlopen.

Maar dan, wat doe je met deze documentatie? Als we kijken naar systeembeheerders die geleefd worden door de hectiek van de dag, wat kan hier dan een oorzaak van zijn?

Uiteraard kan deze systeembeheerder werken in een omgeving die op omvallen staat waardoor hij constant pleisters aan het plakken is. Maar laten we daar in deze blog niet van uit gaan. Echter is dit wel een heel mooi punt om alle zwakke punten van de omgeving in kaart te brengen en te documenteren zodat je tijdens het ontwerpen van een nieuwe omgeving hier rekening mee kan houden, je hebt het immers op papier staan.

Tips voor het schrijven van documentatie

Maar wellicht deelt de beheerder zijn informatie en kennis over de omgeving niet met zijn collega’s zodat hij telkens alle problemen mag oplossen omdat er geen documentatie is en de omgeving hierdoor niet overgedragen is aan zijn collega’s…  Maar denk ook aan de eindgebruikers, als je hun in staat kan stellen om zelf kleine incidenten op te lossen, creëer je meer rust om je werkzaamheden gedegen uit te voeren inclusief het schrijven van documentatie. Want naast het opstellen van documentatie zal deze bij elke aanpassing bijgewerkt moeten worden. Doe dit dan ook zorgvuldig want anders kan een klein incident met onjuiste documentatie leiden tot een groot probleem. Tot slot nog een aantal tips voor het schrijven van documentatie.

• Teken indien mogelijk het deel wat je beschrijft uit in programma’s zoals Visio, technische tekeningen geven een helder beeld van wat je beschrijft.
• Gebruik 1 term als er meerdere synoniemen bestaan voor hetzelfde woord zo blijft je document leesbaar en overzichtelijk.
• Denk goed na voor wie je de documentatie schrijft, een eindgebruiker heeft niets aan een diep technisch document maar veel meer aan een stap-voor-stap handleiding. Verplaats je zoveel mogelijk in je doelgroep zodat je de documentatie hiervoor op maat kunt schrijven.
• Indien je technische termen gebruikt, vermeld deze in een verklarende woordenlijst achter in je documentatie, je zult zien dat je deze lijst vaak kunt hergebruiken.
• Vermeld altijd een stukje informatie over het document wat je schrijft. Hierin kun je bijvoorbeeld de datum en versie nummer van het document in zetten. Maar ook wijzigingen nadat je delen uit de documentatie hebt aangepast door vernieuwingen.
• Laat je documentatie kritisch doorlezen en verbeteren door een collega! Zo weet je altijd dat je documentatie leesbaar maar bovenal bruikbaar is. Vermeld wel je collega als reviewer in je document!
• Verwerk bovenstaande tips in een eigen template, zodat je altijd snel en eenvoudig je documentatie kunt maken. Door het gebruiken van een template vergeet je minder snel belangrijke aspecten en heb je een leidraad voor het snel en adequate schrijven van documentatie.