Ho trovato che QUALSIASI documentazione è migliore di NESSUNA documentazione. L'importo appropriato è in genere determinato 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 attuale abbiano aspettative irrealistiche nei loro ricordi, o si vergognino delle loro capacità di scrittura e non sono disposti a fare pratica.
Mi rendo conto di essere in minoranza (maggiore inglese che è entrato nell'ingegneria del software in una scuola di specializzazione) qui, perché non trovo la documentazione un lavoro ingrato. È un prezioso strumento professionale. Potrei non trovare la scrittura difficile da fare come alcuni dei miei colleghi, ma è soprattutto perché ho più pratica in questo. Non considero un progetto finito a meno che non abbia documentazione, e di solito lo scrivo per ragioni puramente egoistiche: così posso dare alle persone qualcosa da leggere invece di prendere telefonate ed e-mail, o così posso ricordare di cosa stavamo parlando ultimo mese, o così posso riferirmi 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 il codice di prova. È sorprendente come alcuni modelli pre-scritti (con intestazioni, stub di codice, ecc.) Possano rendere la documentazione più semplice e veloce da fare. In questo modo puoi acquisire i cambiamenti mentre accade e hai meno possibilità di copertura nel tempo. Sei più efficiente in questo modo, dal momento che puoi fare riferimento alla documentazione in base alle tue esigenze e modificarla lungo il percorso. Fare così in un wiki, ad esempio, rende gli aggiornamenti più facili ed è possibile evitare problemi di versione del documento se il più recente e il più grande è sempre online nello stesso posto e si possono semplicemente inviare collegamenti a persone che hanno bisogno di leggerlo.
Se trascorri un po 'di tempo a documentare, lavorerai TUTTI più velocemente, soprattutto quando qualcuno si unisce al team, dal momento che non dovrà passare tutto il 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. Avremmo tutti risparmiato un sacco di tempo se avessimo scritto un altro paio di note.
Il tuo team ha gli stessi problemi con il test o la scrittura del codice di test? In caso contrario, questa sarà una vendita più facile.
La tua documentazione è utile in molti modi:
1) A te, proprio ora, e ai tuoi colleghi, mentre lavori al progetto.
2) Ai tuoi clienti. Avere documentazione (inclusi diagrammi) che puoi mostrare agli utenti semplifica le discussioni nelle riunioni, specialmente se stai discutendo di sistemi complicati. Anche se la documentazione è incompleta, è un punto di partenza.
3) Alle persone che erediteranno il tuo lavoro (che potrebbe anche essere te, in tre anni). Molti dei miei colleghi più giovani pensano che ricorderanno cose per sempre. So che non lo ricorderò oltre questa settimana se non lo scrivo. Avere documentazione ti evita di dover passare una mezza giornata per ricordare come hai strutturato qualcosa, e dover ricominciare tutto da capo.
4) A te e agli altri, se la situazione diventa politica o controversa. Come qualcuno che prende appunti negli incontri, per tenermi sveglio e combattere la noia, sono spesso stato l'unico con la versione scritta di una decisione. La persona che l'ha scritta vince la disputa. Ricorda questo la prossima volta che qualcuno dice "Ricorda quell'incontro avvenuto lo scorso inverno nella sala conferenze 4, quando stavamo andando oltre X? Fred era lì, e chi è quel tizio della Contabilità?"