Preparate il vostro cuscino preferito, perché è giunto il momento di parlare di un argomento che piace a tutti, ma è anche il più noioso: la documentazione. Credeteci o no, all'inizio dell'era di sviluppo del software, la documentazione era un vero e proprio prodotto di rilievo.
La documentazione era (e in alcuni settori lo è ancora) una professione a sé stante. Qual è il suo scopo oggi? Ovviamente, facilitare ai sviluppatori la comprensione del funzionamento dell'applicazione, prima di modificarla, senza dover trascorrere settimane a ingegneria inversa del codice.
Sono molto diretto per risparmiare il vostro tempo. Non c'è davvero bisogno di avere documentazioni dettagliate. Se state utilizzando framework standard, questi sono già documentati da chi li mantiene, e questo da solo vi porta lontano. In secondo luogo, nessuno lo leggerà. Mi dispiace, ma non lo faranno.
Quindi è molto meglio concentrarsi sulla documentazione delle parti del codice che sono complesse, contengono logica aziendale pesante e svolgono una funzione importante nell'applicazione.
Un documento di 3-5 pagine che descrive la funzionalità in modo generale, con dettagli sui vari stati o su cosa potrebbe essere — sarà letto perché è comprensivo e facile da capire rapidamente.
Tutta la documentazione deve essere mantenuta, quindi una volta che avete codificato una logica complessa per una funzionalità, è una buona idea scaricare tutto il più importante. Vi ringrazierete più tardi.
Leggete di più in "Il Playbook del CTO" disponibile su Amazon/Kindle.
Aiutiamo le aziende con la loro tecnologia, fornendo servizi di CTO e gestione del prodotto. Fiduciari per i nostri servizi di CTO, lavoriamo con startup e aziende consolidate nei paesi nordici, in Svizzera e negli Stati Uniti.
Siamo una società svizzera (LLC) con sede in 
Svizzera.