Dokumentation

På det rigtige niveau i det rigtige øjeblik

Tag din yndlingspude frem, for det er tid til en snak om alle tiders kedeligste emne – dokumentation. Tro det eller ej, i starten af udviklingstiden var dette en sand og vigtig leverance.

Dokumentation var (og er stadig i nogle brancher) et separat erhverv. Hvad er formålet i dag? Selvfølgelig for at gøre det lettere for udviklere at forstå, hvordan applikationen virker, før de ændrer den, uden at skulle bruge uger på at omvendt ingeniørarbejde.

Jeg skal være helt ærlig for at spare din tid. Der er virkelig ikke længere brug for detaljeret dokumentation. Hvis du bruger standardrammer, er disse allerede dokumenteret af dem, der vedligeholder dem, og det tager dig langt. For det andet vil ingen læse det. Desværre, de vil ikke.

Det er derfor en meget bedre idé at fokusere på at dokumentere de dele af koden, der er komplekse, indeholder tung forretningslogik og udfører en vigtig funktion i din applikation.

Et dokument på 3-5 sider, der beskriver funktionen på et højt niveau, med detaljer om statuser eller hvad det kan være – vil blive læst, fordi det er omfattende og let at fange hurtigt.

Alle dokumentationer skal vedligeholdes, så når du er færdig med at kode nogle komplekse logikker til en funktion, er det en god idé at tømme hovedet for de vigtigste ting om det. Du vil takke dig selv senere.

Læs mere i "CTO Playbook" tilgængelig på Amazon/Kindle.