Una guida per l'utente è un manuale in formato cartaceo o elettronico (PDF o XPS) che fornisce istruzioni su una procedura o sull'uso di qualcosa. Sebbene i "manuali per l'utente" siano spesso associati alle guide per le applicazioni informatiche, le guide per l'utente vengono fornite anche con computer e altri dispositivi elettronici come televisori, stereo, sistemi telefonici, lettori MP3 e attrezzature per la casa e il giardino. Una buona guida per l'utente educa gli utenti sulle funzionalità del prodotto mentre insegna loro come utilizzare tali funzionalità in modo efficace. La guida per l'utente è strutturata in modo tale da essere di facile lettura e consultazione. Ecco alcuni passaggi da considerare quando si sviluppano contenuti efficaci e si progettano layout di guide per l'utente.
Fare un passo
Parte 1 di 3: creazione di una guida per l'utente appropriata
Passaggio 1. Decidi chi utilizzerà la guida
Per scrivere una buona guida per l'utente, è necessario sviluppare un profilo utente, sia formalmente creando un profilo scritto o informalmente prendendo il tempo per fare ipotesi ragionevoli sulle caratteristiche dell'utente. Tali profili sono utili quando si fa parte di un team di redazione di guide per l'utente e quando si lavora sul prodotto previsto dall'idea alla forma finale. Considera i seguenti fattori quando crei un profilo utente:
- La posizione dell'utente utilizzerà la guida, ad esempio a casa, in ufficio, in un luogo di lavoro remoto o in macchina. Questo fattore determina non solo il contenuto, ma anche lo stile di scrittura che la guida adotterà.
- Come l'utente utilizzerà la guida. Se lo usano raramente o ne hanno bisogno solo per trovare informazioni, è meglio se la guida è realizzata sotto forma di documento di riferimento. D'altra parte, se l'utente lo utilizzerà regolarmente all'inizio, la sezione di riferimento dovrebbe essere accompagnata da una sezione "Come iniziare" e istruzioni sulle funzioni più comuni che il prodotto eseguirà.
- Quanta esperienza ha l'utente con il prodotto o un articolo simile. Se il prodotto è nuovo o molto diverso da prodotti simili, è necessario includere una spiegazione di come differisce dagli altri e istruzioni su come utilizzarlo. Se il prodotto tratta qualcosa che gli utenti trovano spesso difficile, come un'applicazione per computer, è necessario fornire informazioni e dettagli appropriati in modo comprensibile.
Passaggio 2. Creare una guida che soddisfi le esigenze dell'utente in un modo che possa comprendere
Se gli utenti non sono persone tecnicamente esperte, probabilmente è meglio evitare un linguaggio altamente tecnico e fornire spiegazioni chiare e semplici. Il testo dovrebbe anche essere organizzato in modo che assomigli al modo in cui pensa l'utente. L'elenco delle funzionalità del prodotto raggruppate per funzione ha spesso più senso che per le funzionalità utilizzate più di frequente.
A volte l'uso di termini tecnici è inevitabile, ad esempio per le applicazioni di creazione di grafici che includono grafici di Fibonacci insieme a grafici a torta e grafici a barre più comuni. In un caso come questo, sarebbe meglio definire i termini e fornire informazioni, ad esempio una spiegazione di cos'è il grafico di Fibonacci e come viene utilizzato nell'analisi finanziaria
Passaggio 3. Descrivi il problema che l'utente sta cercando di risolvere, quindi fornisci una soluzione a tale problema
Offrire funzionalità come soluzioni a problemi comuni va bene quando si pubblicizza un prodotto, ma una volta che un cliente possiede il prodotto, deve capire come usarlo. Identificare il problema che l'utente incontrerà, descriverlo nella guida dell'utente, seguito dalle istruzioni per risolverlo.
Se il problema è complesso, suddividilo in pezzi più piccoli. Annota ogni sezione con le istruzioni su come risolverlo o affrontarlo, quindi segui l'altro in ordine. La suddivisione delle informazioni in questo modo è nota come metodo di raggruppamento o suddivisione
Parte 2 di 3: Componenti della guida per l'utente
Passaggio 1. Creare una copertina e un frontespizio appropriati
Avrai bisogno di una copertina per qualsiasi guida per l'utente che sia più di una scheda di riferimento e un frontespizio per una guida che includa più di un foglio di carta piegato (4 pagine o più di lunghezza).
- Se la guida è protetta da copyright, l'avviso di copyright deve essere incluso sulla copertina anteriore e posteriore, nonché sul frontespizio.
- Se sono presenti termini e condizioni per l'utilizzo della guida e dei prodotti ad essa associati, includerli all'interno della copertina.
Passaggio 2. Inserire un riferimento al documento correlato nell'introduzione
Se è presente più di una guida per l'utente, fare riferimento a un altro documento, incluso il numero di versione corretto, qui. La prefazione è anche un posto dove inserire la sezione "Come usare questa guida" se ce n'è una.
Passaggio 3. Includere un sommario se la guida è più lunga di 10 pagine
Passaggio 4. Posizionare le istruzioni/procedure e i materiali di riferimento sul corpo della guida
Nella maggior parte dei casi, sia la procedura che il materiale di riferimento dovrebbero avere ciascuno una propria sezione. Tuttavia, puoi dire agli utenti di fare riferimento a contenuti specifici in una sezione e differenziarli dalle altre sezioni. In questo modo, l'utente può trovare rapidamente le informazioni che sta cercando.
- Le procedure dovrebbero essere scritte in una struttura coerente in tutte le istruzioni del manuale. Inizia con una panoramica delle funzionalità del prodotto, quindi spiega cosa dovrebbe fare l'utente e quali risultati otterrà o vedrà. I passaggi dovrebbero essere numerati e iniziare con un verbo d'azione, così come sono scritti i passaggi in ogni sezione di questo articolo.
- Il materiale di riferimento può includere liste di controllo, suggerimenti per la risoluzione dei problemi e domande frequenti. Un glossario e un indice possono essere aggiunti alla fine della guida, sebbene all'inizio possa essere fornito un glossario dei termini usati di frequente. L'indice può essere omesso se la guida ha meno di 20 pagine.
Passaggio 5. Utilizzare le immagini grafiche necessarie per supportare il testo
Le immagini grafiche, o screenshot, possono illustrare meglio alcuni punti in una guida rispetto al testo, specialmente in procedure complesse in cui gli utenti necessitano di una conferma visiva per assicurarsi di seguire correttamente i passaggi. I disegni grafici possono essere creati utilizzando applicazioni di disegno assistito da computer (CAD) o di modifica grafica, fotocamere digitali e applicazioni di elaborazione di foto o, se si desidera utilizzare schermate, utilizzare le funzionalità di screenshot integrate nel computer o un programma di grafica con capacità di acquisizione dello schermo.
- Una volta creata un'immagine grafica, salvala in un formato compresso in modo da poterla utilizzare in un'applicazione di elaborazione testi o desktop publishing. È inoltre necessario ridurre le dimensioni dell'immagine per adattarla meglio alla pagina, ma fornire comunque dettagli completi per l'utente. (Se necessario, puoi ritagliare l'immagine originale in sezioni e mostrare le sezioni pertinenti insieme al testo di supporto).
- Se utilizzi più immagini grafiche nella procedura, assicurati che le immagini vengano create con una dimensione coerente, nelle stesse dimensioni di lunghezza e larghezza o in proporzione alla dimensione dell'immagine originale. In questo modo, l'immagine apparirà più attraente per gli utenti. Lo stesso vale quando si acquisiscono schermate da un computer; assicurati che il computer visualizzi la combinazione di colori standard quando scatti le foto, altrimenti la procedura guidata visualizzerà uno screenshot a colori.
- Mentre le app di modifica delle immagini come Photoshop e Paint Shop Pro hanno buone capacità di acquisizione delle immagini, i programmi dedicati alla cattura di schermate come Snagit offrono anche la possibilità di modificare, catalogare e annotare facilmente gli screenshot.
Parte 3 di 3: progettazione di una guida per l'utente di facile utilizzo
Passaggio 1. Scegli alcuni caratteri di facile lettura
Sebbene un computer possa supportare una serie di caratteri, lo scopo della creazione di una guida per l'utente è di facile lettura. La selezione di più caratteri corrispondenti è il modo migliore per raggiungere questo obiettivo. I caratteri possono essere raggruppati in due tipi: serif e sans serif.
- I caratteri Serif hanno piccole linee decorative alle estremità delle linee principali che compongono le lettere. I caratteri con grazie includono Times New Roman, Baskerville e Book Antiqua. I caratteri Serif sono perfetti per la maggior parte del testo visualizzato nelle dimensioni 10-12 nel corpo principale per le guide di stampa.
- I caratteri sans serif presentano solo le linee che compongono le lettere, senza abbellimenti. I caratteri che appartengono al gruppo sans serif includono Arial, Calibri e Century Gothic. I caratteri sans serif possono essere utilizzati per la maggior parte delle dimensioni di testo da 8 a 10 nei file PDF o nelle guide online, sebbene il fatto di essere disadorni renda più difficili da leggere le frasi visualizzate con caratteri 12 o più grandi. Tuttavia, i caratteri possono essere utilizzati efficacemente in dimensioni più grandi per visualizzare intestazioni e intestazioni e in dimensioni più piccole sono perfetti per note a piè di pagina e numeri in colonne e tabelle.
- In generale, è meglio scegliere un carattere semplice come Arial o Times New Roman per la tua guida, anche se puoi usare un carattere decorativo per citazioni o titoli se stai scrivendo una guida per un videogioco ambientato in un'ambientazione fantasy o fantascientifica. (Nel caso delle citazioni, spesso è possibile utilizzare un carattere semplice e visualizzare la citazione completa in corsivo).
- Dopo aver deciso quali caratteri utilizzare, crea pagine di esempio per verificare che abbiano un bell'aspetto sulla carta. Dovresti anche mostrare questa pagina di esempio alla persona responsabile della fornitura dell'approvazione per la visualizzazione della guida prima di procedere con il processo di scrittura.
Passaggio 2. Pensa al layout
Dopo aver selezionato un carattere per la guida, dovrai decidere come strutturare il contenuto nella parte superiore della pagina.
- In generale, dovresti probabilmente inserire il titolo del documento o il titolo del capitolo nell'intestazione o nel piè di pagina, magari utilizzando le intestazioni della guida a sinistra della pagina e le intestazioni dei capitoli a destra della pagina. È necessario inserire il numero di pagina nell'intestazione o nel piè di pagina, all'esterno (intestazione o piè di pagina) o al centro (solo nel piè di pagina). Potrebbe anche essere necessario distinguere la prima pagina di ogni sezione o capitolo dalle altre pagine inserendo il numero di pagina al centro del piè di pagina e la pagina successiva nell'angolo esterno dell'intestazione.
- Potrebbe essere necessario inserire il testo all'interno di una casella colorata o di una casella di blocco per differenziarlo dal resto del testo. Assicurati di scegliere un colore o un livello di blocco in modo che non renda difficile la lettura del testo.
- Lascia un margine abbastanza ampio su tutti i lati, con uno spazio extra ai bordi da rilegare.
Passaggio 3. Considerare il tipo di volume per la guida dell'utente
Se la guida è più lunga di 4 pagine, le pagine devono essere rilegate in un certo modo. Sebbene i documenti interni possano essere pinzati con una pinzatrice nell'angolo della pagina, la guida per l'utente esterna fornita con il prodotto viene solitamente pinzata con uno dei seguenti 3 metodi:
- Il metodo di pinzatura laterale (bloccato ai lati della pagina con una pinzatrice) per le guide stampate su carta piegata 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. Le guide più economiche di 48 pagine o meno sono rilegate in questo modo.
- Il metodo di cucitura a sella (cucito a lato della pagina) viene utilizzato più spesso per le guide di riferimento di terze parti rispetto alle guide incluse con prodotti diversi dalle automobili, sebbene alcune guide più lunghe siano rilegate in questo modo. (La Guida di Paint Shop Pro includeva originariamente una guida per la cucitura a sella mentre era ancora prodotta da JASC Software).
- La rilegatura a spirale è più adatta per le guide utilizzate in ambienti più difficili, come all'aperto (nel qual caso i metodi di pinzatura laterale e pinzatura a sella non sono abbastanza forti da far scivolare le pagine). Alcune guide con rilegatura a spirale possono anche avere pagine laminate con plastica per evitare che si danneggino quando sono bagnate o esposte al fango.
Passaggio 4. Creare un documento modello come guida
Molte applicazioni di elaborazione testi e desktop publishing offrono la possibilità di creare documenti modello per le guide dell'utente. Quindi, durante la digitazione, il testo apparirà automaticamente con il carattere selezionato per la parte della procedura guidata su cui stai lavorando. (In realtà, questo articolo è stato originariamente scritto utilizzando un modello di Microsoft Word). La maggior parte di questi programmi include anche un set standard di modelli che è possibile modificare secondo necessità in modo da non doverne creare da zero.
