Come Creare un Manuale d'Uso

In questo Articolo:Creare una Documentazione Adatta all’UtenteElementi di un Manuale d’UsoProgettare un Manuale Leggibile

I manuali d’uso sono guide scritte fisicamente (su carta) o documenti elettronici (PDF o XPS) che forniscono istruzioni su come fare o usare qualcosa. Sebbene le “guide d’uso” siano più comunemente concepite come legate ai software per computer, i manuali d’uso sono allegati anche ai computer o ad altri dispositivi elettronici come TV, stereo, apparecchi telefonici e lettori MP3, così come elettrodomestici ed equipaggiamento da giardino. Un buon manuale d’uso informa gli utenti a proposito delle funzionalità del prodotto, insegnandone anche i rispettivi funzionamenti in modo efficace e facilmente consultabile. Di seguito sono riportati gli elementi da considerare nella creazione di contenuti efficaci e nell’impaginazione di un manuale d’uso.

Parte 1
Creare una Documentazione Adatta all’Utente

  1. 1
    Definisci l’utente di riferimento. Per scrivere un manuale di successo, devi tracciare un profilo del tuo utente, sia formale, creando un profilo scritto, o informale, prendendoti il tempo per fare delle ipotesi ragionevoli sulle caratteristiche del tuo utente. Un profilo del genere è utile quando fai parte di una squadra intenta a scrivere la documentazione per l’utente e può anche essere utile nel processo che porta il prodotto dall’idea alla forma finale. Nella stesura di un profilo utente, gli elementi da considerare includono:
    • Dove gli utenti useranno il manuale, a casa, in ufficio, in un luogo di lavoro remoto o in macchina. Questo potrebbe influire non solo sul contenuto, ma anche sullo stile del manuale.
    • Come gli utenti useranno la guida. Se sarà necessario consultare il manuale solo raramente o per cercare informazioni, dovrebbe soprattutto assumere la forma di un documento di consultazione. Se è qualcosa che inizialmente verrà spesso consultato dagli utenti, la sezione di consultazione dovrebbe essere accompagnata da una sezione “Come iniziare” e da istruzioni sugli usi più comuni del prodotto.
    • Quanta esperienza gli utenti già hanno col prodotto o altri della stessa categoria. Se il tuo prodotto è nuovo o con differenze sostanziali rispetto ai prodotti simili, dovrai includere una spiegazione di queste differenze, così come delle istruzioni su come iniziare a usarlo. Se il prodotto affronta qualcosa con cui gli utenti spesso hanno problemi, come molte applicazioni per computer, dovrai fornire informazioni adeguate e dettagli in uno stile comprensibile.
  2. 2
    Rivolgiti ai bisogni del tuo utente in modo che questi possa capire. A meno che l’utente non abbia esperienza tecnica, sarà probabilmente meglio evitare terminologie specifiche, preferendo spiegazioni chiare e semplici. Il testo dovrebbe anche essere organizzato in modo da assecondare i ragionamenti degli utenti; elencare le caratteristiche del prodotto raggruppandole in base alle loro funzioni spesso ha più senso degli ordini più comunemente usati negli elenchi.
    • Talvolta non c’è modo di aggirare i termini tecnici, come per un software di creazione di grafici che include tabelle di Fibonacci insieme a più comuni grafici a torta e a barre. In casi simili, è utile definire il termine e fornire una spiegazione, ad esempio approfondendo la definizione e l’utilità nell’analisi finanziaria delle tabelle di Fibonacci.
  3. 3
    Spiega il problema che l’utente sta cercando di risolvere, poi presentane la soluzione. Fornire la sola soluzione di un problema generico funziona nella fase di vendita del prodotto, ma una volta che l’utente l’ha comprato, deve capire come usarlo nel modo migliore. Individua problemi specifici in cui s’imbatterà l’utente, enunciali nella guida d’uso e poi passa alle istruzioni per risolverli.
    • Se il problema è uno di quelli complessi, scomponilo in parti più piccole. Elenca ogni parte con le istruzioni su come risolverla o affrontarla, e poi disponile in successione. Questo procedimento è noto come "chunking" (spezzettamento).

