Oplever Block

Op het moment dat jij klaar bent met de ontwikkeling van een product, begint het voor degene die ermee moet gaan werken eigenlijk pas echt.

Omdat je in een professionele omgeving niet de enige bent die verantwoordelijk is voor een product, en het zelfs mogelijk is dat jij helemaal niet meer betrokken bent bij het vervolgtraject moet je er tijdens het ontwikkelen al rekening mee houden dat anderen met je product gaan werken en anderen het zullen gaan onderhouden of doorontwikkelen.

Zorg daarom dat je netjes werkt zodat een ander je code makkelijk kan doorgronden, en maak gebruik van versiebeheer waarin de ontwikkeling goed te volgen is doordat je niet teveel aanpassingen doet per commit.
Documenteer niet alleen goed wat je doet in je code en versiebeheer, maar ook in een functioneel ontwerp.

Hierin beschrijf je de functionaliteiten die ontwikkeld moeten worden. Ook hierin is het belangrijk de dingen duidelijk te beschrijven. Hierdoor weet je zeker dat je maakt wat de opdrachtgever wil hebben, en is je product tegelijkertijd goed testbaar.

Als laatste help je de gebruiker op weg om met je product te werken door een gebruikershandleiding te maken, waarin hij stap voor stap uitleg kan vinden over de functionaliteiten.

Verzorging code
Functies en kritieke onderdelen in code (onderdelen die niet in één oogopslag te verklaren zijn) zijn voorzien van comments. Logische structuur in componenten van je project. Variabelen en functies hebben beschrijvende namen. Je bent je bewust van code conventies van de programmeertaal waarin je werkt.

Het is belangrijk om complexere stukken in je project te voorzien van annotaties. Dit omdat het dan voor jezelf maar nog veel belangrijker, voor anderen duidelijk is wat er gebeurt in het programma. Door je code van comments te voorzien kan je ook snel functies terug vinden en weet je precies wat deze doen. Variabelen en functies krijgen een naam die past bij de functie of het doel waar ze voor gebruikt worden. Code conventies hou ik ook rekening mee zoals in mijn code hieronder zichtbaar is. Zo schrijf ik classes met een hoofdletter en geef ik functies/variabelen een naam volgens lowerCamelCase. Niet alleen de code is netjes maar ook de mappenstructuur en bestandsnamen welke links te zien zijn worden netjes gestructureerd. (Klik op de afbeelding om deze volledig te bekijken.)

Versiebeheer
Je kan met een versiebeheersysteem samen aan een product werken, waarbij ieders inbreng gelijkwaardig is. Je kunt uitleggen hoe versiebeheer werkt, en waarom dit geschikter is voor samenwerken aan code dan bijv. Dropbox. Commits zijn klein en beschrijf je ook kort en bondig.

Versiebeheer is iets wat nieuw voor me was. Tijdens het project in CLE 3 heb ik hier mee leren werken ik moet zeggen dat het bevalt. Ik maak gebruik van Git in combinatie met GitHub en GitLab. Het ideale aan versiebeheer op deze manier is, is dat iedereen die werkt commits maakt met daarbij comments die beschrijven wat er veranderd/nieuw is. Dit wordt dan samengevoegd met de andere bestanden tot een nieuwe versie. Ook is het mogelijk om versies terug te gaan waardoor je een soort rollback kan doen als er iets mis is. Het voordeel tegenover een ‘domme’ dienst als Dropbox is, is dat er dus echt versies bijgehouden worden. Bij een clouddienst kan je wel samenwerken in een map maar je kan geen versies bijhouden en loggen wie wat gedaan heeft. (Klik op de afbeelding om deze volledig te bekijken.)

Overdracht
Je bent in staat acceptatiecriteria (definition of done, specificaties) zodanig op te stellen dat het product te bouwen is door iemand anders zonder verder overleg. Je bent in staat om een klantgerichte gebruikershandleiding op te leveren.

Voor het project in CLE 3 hebben we in teamverband gewerkt aan de User Stories en natuurlijk de DoD die daarbij hoort. Dit heb ik gedaan in een gedeeld document zodat iedereen bij de meest recente versie kan en deze kan afvinken. Ook is er een verdeling gemaakt in welke sprint we het willen afronden en een sizing die aangeeft hoe moeilijk een user story is naar verwachting. Een CLE eerder heb ik ook User Stories en DoD’s gemaakt. Door de uitgebreide backlog moet het mogelijk zijn voor externe partijen om mee te werken aan dit project en om het eventueel over te nemen

Hieronder is een gebruikershandleiding beschikbaar gemaakt voor de eigenaresse/opdrachtgeefster waar ik mee samen heb gewerkt in CLE2. Het document behandelt alle functionaliteiten van het reserveringssysteem.

Link naar de pdf: https://stud.hosted.hr.nl/0980417/wp-content/uploads/2019/09/Gebruikershandleiding-Schoonheidssalon-Laro.pdf
(De gebruikersnaam en wachtwoord in dit document zijn fictief.)