Fondamentali (2): la documentazione
Il mio collega Diego continua a ripetermi quanto gli insegnava una sua docente:
Il lavoro [di un ricercatore, ma vale per qualsiasi lavoro] deve consistere nel 20% di attività concreta e nell’80% di documentazione di quanto si è fatto.
Sorrido di fronte a questa sproporzione, ammettendone l’importanza e la verità.
Mi rendo conto ogni giorno di quanto è importante tenere traccia di ogni passo che viene fatto, ogni scelta o decisione presa, ogni mattoncino aggiunto. Perché capita sempre il momento in cui occorre ricostruire, ripercorrere il sentiero all’indietro per andare a trovare qualcosa che si è perso lungo la strada, o quando ci si trova a dover riassumere, magari per una pubblicazione, un lavoro durato anni.
Questo non è solo importante per chi verrà dopo di noi e deve continuare il nostro percorso, o utile quando si deve spiegare ad altri il proprio lavoro. Spesso sono io il primo a voler capire bene il funzionamento di un sistema o di un processo, e non disporre di un prontuario, di un abc, di un manuale mi disorienta – anche quando sono io l’autore del sistema o del processo. Quando non ricordiamo un dettaglio, e naufraghiamo nel disordine della scrivania, lamentandoci: i manuali, dove sono i manuali???
Questo, naturalmente, è ancora più vero quando ci si scontra con aziende di software commerciali che non documentano il proprio lavoro, distribuiscono manuali scadenti e non aggiornati, e perdono traccia dell’evoluzione dei loro stessi programmi. Mi è capitato molte volte, al telefono, di sentire i tecnici dell’assistenza vacillare, sprovveduti quanto me su un sistema gestito da loro. Mi veniva voglia di chiedere: ma non avete un elenco delle operazioni svolte, delle modifiche effettuate, dell’evoluzione delle funzionalità del vostro software? In una parola, non avete della stramaledettissima documentazione???
Quando è possibile, è buona abitudine farseli da sé i manuali.
Questo blog, alla fine, era nato con questo scopo.

