Dokumentation – strunt samma?

Ingen utvecklare gillar att dokumentera. Ingen jag känner i alla fall. Nånstans är det baksidan av en annars positiv skapandeprocess – ett nödvändigt ont helt enkelt. Samtidigt så är jag helt övertygad om att när man bygger komplexa, produktionskritiska system med många användare så är dokumentation A och O. Ålrajt, några basic argument för dokumentationens vara:

1. Omvärlden förändras. Förmodligen måste det mästerverk man skapat nån gång ändras, utvecklas eller byggas om. Två scenarior är uppenbara. Ett: du är kvar på företaget. Problemet är då att man glömmer sin kod och sina tankar ganska fort – redan efter ett par veckor tittar man på sin kod och funderar “hur tänkte jag här?”. Bra och enkel dokumentation hjälper dig garanterat! Scenario två: – du har lämnat företaget. Har du nån gång försökt sätta dig in i någon annans kod? Det kanske funkar för enkla applikationer, men ganska snart blir det oöverskådligt och det tar onödigt lång tid att hitta det som eftersöks.

2. Kraven är en del av dokumentationen! Om man inte har dokumenterat kraven är chansen stor att man missar saker som beställaren och användarna av systemet förväntar sig. Och vi vet alla hur lång tid det tar (och hur tråkigt det är) att koda om. Och, det allra finaste – när du har dina krav, då kan man skriva testfall och därmed testkod. Gör det INNAN du börjar koda. Tro mig – här finns det tid att tjäna.

3. Med bra dokumentation bygger man (mer) rätt från början. När man kodat ett tag, oavsett språk, så inser man att själva kodningen är en ganska liten del av utvecklingsprocessen. Det svåra är oftast att uppfylla alla krav och få till en bra design som är lätt, smidig, skalbar och ombyggbar. Dessutom missar man ofta uppenbara saker som man förmodligen skulle ha hittat om man låtit designen tagit tid. Så, se till att dokumentera din design. Inte dokumentera för dokumentationens skull – men gör det enkelt, låt det ta tid, och inse att det är för din egen skull.

Well, efter att ha tillbringat mitt första dygn i Växjö för att dokumentera andras kod och protokoll inser jag hur tråkigt det är, särskilt när man gör det i efterhand. Men ack så nödvändigt.

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.