Saper scrivere... un Tutorial.

Quando bisogna scrivere un manuale che verrà utilizzato da un utente poco esperto, l'approccio migliore è quello del Tutorial.

Un Tutorial è un documento in cui un certo argomento viene esposto in una modalità estremamente semplificata, attraverso delle descrizioni sintetiche, spesso in modalità "passo-passo", corredate da immagini di supporto finalizzate a migliorarne la comprensione.

Esso deve assecondare il processo di apprendimento ed esecuzione dei compiti tipico dell’utente e deve fare largo uso di esempi, limitando al minimo gli approfondimenti e le specifiche tecniche.

Ora proviamo a mettere in fila i criteri fondamentali per arrivare a scrivere un buon Tutorial.

1. Chiarire subito l’oggetto del Tutorial: è necessario far capire al lettore cosa si appresta a leggere, descrivendo precisamente l’oggetto del tutorial nel titolo o nell’introduzione del medesimo.

2. Sintesi e chiarezza: l’obiettivo è quello di far imparare nuove cose a chi lo legge, quindi è necessario utilizzare parole chiare, semplici e non dilungarsi troppo, rischiando di stancare il lettore.

3. Non scrivere paragrafi troppo lunghi: i concetti espressi in ogni paragrafo devono essere ben strutturati e suddivisi in passi semplici.

4. Utilizzare uno stile redazionale ordinato: è importante utilizzare liste e tabelle, nonchè righe di spaziatura per facilitare la lettura e alleggerire "visivamente" la struttura del testo.

5. Inserire delle immagini: in molti casi un'immagine è più esplicativa di decine di parole.

6. Definire prima di usare: ogni termine tecnico o concetto deve essere correttamente definito prima di poterlo usare.

7. Fare degli esempi: dopo la lettura della teoria è importante la pratica, quindi è sempre buona norma inserire degli esempi brevi ed esaustivi.

8. Inserire delle F.A.Q.: può essere utile abbinare al Tutorial delle risposte alle domande più frequenti, al fine di chiarire ancora meglio le idee al lettore.

9. Elementi da integrare: in fondo ad un Tutorial può essere utile inserire un glossario e/o una raccolta di link utili a pagine Web che possono arricchire i contenuti espressi.

10. Aggiornare il Tutorial: è opportuno mantenerlo sempre aggiornato e integrare, quando necessario, i contenuti espressi.

Infine una raccomandazione: quando si scrive un Tutorial, bisognerebbe proporre esempi e soluzioni che derivano direttamente dalla propria competenza ed esperienza diretta sull'argomento.
Proprio perchè è un tipo di documento rivolto ad un utente principiante, è estremamente facile fornire indicazioni inesatte o fuorvianti se tali indicazioni vengono "riportate" da altri testi e non direttamente sperimentate.

Prossimamente, vedremo un esempio di un semplice documento rivolto ad utente principiante, nonchè un "contro esempio" su come NON SI DOVREBBE scrivere un tutorial.

Condividi

Articoli correlati per categorie