Programmatore? Scopri cos’è Livecoding.tv
Qual è la ragione per la dilagante scarsa documentazione tra gli sviluppatori? Mancanza di interesse, abilità, e il tempo? E, perché non utilizzare la documentazione video?
Uno dei sentimenti che più spesso accompagna gli sviluppatori quando devono scrivere la documentazione per quanto hanno realizzato si può sintetizzare in una semplice frase “Sono uno sviluppatore e odio scrivere la documentazione”, questo tipo di atteggiamento sicuramente non giova alla qualità di quanto accompagnerà il codice scritto, ma da cosa deriva questo tipo di atteggiamento, nel corso di questo articolo cercheremo per quanto possibile di indagare su alcune delle motivazioni che portano a questo tipo di atteggiamento.
Una premessa che va sicuramente fatta riguarda la complessità delle soluzioni software che i vari team devono realizzare ed al grado di turn-over nella composizione del gruppo di lavoro, inoltre un altro fattore di cui si deve tener conto è il target cui il software è rivolto si tratta infatti spesso di utenti con delle skill non molto elevate, questi due fattori sono alla base della necessità di documentare il codice, si tratta chiaramente di due aspetti molto importanti infatti una buona documentazione riduce i tempi necessari ai nuovi membri del team per essere completamente operativi il che riduce il time-to-market dell’azienda, dal punto di vista dell’utente finale una buona documentazione gli consente di utilizzare al meglio ciò che abbiamo realizzato garantendo un elevato grado di soddisfazione e l’instaurarsi di un possibile processo di fidelizzazione nei confronti di chi ha realizzato il software, già da soli questi due elementi sarebbero sufficienti a garantire la scrittura di una buona documentazione e allora perché questo non si verifica?
Gli sviluppatori sono troppo vicini ai Progetti
Questo può sembrare romantico, ma la verità è che la maggior parte degli sviluppatori sono troppo legati al proprio progetto per poter scrivere della buona documentazione, infatti lo sviluppatore finisce per il documentare pensando solo alla propria ottica e non tenendo in considerazione i punti di vista dei potenziali lettori. La profonda conoscenza del codice porta in genere a scrivere una documentazione superficiale in quanto chi sta producendo i diversi documenti sa bene cosa si cela dietro ogni aspetto del proprio codice il che lo porta a pensare che sia di fatto inutile dilungarsi su aspetti che dal suo punto di vista sono ovvi.
Poca voglia di scrivere la documentazione
Molti sviluppatori non sentono il bisogno di scrivere la documentazione perché ritengono che in un modo o nell’altro gli utilizzatori finali riusciranno in qualche modo a risolvere da soli i loro problemi di utilizzo del software. Se si cerca di costringere lo sviluppatore a scrivere ugualmente dei documenti che accompagnino il programma il risultato finale sarà qualcosa che solo loro possono capire.
Gli sviluppatori non hanno bisogno di documentazione
Quest’idea è il sottoprodotto del primo punto. Se sei uno sviluppatore, allora probabilmente conosci le ragioni di questo tipo di ragionamento. È semplice. Gli sviluppatori conoscono profondamente quello su cui stanno lavorando e per questo scelgono di non scrivere nulla che accompagni il loro codice. In linea di principio sembra ragionevole, giusto? Tuttavia, gli stessi sviluppatori spesso dimenticano che ciò che scrivono non è qualcosa di immutabile ed inoltre non tengono conto del fattore tempo, infatti capita spesso di dover riprendere codice scritto settimane, mesi o anni fa e senza un’adeguata documentazione risulta estremamente complicato riprendere le fila del discorso e continuare con un processo di sviluppo coerente ed armonico, il rischio in questo caso è che si sia costretti a riscrivere interi moduli solo perché non si ricorda come funzionava qualcosa che si era scritto in precedenza.
La documentazione richiede tempo e sforzi
La scrittura non è un compito facile; richiede pensiero critico, pazienza, e fatica. Per gli sviluppatori, la documentazione può essere un lavoro di routine. Secondo molti, è solo uno spreco di tempo e fatica, in quanto sanno già che questo tipo di operazione richiede molto tempo. Gli sviluppatori preferiscono usare tempo e fatica nella realizzazione di nuove funzioni, risolvere problemi, o per eliminare i bug.
Date di rilascio estremamente stringenti
C’è sempre una data di scadenza dietro l’angolo. Lo sviluppatore ha bisogno di consegnare il progetto in tempo, e nessuno si preoccupa per la documentazione. L’azienda vuole consegnare il progetto nel più breve tempo possibile a causa delle esigenze del cliente, e la prima cosa a cui si è costretti a rinunciare è la documentazione. L’unica eccezione è quando il client stesso a chiedere esplicitamente la produzione della documentazione.
I programmatori sono pigri
Anche avendo con competenze sufficienti per scrivere una buona documentazione, molti programmatori scelgono di non farlo. A volte il motivo è pura pigrizia.
Lo sviluppo e la scrittura sono due diverse qualifiche
In breve, la scrittura e lo sviluppo sono due abilità differenti, che richiedono processi mentali molto diversi tra loro, chi scrive la documentazione deve infatti sapersi astrarre dal codice e riuscire a descrivere semplicemente la logica che sta alla base di quella soluzione, si tratta di un processo non semplice in quanto chi scrive codice finisce inevitabilmente per riferirsi a quanto ha scritto con la conseguenza di non essere in grado di mostrare il quadro generale in cui le sue scelte progettuali si inseriscono.
Frequenti modifiche al codice sorgente
Lo sviluppo agile è il nuovo modo di scrivere codice. E ‘veloce, spietato, e non incoraggia la documentazione. Il motivo è semplice; il codice cambia troppo spesso per essere documentato il che porta a documentazione scadente se non addirittura a nessuna documentazione!
Tracotanza
Alcuni programmatori non scrivono documentazione, semplicemente perché ritengono che in questo modo possano mostrare capacità superiori agli altri, in quanto ritengono solo loro stessi in grado di comprendere quello che hanno scritto.
Sotto stimarsi
Questo punto è l’opposto di quello ultimo. Molti sviluppatori che sono in grado di scrivere la documentazione non lo fanno semplicemente perché pensano di non essere bravi nel farlo.
Qual’è la soluzione?
La scarsa documentazione può essere un grande problema esistono però delle soluzioni alternative allo scrivere la documentazione la piattaforma Livecoding.tv è una piattaforma di codifica sociale per lo sviluppo basata sul concetto dello streaming video. In pratica ogni team può utilizzare la piattaforma per registrare il proprio processo di sviluppo e renderlo privato solo per uso interno in questo modo si può sempre rivedere il video relativo alla realizzazione di uno specifico modulo consentendo così di riprendere velocemente le fila di un processo realizzativo. I progetti open source possono beneficiare molto di questa piattaforma infatti si migliora molto il processo di collaborazione.
In pratica il problema della noia connessa alla scrittura della documentazione viene meno in quanto lo sviluppatore registra il suo lavoro, e questo potrà essere utilizzato solo da altri membri del team o da chi è stato incaricato di scrivere la documentazione di progetto.
La documentazione video è un approccio migliore rispetto documentazione scritta in quanto non richiede sforzo supplementare da parte dello sviluppatore. Tutte le fasi di sviluppo possono essere memorizzati in video e accessibili quando necessario. La cosa buona è che i nuovi membri del team possono prendere rapidamente il progetto con spunti video registrati e corretto l’aiuto di altri membri del team.Nel complesso, l’idea è di migliorare gli inconvenienti di documentazione scritta.
D’altra parte, la squadra o la società possono dare i video di uno scrittore tecnico a scrivere la documentazione per gli utenti finali che consente di risparmiare anche il tempo per la maggior parte. L’approccio è ideale per le squadre agili che cambiano frequentemente il loro codice base anche.
Vantaggi Video Documentazione in a Nutshell
- Elimina la necessità di una corretta documentazione scritta per team interno.
- Fornisce una eccellente opportunità per le squadre agili per tenere traccia delle modifiche.
- Aiuta scrittori tecnici per comprendere meglio.
- Consente di risparmiare energia e di tempo per gli sviluppatori, consentendo loro di deviare le loro energie verso la scrittura codice migliore e funzioni di attuazione.
- Può essere usato per comprendere gli errori del flusso di lavoro dei membri del team e migliorare la produttività e l’efficienza.
Sei uno di quegli sviluppatori che non ama la scrittura di documentazione? Si prega di condividere i tuoi commenti e fatemi sapere il vostro parere su scritto contro documentazione video.
Vuoi diventare un Programmatore? Iscriviti ad uno dei nostri corsi in aula oppure online.
Promozioni
Potrebbe interessarti
Commenti