Quanto è importante la documentazione in ambito progettazione software?

Ecco un estratto dal Accelerate State of DevOps 2021.

Quest’anno abbiamo esaminato la qualità della documentazione interna, ovvero la documentazione (manuali, file README e anche commenti nel codice) per i servizi e le applicazioni su cui lavora il team.

Abbiamo misurato la qualità della documentazione in base al grado in cui questa:

• aiuta i lettori a raggiungere i propri obiettivi
• è accurata, aggiornata ed esauriente
• è ricercabile, ben organizzata e chiara

Abbiamo riscontrato che la qualità della documentazione è un fattore che determina il successo dei team nell’implementazione delle pratiche tecniche.

Queste a loro volta determinano il miglioramento delle capacità tecniche del sistema, tra cui osservabilità, test continuo e automazione del deployment.

Abbiamo rilevato che i team con una documentazione di qualità hanno una probabilità:

• 3,8 volte maggiore di implementare pratiche di sicurezza
• 2,4 volte maggiore di raggiungere o superare gli obiettivi di affidabilità
• 3,5 volte maggiore di implementare le pratiche di Site Reliability Engineering (SRE)
• 2,5 volte maggiore di sfruttare appieno i vantaggi del cloud

Azioni

Qual è il tuo processo di documentazione quando inizi lo sviluppo di una nuova parte di funzionalità?

Sharing is caring

Se conosci qualcuno che potrebbe trovare utile ricevere e-mail per migliorare l’organizzazione dei team di sviluppo software, DevOps e software engineering in generale inoltragli questo post! Qui può iscriversi e cominciare a ricevere subito!