Systeemdocumentatie
Systeemontwikkelaars zijn primair gericht op het ontwerpen of
aanpassen van software, maar hebben gewoonlijk een broertje dood
aan het documenteren van de gecreëerde of gewijzigde functionaliteit.
Het motief is vaak dat het (detail) functioneel ontwerp - indien
al aanwezig - zowel een afdoende beschrijving van de software
als een voldoende basis voor het systeembeheer vormt. Bij ziekte
of na vertrek van de systeemontwikkelaar in kwestie blijken veelal
pas de onjuistheid en de pijnlijke implicaties van deze opvatting.
Beheerdocumentatie
Systeembeheerders hebben over het algemeen hun handen vol aan het operationeel houden van alle door de gebruikers vereiste functionaliteit. Als gevolg hiervan blijven routines en configuratiegegevens die benodigd zijn voor de uitvoering van het beheer vaak tussen de oren zitten, en worden niet of onvoldoende vastgelegd. Ook in dit geval blijken de gevolgen hiervan pas bij afwezigheid van de systeembeheerder.
Het belang van technische documentatie
Om kostbare vertragingen in de productie als gevolg van stagnaties
in het onderhoud en beheer van systemen zo veel mogelijk te vermijden,
is het dan ook van groot belang dat de daartoe vereiste gegevens
en routines goed worden gedocumenteerd en regelmatig worden geactualiseerd.
Het is vaak zinvol om het opstellen of aanpassen van systeem-
en beheerdocumentatie in projectverband uit te voeren, zodat al
vooraf tijd voor deze activiteiten is ingepland.
Werkwijze MicroText
Voor het ontwikkelen en actualiseren van technische documentatie
is veel configuratie- en implementatiespecifieke kennis nodig.
Gewoonlijk kiezen organisaties er dan ook voor om zulke documenten
door de desbetreffende ontwikkelaars of beheerders te laten samenstellen.
Hierbij kan een beroep worden gedaan op de ondersteuningsservices
die MicroText op dit gebied levert. MicroText verzorgt in zulke
gevallen het projectmanagement, de ontwikkeling van de templates,
de ondersteuning van het schrijfproces, de redactie en de bewaking
van de consistentie en uniformiteit van de eindproducten.
Voor meer informatie neemt u contact op met
MicroText
Tenerifestraat 62
1060 TJ Amsterdam
Telefoon 020 - 693 09 01
Mobiel 06 22 66 17 62
Directeur/partner: Giesje Wouters
Directeur/partner: Flip Spiekerman
U kunt uw reactie per e-mail sturen naar microtext@xs4all.nl