Parte 2
Elementi di un Manuale d’Uso

  1. 1
    Includi la copertina e i frontespizi appropriati. Avrai bisogno di una copertina per ogni guida d’uso, che consiste in più di una semplice scheda di consultazione, e di frontespizi per manuali più lunghi di un foglio di carta piegato (lunghi 4 o più pagine).
    • Se il manuale è protetto da copyright, va specificato sia sulla copertina che sul frontespizio.
    • Se devi riportare i termini e le condizioni per l’uso del manuale e del relativo prodotto, devi inserirli nella parte interna della copertina.
  2. 2
    Inserisci riferimenti ai documenti collegati nell’introduzione. Se la documentazione d’uso copre più di un volume, fornisci qui i riferimenti agli altri documenti, con le versioni corrette. L’introduzione è anche la parte in cui inserire la sezione “Come usare questa guida”, se necessaria.
  3. 3
    Includi un indice, in caso il manuale superi le 10 pagine.
  4. 4
    Metti le istruzioni/metodi e i materiali di riferimento nel corpo centrale del manuale. In molti casi, i metodi e i materiali di riferimento dovrebbero avere ciascuno la propria sezione, anche se puoi sempre dire all’utente di fare riferimento a contenuti specifici da una sezione all’altra. In questo modo, l’utente può trovare le informazioni che cerca più velocemente.
    • I metodi dovrebbero essere scritti in modo coerente lungo la sezione delle istruzioni del manuale. Parti da una visione d’insieme del compito, poi descrivi ciò che l’utente deve fare e quali risultati dovrebbe ottenere. I passaggi dovrebbero essere numerati e iniziare con verbi d’azione, così come i passaggi di ciascuna sezione di quest’articolo.
    • I materiali di riferimento possono includere un elenco di opzioni, suggerimenti e domande frequenti. Glossari e appendici possono essere aggiunti verso la fine del manuale, sebbene una lista dei termini più usati possa apparire all’inizio. L’indice può essere tralasciato nel caso il manuale abbia meno di 20 pagine.
  5. 5
    Usa delle grafiche qualora sia necessario sostenere il testo. Le grafiche, o le schermate, possono illustrate determinati punti del manuale meglio del testo, soprattutto all’interno di procedure complesse in cui gli utenti hanno bisogno di una conferma visiva della correttezza dell’esecuzione. Le grafiche possono essere prodotte tramite programmi CAD o software grafici, di editing digitale e macchine fotografiche digitali, o nel caso delle schermate, tramite la funzione incorporata nel computer (“stamp”/cmd+shift+3) o un programma di grafica che fornisce l’opzione di registrazione della schermata.
    • Una volta creata la grafica, salvala in formato compresso in modo da permetterne l’uso nei programmi di scrittura o di pubblicazione. Vorrai anche ridurre la dimensione del file per facilitarne l’inclusione sulla pagina senza per questo ridurne i dettagli per l’utente (se necessario, potresti dover scomporre l’immagine originale e mostrare le parti rilevanti man mano che procedi col testo).
    • Se stai usando numerose grafiche nei metodi, mantieni una coerenza nelle dimensioni, che siano tutte della stessa lunghezza e larghezza o ridotte sempre con la stessa proporzione rispetto al loro formato originale. Questo renderà le immagini più invitanti per l’utente. Allo stesso modo, nel salvataggio delle schermate su un computer, accertati che il computer sia impostato su una colorazione standard durante questo passaggio, nel caso in cui il manuale debba conservare questi colori.
    • Sebbene programmi di grafica come Photoshop e Paint Shop Pro offrano buone possibilità di salvataggio dello schermo, anche programmi specifici come SnagIt consentono di modificare con facilità, catalogare e appuntare le schermate.

