Dokumentera det som är viktigt

Hög med böcker

Dokumentation bör inte bli gammal.

Vi producerade tidigare mängder med systemdokumentation, som beskrev varje delsystem i detalj. Produktionen skedde motvilligt och var alltid en nedprioriterad uppgift, eftersom det bara var en textmassa som skulle levereras till någon diffus lagring enligt avtal. Efter bara några månader var dokumentationen inaktuell och behövde uppdateras igen. Det här stal energi och tid, som hade varit bättre använd till att producera bättre kod.

När vi äntligen tog mod till oss och ställde ett antal kontrollfrågor, visade det sig att ingen egentligen läste dokumentationen! Det enda syftet var att säkerställa att man hade någon dokumentation som kunde hjälpa en extern utvecklare förstå hur Systemet var uppbyggt; någon sådan extern utvecklare fanns inte, och skulle heller inte finnas.

Dokumentationskravet togs därefter bort. Istället funderade Teamet igenom vilken dokumentation som de behövde, och kom fram till att en systemskiss räckte, tillsammans med en instruktionsbok för hur man ska installera utvecklingsmiljön och logga in på och hantera utvecklings- och testservrar (kallas även för ”bibeln” inom Teamet).

Dessa dokument är de som utvecklarna behöver, och de underhålls därför kontinuerligt, utan påminnelser. Nu faller det sig naturligt för alla i Teamet att uppdatera dessa dokument så snart nya rutiner tillkommer eller gamla förändras.


Det är en vanlig missuppfattning att Scrum och andra agila metoder innebär att dokumentation inte behövs. Det är givetvis inte sant; i det agila manifestet står det att man bör prioritera fungerande mjukvara *framför* dokumentation, men det innebär inte att dokumentation är oviktigt. Men: det innebär att man inte ska producera dokumentation i onödan, och också att den dokumentation som skrivs ska vara till nytta.

Annonser