giovedì 8 gennaio 2015

Documentazione Ufficiale: anello di congiunzione tra utente e sviluppatore



Sicuramente una delle fonti più sicure ed affidabili per avere informazioni è la documentazione ufficiale, comprendenti FAQ e Wiki. Di solito ogni progetto, che si tratti di un sistema operativo o di un singolo programma, ha la sua documentazione che può essere più o meno completa, più o meno aggiornata.
La documentazione è estremamente importante sia per l’utente che per il team di sviluppo.
L’utente infatti ha a disposizione tutto il necessario per informarsi, capire e far funzionare al meglio il prodotto offerto, mentre gli sviluppatori hanno la possibilità di offrire informazioni importanti senza doversi ripetere mille e mille volte e riducendo al minimo le lamentele degli utenti.
  • Cominciamo proprio dalle domande più comuni o FAQ.

Senza dubbio alcune delle domande che vi porrete all’inizio se le saranno poste numerose altre persone; costringere gli sviluppatori o i manutentori a rispondere ogni volta alle stesse domande non aiuta né il progetto né i nervi. La sessione FAQ serve proprio a questo, l’utente troverà la risposta alle domande più frequenti mentre lo sviluppatore avrà il tempo di lavorare e rispondere ad esigenze e domande inusuali
  • La sessione Wiki invece è il vero e proprio manuale del progetto.

Comprende tutto, o quasi quello che riguarda sia il prodotto che le diverse versioni dello stesso. Funzionalità, compatibilità, installazione ecc. sono solitamente ben documentati.

Purtroppo questa mole di informazioni può essere di difficile consultazione per l’utente che quindi preferisce rivolgersi a forum o social con il rischio, come per le FAQ di smuovere i nervi di qualche operatore (che magari ha speso una bella fetta del suo tempo per redigere la Wiki) e ricevere risposte non proprio amichevoli o il fatidico “te lo cerco io su google”.

Si perchè i motori di ricerca, Google in particolare, sono un valido ausilio per la ricerca delle informazioni anche all’interno delle Wiki e dei forum, ed è buona norma ricorrere a tutti questi mezzi prima di chiedere aiuto.


Quindi la sostanza è: prima di chiedere aiuto vedete se l’aiuto vi è stato già fornito.


Nota tecnica: le cose nel mondo dell’informatica cambiano molto rapidamente, per cui è importante che quando seguiamo una guida o leggiamo la documentazione tecnica siamo sicuri che faccia riferimento proprio alla nostra versione del progetto. In caso contrario è meglio continuare la ricerca e, se non si trova nulla al riguardo, è opportuno chiedere per evitare di incorrere in errori e malfunzionamenti.


Di seguito alcune tra le documentazioni più complete dell’ecosistema GNU/Linux:
OpenSUSE