Verhaal van een SI-ontwikkelaar
#10. Wat is documentatie in een SI-project?

In si-projecten moet je documenten aan de klant overleggen om aan te tonen dat het project goed is gemaakt.

Vanaf de offerte tot en met de schermbepaling, het ontwerp, de gebruikershandleiding, enz. zijn er documenten die tijdens de verschillende projectfasen moeten worden geschreven, van voorstellen tot ontwerp, ontwikkeling, testen, openen en vervolgens operationeel zijn. Dit wordt meestal gedaan door beginnende ontwikkelaars.

Tijdens het schrijven van documenten vraag je je af of je dit wilde doen als ontwikkelaar of als kantoorwerker. Bovendien is het in Zuid-Korea gebruikelijk om de documentatie voor elke fase vlak voor de voltooiing van het project te bundelen. Dit komt door de volgende redenen.

• De projectperiode is kort, dus je moet zo snel mogelijk ontwikkelen en de documentatie moet er goed uitzien om het project binnen de tijd te voltooien.
• Zelfs als je het in fasen doet, worden er toch vereisten toegevoegd en gewijzigd, dus het is sneller om het te maken en te corrigeren dan om het te maken en te corrigeren terwijl je het schrijft.

Ironisch genoeg is de volgorde verkeerd, maar het is een methode die in de Zuid-Koreaanse si-cultuur op natuurlijke wijze is geëvolueerd.

Er zijn veel tools voor het tekenen van schermbepalingen, maar je kunt ook de wonderlijke gebeurtenis zien van het maken van schermbepalingen door schermafbeeldingen van de voltooide operationele schermen te maken.

Over het algemeen vinden ontwikkelaars documentatie echt vreselijk, maar wat kun je doen, je bent een beginner.

De meest gemakkelijke beginnende medewerkers worden verantwoordelijk voor de documentatie. De reden is dat ze toch niet meteen kunnen ontwikkelen, dus ze schrijven documenten.

Het is tenslotte zo dat als je het zelf hebt gedaan, je het ook aan je opvolger kunt leren, dus als er een kans is, doe het dan goed.