Dokumentation

På rätt nivå vid rätt tillfälle

Ta fram din favoritkudde eftersom det är dags för en diskussion om det mest tråkiga ämnet för alla – dokumentation. Tro det eller ej, i början av utvecklingstiden var detta ett verkligt och viktigt leveransobjekt.

Dokumentation var (och är fortfarande i vissa branscher) ett separat yrke. Vad är syftet idag? Naturligtvis för att göra det lättare för utvecklare att förstå hur applikationen fungerar innan de ändrar den, utan att behöva spendera veckor på att bakåtkonstruera kod.

Jag ska vara extremt rakt på sak för att spara din tid. Det finns verkligen inte längre något behov av detaljerad dokumentation. Om du använder standardramverk, är dessa redan dokumenterade av den som underhåller dem, och det räcker långt. För det andra, ingen kommer att läsa det. Tyvärr, de kommer inte att göra det.

Det är därför mycket bättre att fokusera på att dokumentera delar av koden som är komplexa, innehåller tung affärslogik och som utför någon viktig funktion i din applikation.

Ett dokument på 3-5 sidor som beskriver funktionaliteten på ett övergripande sätt, med detaljer om statuser eller vad den kan vara – kommer att läsas eftersom den är omfattande och lätt att snabbt förstå.

All dokumentation behöver underhållas, så när du är klar med att koda någon komplex logik för en funktion, är det en bra idé att skriva ner de viktigaste sakerna om den. Du kommer att tacka dig själv senare.

Läs mer i "The CTO Playbook" som finns tillgänglig på Amazon/Kindle.