Come si realizza un buon manuale di istruzioni?

L'importanza della documentazione tecnica

Un manuale ha la funzione principale di aiutare l'utente ad utilizzare un prodotto o servizio ma se ben realizzato diventa anche un'importante strumento di marketing.
Il rapporto tra aziende e utente non si esaurisce con l'acquisto del prodotto, ma prosegue per tutto il suo ciclo di vita e se l'utente viene ben seguito e si sente considerato dall'azienda tornerà a fare acquisti da essa. Il manuale di istruzione è uno degli strumenti più importanti per la soddisfazione dell'utente, può fare la differenza tra un esperienza post-acquisto fantastica ed una orribile.

Una documentazione ben fatta è anche un aiuto all'assistenza clienti, che avrà una base solida con cui supportare il cliente che chiede aiuto.

In questo articolo vedremo alcuni suggerimenti su come impostare la progettazione del documento.

Impostazione del progetto

Innanzitutto chi crea le istruzioni deve avere un'esperienza pratica di utilizzo del prodotto, meglio ancora avere a disposizione degli esperti che hanno una conoscenza più approfondita.

Le fasi fondamentali per la preparazione di un'istruzione d'uso sono:

1. redazione dei testi

2. preparazione degli elaborati grafici

3. impaginazione

4. certificazione

5. traduzione dei testi

6. ultimazione

1 - Redazione dei testi

L'utente è demotivato quando legge qualcosa che non riesce a capire, si sente stupido. Anche i concetti complessi devono essere espressi in modo semplice e chiaro, non si devono usare parole tecniche, gergali o acronimi che il cliente probabilmente non conosce. Allo stesso tempo non si deve nemmeno considerare l'utente come un bambino, bisogna adeguare il linguaggio al suo livello di competenza.

2 - Preparazione degli elaborati grafici

I disegni sono realizzati prendendo come riferimento un campione del prodotto, le fotografie, i modelli 3d e i disegni tecnici in base alla disponibilità del produttore o del progettista. I disegni sono poi completati da frecce, simboli e altri pittogrammi che aiutano la comprensione del racconto visivo.

Oltre a disegni si aggiungono tabelle, diagrammi ed altri tipi di elaborati grafici necessari a trasmettere informazioni utili all'utente. Quando un disegno da solo non è esaustivo viene corredato da un testo esplicativo, ma è buona regola privilegiare la parte illustrativa rispetto al testo perché rende più immediata e piacevole la consultazione da parte dell'utente.

Quando l'istruzione viene realizzata per la pubblicazione digitale è possibile integrare contenuti interattivi, animazioni e video.

Mostra, non raccontare. Questa espressione riferita alla tecnica narrativa si applica perfettamente anche ai manuali di istruzione. Le persone recepiscono le informazioni visive meglio e più velocemente quando vengono fornite utilizzando immagini e video. Come per il testo, anche le grafiche possono risultare prolisse o noiose, il metodo più adatto in questi casi è la grafica semplificata, ovvero un modo di illustrare che ha l'obiettivo di evidenziare le parti grafiche essenziali e di ridurre in forme più semplici quelle meno importanti. Permette all'utente di focalizzarsi sull'obiettivo senza perdersi in dettagli marginali.

3 - Impaginazione

I testi e le illustrazioni, anche se ancora in stato di bozza, vengono inseriti in un impaginato, il cui formato è concordato con il committente e lo stampatore. Il formato deve essere adatto, per forma e dimensioni, ad accompagnare il prodotto ed il relativo packaging. Per questo passaggio si utilizza un software di desktop publishing.

La normativa impone anche qui delle regole, ad esempio la dimensione minima che il testo deve avere, la disposizione logica dei contenuti, l'inserimento di determinate informazioni.

Ogni contenuto deve essere ordinato secondo un flusso logico. Si inizia con le basi di funzionamento del prodotto per poi procedere gradualmente verso le operazioni più avanzate e specifiche. Già dopo una rapida consultazione l'utente deve essere in grado di utilizzare il prodotto nelle sue funzioni principali.

Stile grafico. Un documento esteticamente piacevole sarà più propenso ad essere consultato. Evitare paragrafi troppo lunghi, blocchi di testo ininterrotti o pagine troppo piene che possono scoraggiare l'utente. Lasciare i giusti spazi bianchi tra un contenuto e l'altro è utile per spezzare la monotonia. Privilegiare immagini, illustrazioni, oppure animazioni e video per i documenti elettronici e ridurre i testi. Se l'azienda ha delle linee guida di stile è bene utilizzarle.

Prima di inviare il documento all'ente è prassi fare dei test con persone di differenti livelli di competenza, i feedback dei test possono far emergere eventuali errori, punti deboli e ambiguità.

4 - Certificazione

La bozza dell'istruzione a questo punto viene inviata all'ente di certificazione, che, come per il prodotto, esegue i controlli per verificare la conformità con la normativa. In seguito l'ente certifica l'istruzione e permette al redattore di ultimare il lavoro.

5 - Traduzioni

Ricevuta la conferma dall'ente, il redattore prepara i testi da inviare ai traduttori. Utilizzando software di gestione delle traduzioni TMS (Translation Management System) e CAT tools (Computer Assisted Translation) il lavoro si velocizza e si semplifica. Questi software inoltre si avvalgono delle memorie di traduzione (TM) che riducono ulteriormente tempi e costi.

6- Ultimazione

Il redattore, infine, inserisce le traduzioni e prepara i documenti per la stampa o per la pubblicazione digitale.

In passato la maggior parte dei manuali di istruzione veniva esclusivamente stampato. Oggi che quasi tutti abbiamo accesso ad internet ha più senso mettere a disposizione una versione elettronica del documento. Offre alcuni vantaggi anche all'azienda che può, ad esempio, effettuare facilmente gli aggiornamenti.

Il formato PDF è molto comodo per creare le versioni da stampare, per quelle elettroniche invece è preferibile caricare direttamente le informazioni su una pagina del sito web. Offre un'esperienza d'uso sensibilmente migliore, sia che l'utente acceda da computer, tablet o smartphone. Se qualcuno lo richiede è comunque possibile offrire in aggiunta una versione PDF scaricabile.

Riassumendo, una buona documentazione per l'utente deve:

• avere un linguaggio semplice, chiaro e adeguato al livello di competenza del lettore
  
• privilegiare gli elementi grafici rispetto al testo
• avere una gerarchia logica dei contenuti
  
• avere uno stile grafico essenziale e piacevole

> SCOPRI TUTTI I SERVIZI

> HOME PAGE