Ho trovato QUALUNQUE documentazione migliore di NESSUNA documentazione. La quantità appropriata è di solito determinata dalla quantità di tempo che dobbiamo fare o da quanto odiamo le telefonate e le e-mail di supporto.
Sembra che i membri del tuo team abbiano aspettative non realistiche sui loro ricordi, o si vergognino delle loro capacità di scrittura e non sono disposti a esercitarsi.
Mi rendo conto di essere in una minoranza (specialista inglese che ha studiato ingegneria del software nella scuola di specializzazione) qui, poiché non trovo la documentazione come un lavoro di routine. È uno strumento professionale prezioso. Potrei non trovare la scrittura così difficile da fare come alcuni dei miei colleghi, ma è soprattutto perché ho più pratica. Non considero un progetto finito a meno che non abbia documentazione, e di solito lo scrivo per motivi puramente egoistici: così posso dare alla gente qualcosa da leggere invece di prendere telefonate ed e-mail, o così posso ricordare di cosa stavamo parlando per ultimo mese o giù di lì, posso fare riferimento a come ho fatto qualcosa se ho bisogno di sostenerlo nel cuore della notte.
Il modo migliore per avvicinarsi alla documentazione è scriverlo COME SI VA, esattamente come scrivere codice di prova. È sorprendente come alcuni modelli pre-scritti (con intestazioni, matrici di codice, ecc.) Possano rendere la documentazione più semplice e veloce da eseguire. In questo modo è possibile acquisire il cambiamento in tempo reale e avere meno terreno da percorrere nel tempo. In questo modo sei più efficiente, poiché puoi fare riferimento alla documentazione di cui hai bisogno e cambiarla lungo il percorso. Farlo in un wiki, ad esempio, semplifica gli aggiornamenti e puoi evitare problemi con la versione del documento se l'ultimo e il più grande sono sempre online nello stesso posto e puoi semplicemente inviare collegamenti a persone che hanno bisogno di leggerlo.
Se trascorri un po 'di tempo a documentare, TUTTI lavorerai più velocemente, specialmente quando qualcuno nuovo si unisce al team, dal momento che non dovranno passare tutto quel tempo a capire tutto. Capire le cose è una parte divertente del nostro lavoro, ma non è divertente quando devi farlo in fretta per sistemare la produzione. Tutti risparmeremmo molto tempo se tutti scrivessimo un paio di note in più.
Il tuo team ha gli stessi problemi con i test o la scrittura del codice di test? In caso contrario, sarà una vendita più semplice.
La tua documentazione è utile in molti modi:
1) Per te, proprio ora e per i tuoi colleghi, mentre lavori al progetto.
2) Ai tuoi clienti. La documentazione (inclusi i diagrammi) che puoi mostrare agli utenti semplifica le discussioni durante le riunioni, soprattutto se stai discutendo di sistemi complicati. Anche se la documentazione è incompleta, è un punto di partenza.
3) Alle persone che erediteranno il tuo lavoro (che potresti anche essere tu, tra tre anni). Molti dei miei colleghi più giovani pensano che ricorderanno le cose per sempre. So che non lo ricorderò oltre questa settimana se non lo scrivo. Avere la documentazione ti evita di dover passare mezza giornata a ricordare come hai strutturato qualcosa e a doverlo capire di nuovo.
4) A te e agli altri, se la situazione diventa politica o controversa. Come qualcuno che prende appunti durante le riunioni, per tenermi sveglio e combattere la noia, sono stato spesso l'unico con la versione scritta di una decisione. La persona che l'ha scritto vince la disputa. Ricordalo la prossima volta che qualcuno dice "Ricordi quell'incontro che abbiamo avuto lo scorso inverno nella sala conferenze 4, quando stavamo andando oltre X? Fred era lì, e chi è quel tizio della contabilità?"