Parte 3
Progettare un Manuale Leggibile

  1. 1
    Scegli un paio di font leggibili. Sebbene i computer possano supportare numerose font diverse, l’obiettivo di un manuale d’uso è l’agevole leggibilità. La scelta di poche font ben abbinate è il miglior modo per raggiungere quest’obiettivo. Ci sono 2 categorie di font: “serif” e “sans serif” (con o senza grazie).
    • Le font serif hanno piccole terminazioni all’estremità dei tratti principali delle lettere. Le font serif includono Times New Roman, Baskerville e Book Antiqua. Le serif funzionano meglio in grossi blocchi testuali a grandezza 10-12 nel corpo centrale di un manuale d’uso stampato.
    • Le font sans serif esibiscono solo i tratti che formano le lettere senza terminazioni. Le sans serif includono Arial, Calibri e Century Gothic. Queste font possono essere usate per grossi blocchi di testo dalla misura 8-10 in un manuale online o in PDF, nonostante la mancanza di terminazioni renda le frasi grandi 12+ più difficili da leggere. Possono tuttavia essere usate efficacemente a dimensioni maggiori per mostrare titoli e testate, e sono ugualmente adatte in formati più piccoli per pié di pagina e numeri nelle colonne o tabelle.
    • Dovresti generalmente scegliere font neutre come Arial o Times New Roman per il tuo manuale d’uso, per quanto sia meglio propendere per una font decorativa in caso di citazioni o titoli, se stai scrivendo ad esempio per un videogioco con ambientazioni fantasy o fantascientifiche (in caso di estratti dal medesimo testo, puoi spesso usare la stessa font, in formato “italic”).
    • Una volta scelte le font che utilizzerai, crea una pagina di prova per verificare che le font stiano bene insieme su carta. Sarà anche il caso di mostrare questa prova a chiunque debba approvare l’aspetto del manuale prima di procedere.
  2. 2
    Pensa all’impaginazione. Una volta scelte le font del tuo manuale d’uso, devi decidere il posizionamento dei vari elementi delle pagine.
    • In genere, vorrai mettere il titolo del manuale o del capitolo nell’intestazione o in fondo alla pagina, possibilmente usando il titolo del manuale sulla pagina a sinistra e quello del capitolo su quella a destra. I numeri di pagina dovrebbero essere sopra o sotto, verso l’esterno (intestazione o pié di pagina) o al centro (solo pié di pagina). Potresti voler distinguere la prima pagina di ogni sezione o capitolo dalle altre, posizionando il suo numero di pagina al centro e quelli successivi nell’angolo esterno dell’intestazione.
    • Potresti voler richiamare parti del testo in riquadri colorati o sfumati, per separarle dal resto del testo. Accertati di scegliere un colore o grado di sfumatura che non si sovrapponga al testo.
    • Lascia margini ragionevolmente ampi su tutti i lati, con spazio sufficiente sui bordi che saranno rilegati l’uno all’altro.
  3. 3
    Considera il tipo di rilegatura del manuale d’uso. Se il tuo manuale ha più di 4 pagine, queste dovranno essere rilegate in qualche modo. Sebbene i documenti interni possano essere uniti con una graffetta in un angolo, i manuali esterni consegnati insieme al prodotto sono solitamente rilegati in uno di questi 3 modi:
    • Le graffette laterali sono adatte a manuali composti da fogli di carta piegati di 21x27.5cm, 21x35cm o 27.5x42.5cm. Gran parte dei manuali economici con meno di 48 pagine è rilegata in questo modo.
    • La cucitura laterale è più comunemente usata per guide di riferimento esterne piuttosto che manuali d’uso allegati ai prodotti che non siano automobili, sebbene alcune guide più lunghe siano rilegate in questo modo (Paint Shop Pro inizialmente era spedito con una guida rilegata a cucitura, quando era prodotto da JASC Software).
    • La rilegatura a spirale è adatta alle guide d’uso concepite per essere più robuste, come per gli ambienti esterni, in cui i manuali a graffette o cucitura non resisterebbero. Certi manuali rilegati a spirale possono anche contenere pagine laminate per evitare che si rovinino a contatto con acqua o fango.
  4. 4
    Costruisci un modello per il tuo manuale. Molti programmi di scrittura e pubblicazione offrono la possibilità di creare un documento-modello per il tuo manuale d’uso, in modo che scrivendo, il testo appaia automaticamente nella font desiderata all’interno della porzione di manuale a cui stai lavorando (quest’articolo, infatti, è stato inizialmente scritto usando un modello di MS Word). Molti di questi programmi comprendono anche una serie di modelli preimpostati che puoi modificare secondo le tue necessità, invece di creare un modello partendo da zero.
    • I programmi di scrittura e pubblicazione permettono anche di creare “stili”, font preimpostate e dimensioni per intestazioni, pié di pagina, titoli e corpi testuali. Puoi scegliere uno degli stili predefiniti (come "Heading1", "Normale", "Citazione") o creare il tuo stile personalizzato col relativo nome. Per quanto possibile, segui le convenzioni per i nomi degli stili istituzionali se hai molteplici stili per la stessa parte di testo (per esempio, MS Word etichetta gli stili per le intestazioni come "Heading1", "Heading2", ecc. per titoli, da quello principale ai vari livelli di sottotitoli). Cerca di creare in anticipo tutti gli stili di cui avrai bisogno, in modo da non doverti fermare a crearli durante l’effettivo processo di scrittura.

Consigli

  • Fai buon uso di codici e variabili di testo laddove possibile. Puoi assegnargli valori, come il nome di un prodotto, il titolo di un manuale o di un capitolo, e posizionarli nel documento invece che scrivere il testo effettivo. Quando vedi l’anteprima o stampi un documento, il testo sostituirà la variabile. Se il nome del prodotto cambia, o se modifichi il nome del manuale o di un capitolo, sarà più facile cambiare l’informazione sostituendo il valore della variabile di testo piuttosto che cercarlo e sostituirlo all’interno del documento.

Cose che ti Serviranno

  • Programma di scrittura o pubblicazione
  • Programma di grafica o registrazione visiva

Informazioni sull'Articolo

wikiHow è una "wiki"; questo significa che molti dei nostri articoli sono il risultato della collaborazione di più autori. Per creare questo articolo, 19 persone, alcune in forma anonima, hanno collaborato apportando nel tempo delle modifiche per migliorarlo.

Categorie: Hobby & Fai da Te

In altre lingue:

English: Create a User Manual, Español: hacer un manual de usuario, Português: Criar um Manual do Usuário, Русский: составить руководство пользователя, Deutsch: Eine Bedienungsanleitung schreiben, Français: créer un manuel d'utilisateur, العربية: تصميم كتيب الاستخدام, Nederlands: Een handleiding maken, Bahasa Indonesia: Membuat Panduan Pengguna, 中文: 编写用户说明书, 한국어: 유저 매뉴얼을 만드는 방법, 日本語: ユーザーマニュアルを作る

Questa pagina è stata letta 33 304 volte.
Hai trovato utile questo articolo?