

A volte non puoi fare a meno di utilizzare termini tecnici, come per un`applicazione software per la generazione di grafici con grafici di Fibonacci e i più comuni grafici a torta e a barre. In tal caso, è utile definire il termine e fornire informazioni di base come una spiegazione di cosa sono i grafici di Fibonacci e il loro utilizzo nell`analisi finanziaria. 
Se il problema è complesso, scomponilo in piccoli pezzi. Elenca ogni parte con le istruzioni su come risolverla o come gestirla e gestiscili una dopo l`altra. La scomposizione delle informazioni in questo modo si chiama `chunking`. 



Le procedure dovrebbero essere scritte in una struttura coerente nelle istruzioni del manuale. Inizia con una panoramica dell`attività, quindi descrivi cosa dovrebbe fare l`utente e cosa dovrebbe percepire come risultato. I passaggi devono essere numerati e introdotti con verbi di azione, poiché i passaggi sono scritti in ciascuna sezione di questo articolo. I materiali di riferimento possono includere elenchi di opzioni, suggerimenti, soluzioni e domande frequenti. Glossari e indici possono essere inclusi all`incirca alla fine del manuale, sebbene un elenco di termini comunemente usati possa essere fornito sulla copertina. L`indice può essere omesso se il manuale è inferiore a 20 pagine. 
Una volta creata un`immagine grafica, puoi salvarla in un formato compresso adatto al tuo programma di elaborazione testi o DTP. Dovrai anche ridurre le dimensioni fisiche dell`immagine per renderla un po` più facile da adattare alla pagina, senza sacrificare i dettagli. (Se necessario, puoi dividere l`immagine originale in pezzi e visualizzare le parti rilevanti, insieme al testo di supporto.) Se utilizzi più grafici nelle procedure, rendili di dimensioni coerenti, con le stesse misure per lunghezza e larghezza o ridotti allo stesso modo. Ciò renderà le immagini più attraenti per l`utente. Inoltre, durante l`acquisizione di schermate, assicurati che il computer utilizzi una combinazione di colori standard durante l`acquisizione delle immagini, se il manuale utente visualizza le schermate a colori. Mentre i programmi di editing grafico come Photoshop e Paint Shop Pro offrono la possibilità di acquisire uno screenshot, programmi specifici come SnagIt ti danno la possibilità di modificare, catalogare e didascalia facilmente le immagini. 

In generale, inserisci il titolo o il titolo del capitolo nell`intestazione o nel piè di pagina, possibilmente con il titolo nella pagina sinistra e il titolo del capitolo nella pagina destra. Inserisci anche i numeri di pagina nell`intestazione o nel piè di pagina, vicino al bordo (intestazione o piè di pagina) o al centro (solo nel piè di pagina). Puoi fare in modo che ogni prima pagina di una sezione o di un capitolo sia diversa dalle altre pagine posizionando il numero di pagina corrispondente in basso al centro della pagina e le altre pagine nell`angolo in alto della pagina. Potresti voler indicare del testo esplicativo in caselle colorate o ombreggiate per distinguerlo dal resto del testo. Scegli un colore o un livello di ombreggiatura senza compromettere la leggibilità. Optare per margini abbastanza ampi su tutti i lati, con spazio extra ai bordi che saranno legati insieme. 
La pinzatura è adatta per manuali composti da fogli di carta piegati: 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. I manuali prodotti a basso costo di 48 pagine o meno sono raggruppati in questo modo. La pinzatura a sella è più comunemente utilizzata per le guide di riferimento di terze parti che per i manuali utente inclusi con prodotti non automobilistici, sebbene alcuni manuali utente più completi siano vincolati in questo modo. (Paint Shop Pro originariamente veniva fornito con un manuale utente rilegato con pinzatura a sella quando è stato pubblicato da JASC Software.) La rilegatura a spirale è adatta per i manuali del proprietario progettati per essere utilizzati in ambienti più difficili, come l`esterno, dove i manuali pinzati o cuciti a sella cadrebbero a pezzi. Alcuni manuali con rilegatura a spirale hanno pagine laminate per evitare che si rompano se il manuale si bagna o si sporca. 
Gli elaboratori di testi e i programmi di desktop publishing offrono anche la possibilità di creare "stili", caratteri predefiniti e formati per intestazioni, piè di pagina, intestazioni e testo normale. Puoi scegliere uno dei nomi degli stili preimpostati (ad es. `Testa1`, `Normale`, `Citazione`) o creare uno stile personalizzato con il proprio nome. Cerca di seguire il più possibile le convenzioni dei nomi di stile esistenti, se usi più stili per la stessa classe di testo. (Ad esempio, Microsoft Word etichetta gli stili di testo delle intestazioni come "Intestazione1", "Intestazione2" ecc., dal titolo principale ai diversi livelli delle sottovoci.) Prova a pre-creare tutti gli stili in modo da non dover interrompere il processo di scrittura per crearli di nuovo.
Crea una guida
Contenuto
I manuali utente sono documenti cartacei o elettronici (PDF o XPS) con istruzioni su come eseguire o utilizzare qualcosa. Sebbene i manuali utente siano spesso considerati manuali software, molto spesso sono anche inclusi in computer e altri dispositivi elettronici come televisori, stereo, sistemi telefonici e lettori MP3, nonché elettrodomestici e attrezzature da giardino. I buoni manuali per l`utente informano gli utenti sulle caratteristiche di un prodotto e su come utilizzarle in modo efficace e sono organizzati in modo da essere di facile lettura e riferimento. Di seguito sono riportati alcuni aspetti da considerare durante la creazione di contenuti efficaci e la progettazione del layout di una guida per l`utente.
Passi
Parte 1 di 3: Creazione di documentazione utile per l`utente

1. Definisci l`utente. Per scrivere una guida per l`utente di successo, devi sviluppare un profilo del tuo utente, formalmente creando un profilo scritto o informalmente, prendendo il tempo per fare ipotesi ragionevoli sulle caratteristiche del tuo utente. Tale profilo è utile quando fai parte di un team che scrive la documentazione per l`utente e può essere utile anche durante lo sviluppo del prodotto dall`ideazione alla forma finale. Le cose da considerare quando si sviluppa un profilo utente includono:
- Dove l`utente utilizzerà il manuale, ad esempio a casa, in ufficio, in un cantiere edile remoto o in macchina. Questo può determinare non solo il contenuto, ma anche lo stile del manuale utente.
- Come gli utenti utilizzeranno il manuale. Se il manuale sarà consultato solo raramente o se ha solo scopo informativo, dovrebbe assumere principalmente la forma di un documento di riferimento. Se è qualcosa a cui gli utenti faranno spesso riferimento all`inizio, la sezione di riferimento dovrebbe essere accompagnata da a "Lavorare"-sezione e le istruzioni sulle attività più comuni per le quali verrà utilizzato il prodotto.
- Quanti utenti hanno esperienza con il prodotto o cosa apprezzano gli altri. Se il tuo prodotto è nuovo o molto diverso da prodotti simili, dovresti includere una spiegazione di quanto sia diverso da altri prodotti e istruzioni su come iniziare. Se il prodotto ha funzionalità con cui altri utenti hanno spesso problemi, come varie applicazioni per computer, è necessario fornire informazioni e dettagli appropriati in modo comprensibile.

2. Quando scrivi, concentrati sui bisogni dell`utente, in un modo che l`utente possa capire. A meno che l`utente non abbia un background tecnico, è probabilmente meglio evitare un linguaggio altamente tecnico e optare per una spiegazione chiara e semplice. Il testo dovrebbe anche essere organizzato in modo da imitare la mentalità dell`utente; creare un elenco di funzionalità del prodotto raggruppate per funzionalità spesso ha più senso che raggruppare le funzionalità più utilizzate.

3. Spiegare il problema che l`utente sta cercando di risolvere, quindi presentare la soluzione. Offrire una funzione come soluzione a un problema comune funziona benissimo con un prodotto commerciale, ma una volta che l`utente ha il prodotto, vuole scoprire come usarlo. Indicare problemi specifici che l`utente potrebbe incontrare, indicarli nel manuale utente e seguire le istruzioni per risolverli.
Parte 2 di 3: parti di un manuale utente

1. Aggiungi le pagine del fronte e del titolo appropriate. Avrai bisogno di una copertina per qualsiasi manuale che sia più di una scheda di riferimento e un frontespizio per un manuale che contiene più informazioni di un foglio di carta piegato (quattro o più pagine).
- Se il manuale è protetto da copyright, inserire un avviso di copyright sia sulla copertina anteriore che sul frontespizio.
- Se ci sono condizioni allegate all`uso del manuale e del prodotto corrispondente, si prega di metterle all`interno della copertina anteriore.

2. Inserisci i riferimenti ai documenti correlati nella prefazione. Se la documentazione per l`utente è composta da più di un manuale, fare riferimento agli altri documenti qui, con i numeri di versione corretti. La prefazione è anche il luogo dove una possibile sezione "Come utilizzare questa guida" arriva.

3. Includere un sommario se il manuale è composto da più di 10 pagine.

4. Mettere le istruzioni/procedure e il materiale di riferimento al centro del manuale. Nella maggior parte dei casi, tutte le procedure e i materiali di riferimento hanno le proprie sezioni, ma puoi indirizzare l`utente a contenuti specifici da una sezione all`altra. In questo modo, l`utente può trovare più velocemente le informazioni che sta cercando.

5. Se necessario, utilizzare le immagini per supportare il testo. La grafica o gli screenshot possono illustrare meglio alcuni punti del manuale rispetto al testo, specialmente in procedure complesse in cui l`utente ha bisogno di una conferma visiva che i passaggi siano stati eseguiti correttamente. La grafica può essere prodotta utilizzando software di progettazione o software di grafica, fotocamere digitali e software di fotoritocco o, nel caso di schermate, catturata utilizzando la capacità di cattura dello schermo del PC o un programma di grafica.
Parte 3 di 3: progettare una guida per l`utente leggibile

1. Scegli dei caratteri leggibili. Sebbene i computer possano supportare diversi tipi di carattere, lo scopo di una guida per l`utente è di essere di facile lettura. Scegliere solo un numero limitato di caratteri che si adattano bene insieme è il modo migliore per raggiungere questo obiettivo. I caratteri possono essere suddivisi in 2 tipi: serif (serif) e sans serif (sans serif).
- I caratteri Serif presentano piccoli abbellimenti alle estremità delle linee principali che compongono la lettera. I caratteri Serif includono caratteri come Times New Roman, Baskerville e Book Antiqua. I caratteri Serif sono più adatti per grandi porzioni di testo con dimensioni da 10 a 12 nel corpo principale di un manuale stampato.
- I caratteri sans serif mostrano solo le linee che compongono le lettere, senza abbellimenti. I caratteri sans serif includono caratteri come Arial, Calibri e Century Gothic. I caratteri sans serif possono essere utilizzati per grandi porzioni di testo di dimensioni comprese tra 8 e 10 punti in un PDF o un manuale online, sebbene la mancanza di sans serif visualizzati in 12 punti o più ne renda più difficile la lettura. Tuttavia, possono essere efficaci in dimensioni maggiori per la visualizzazione di titoli e intestazioni, e sono ottime anche in dimensioni più piccole per note a piè di pagina e numeri nelle colonne e nelle tabelle.
- In generale, usa caratteri normali come Arial o Times New Roman per il tuo manuale utente, anche se puoi usare un carattere decorativo per citazioni o titoli importanti, quando scrivi un manuale per un gioco fantasy o di fantascienza. (Nel caso di citazioni che attirano l`attenzione, puoi spesso utilizzare uno dei caratteri semplici e la citazione che attira l`attenzione è in corsivo.)
- Dopo aver scelto alcuni caratteri da utilizzare, crea una pagina di esempio su carta per verificare se i caratteri corrispondono bene. Ti consigliamo inoltre di mostrare questo esempio a chi deve approvare il manuale prima di continuare a scriverlo.

2. Presta attenzione alla disposizione. Una volta scelto uno dei caratteri del manuale, dovrai decidere dove mettere tutto nelle pagine.

3. Pensa al tipo di rilegatura per il manuale utente. Se la tua guida per l`utente è composta da più di 4 pagine, le pagine devono essere rilegate insieme in qualche modo. Mentre una graffetta nell`angolo può essere sufficiente per i documenti interni, le guide per l`utente esterne fornite con un prodotto sono generalmente rilegate in 3 modi:

4. Crea un documento modello per il tuo manuale. Molti programmi di elaborazione testi e desktop publishing ti consentono di creare un modello di documento per il tuo manuale utente in modo che durante la digitazione, il testo appaia automaticamente nel carattere che hai selezionato per la parte del manuale su cui stai lavorando. (In effetti, questo articolo è stato inizialmente scritto utilizzando un modello di Microsoft Word.) La maggior parte di questi programmi include anche una raccolta di modelli predefiniti che puoi personalizzare in base alle tue esigenze, invece di creare il modello da zero.
Consigli
- Ove possibile, utilizzare codici di campo o variabili di testo. Puoi assegnare valori ai codici di campo, come il nome di un prodotto, il manuale o il titolo di un capitolo, e inserirli all`interno del tuo documento, al posto del testo da citare. Quando si visualizza in anteprima o si stampa il manuale, la variabile viene sostituita dal testo. Se si cambia il nome del prodotto o si cambia il nome del manuale o di un capitolo, è più facile modificare le informazioni regolando il valore della variabile di testo piuttosto che cercando e sostituendo.
Necessità
- Programma di elaborazione testi o dtp
- Software grafico o programma di registrazione dello schermo
Articoli sull'argomento "Crea una guida"
Condividi sui social network:
Popolare