VANTAGGI E SVANTAGGI

Un sito che offre spiegazioni su come fare determinate cose viene spesso apprezzato dai navigatori di internet che, nella maggior parte dei casi, sceglie di affidarsi al web per cercare proprio questo genere di documentazione. Purtroppo scrivere un tutorial in maniera che possa essere capito e letto sino in fondo in maniera completa ed efficacie non è semplice.

SUGGERIMENTI PRATICI PER LA REALIZZAZIONE DI UN TUTORIAL

Vediamo ora di elencare il modo migliore per dar vita ad un tutorial fruibile al maggior numero di persone possibile. Nell'esempio che utilizzeremo per meglio comprendere la tecnica simuleremo di dover illustrare come si programma:

1. È sempre meglio non scrivere paragrafi troppo lunghi e cercare il più possibile di lasciare le giuste spaziature dove servono (ciò alleggerisce la comprensione e la lettura di procedure magari complesse).
2. Ad ogni termine tecnico deve corrispondere una spiegazione e ad ogni spiegazione un paio di esempi (se necessario coadiuvati da immagini), niente deve essere sottointeso.
3. È sempre utile alla fruibilità di un documento allegare un pulsante stampa e uno di download del codice o del risultato finale o di quello che sarebbe utile/possibile avere.
4. Il codice e/o le parti esemplificative devono avere una formattazione particolare. È importante inoltre utilizzare a dovere grassetti, corsivi e sottolineati. Il titolo generale e quelli dei paragrafi devono risaltare.
5. Se il tutorial ha un seguito o non è autoconclusivo non di deve aver paura di ripetersi (brevemente).
6. Meglio essere ordinati, gli elenchi puntati/numerati facilitano la memorizzazione e la comprensione.
7. Può essere interessante integrare a fondo pagina dei link ad approfondimenti.
8. Se il tutorial diventa troppo lungo è necessario suddividerlo.
9. Integrare un glossario esterno, se necessario.
10. La pagina deve risultare "pulita" e non "infestata" da banner vari.