Un progetto OpenSource non è completo finché non è completa la documentazione

0

opensource

Quando un progetto informatico è finito? Quando può dirsi completo? Nell’ambito OpenSource (ma in realtà ovunque si sviluppi) nel valutare la qualità di un progetto, tante volte a fare la differenza è la documentazione.

In questo articolo che David Both ha scritto sul portale OpenSource.com la questione viene affrontata nel dettaglio e, tralasciando la documentazione classica di utilizzo di un prodotto, divisa in tre ambiti principali:

  1. La documentazione verso i clienti: ossia documentare tutte le iterazioni avvenute verso il cliente, per tenere traccia di quanto è stato richiesto e come si è ragionato per raggiungere determinati obiettivi;
  2. La documentazione nel codice: i famosi “commenti” essenziali per la portabilità e la continuità del progetto stesso;
  3. La documentazione delle problematiche: con l’utilizzo e l’evoluzione delle problematiche la documentazione va integrata, in modo che sia fresca a fronte degli utilizzi presenti;

Consigli utili? Mero buonsenso? Chi può dirlo, certamente una lettura interessante!

Da sempre appassionato del mondo open-source e di Linux nel 2009 ho fondato il portale Mia Mamma Usa Linux! per condividere articoli, notizie ed in generale tutto quello che riguarda il mondo del pinguino, con particolare attenzione alle tematiche di interoperabilità, HA e cloud.
E, sì, mia mamma usa Linux dal 2009.

Lascia un commento

Il tuo indirizzo email non sarà pubblicato. I campi obbligatori sono contrassegnati *