Dokumentasjon

På rett nivå til rett tidspunkt

Ta frem din favorittpute, for nå er det tid for en diskusjon om noe alle synes er det mest kjedelige – dokumentasjon. Tro det eller ei, i begynnelsen av utviklingstiden var dette et reelt og viktig leveringsprodukt.

Dokumentasjon var (og er fortsatt i noen bransjer) et eget yrke. Hva er hensikten i dag? Selvfølgelig for å gjøre det lettere for utviklere å forstå hvordan applikasjonen fungerer, før de endrer den, og uten å måtte bruke uker på å reversere kode.

Jeg skal være ekstremt ærlig for å spare din tid. Det er virkelig ikke nødvendig med detaljert dokumentasjon lenger. Hvis du bruker standardrammeverk, er disse allerede dokumentert av dem som vedlikeholder dem, og det tar deg langt. For det andre, vil ingen lese den. Beklager, de vil ikke.

Det er derfor en mye bedre idé å fokusere på å dokumentere deler av koden som er komplekse, inneholder tung forretningslogikk og som utfører en viktig funksjon i din applikasjon.

Et dokument på 3-5 sider som beskriver funksjonaliteten i et overordnet perspektiv, med detaljer om statuser eller hva den kan være – vil bli lest fordi den er omfattende og lett å forstå raskt.

All dokumentasjon må vedlikeholdes, så når du er ferdig med å kode en kompleks logikk for en funksjon, er det en god idé å nedskrive de viktigste tingene om den. Du vil takke deg selv senere.

Les mer i "CTO Playbook" tilgjengelig på Amazon/Kindle.