Contenuto

• Al passo
• Parte 1 di 4: pianificazione del manuale del proprietario
• Parte 2 di 4: incorporare le informazioni essenziali
• Parte 3 di 4: descrizione della manutenzione del prodotto
• Parte 4 di 4: scrivi un manuale leggibile
• Suggerimenti

Software, computer, giochi e dispositivi richiedono manuali utente; guide che spiegano come utilizzare il prodotto (e come non farlo). Un manuale utente è un documento formale con una struttura specifica e deve essere scritto da qualcuno che conosce il prodotto alla perfezione, come uno scrittore tecnico o il progettista del prodotto. La scrittura di un manuale utente efficace richiede che tu sappia chi utilizzerà il prodotto e che tu scriva il manuale tenendo a mente questi utenti. Mantieni la tua scrittura chiara, precisa e semplice per garantire un'esperienza utente senza problemi.

Al passo

Parte 1 di 4: pianificazione del manuale del proprietario

1. Fai un'analisi degli utenti. Il manuale dell'utente dovrebbe essere scritto per gli utenti, coloro che acquisteranno il tuo prodotto o servizio e leggeranno il manuale dell'utente. Un'analisi dell'utente ti dirà quale sarà il tuo pubblico principale o di destinazione e ti guiderà nella scrittura del testo.
   • Parla con le persone che useranno il tuo dispositivo. Offrire agli utenti di test prototipi del dispositivo e bozza del manuale utente in condizioni controllate. Chiedi a questi utenti di prova un feedback su cose che non sono chiare o confuse nella guida dell'utente e apporta modifiche alla guida dell'utente in base a questo feedback.
   • Non puoi mai soddisfare il tuo intero pubblico; scrivere il manuale su misura per il pubblico di destinazione o il pubblico più vasto.
   • Considera l'età, la salute (hanno malattie, difficoltà di apprendimento o disabilità?) E il livello di istruzione del pubblico per determinare l'approccio migliore per scrivere il manuale utente.
2. Coordinare il design del manuale utente. Se facevi parte del team che ha contribuito a progettare e sviluppare il dispositivo o il prodotto, può essere difficile dare uno sguardo obiettivo al prodotto per spiegare come funziona. Dovresti quindi chiedere il consiglio di uno scrittore (preferibilmente qualcuno con esperienza nella scrittura di istruzioni) e di un grafico per aiutarti a preparare il manuale utente. Potresti scegliere queste persone attraverso una consulenza esterna o dalla tua azienda o organizzazione.
3. Fai un'analisi del compito. L'analisi del lavoro è il processo di identificazione e organizzazione dei passaggi necessari per utilizzare il dispositivo. Un'analisi approfondita del lavoro identifica i materiali e le attrezzature (come batterie, medicinali o altri prodotti forniti dall'utente) necessari per ciascuna fase, nonché le azioni, gli errori e i consigli per la risoluzione dei problemi che ogni fase potrebbe richiedere.
   • Se si dispone di un prodotto in grado di eseguire molte attività o attività secondarie diverse, è necessario eseguire un'analisi delle attività per ciascuna attività. Ad esempio: in un'auto puoi suonare il clacson, allacciarti la cintura e accendere o spegnere i fari. Fai un'analisi del lavoro per ciascuno di questi, se necessario.
4. Assicurati che il tuo prodotto soddisfi i requisiti per l'etichettatura e l'autorizzazione all'immissione in commercio. Questi requisiti garantiscono che i prodotti siano fabbricati tenendo presente la sicurezza dell'utente e che l'esposizione dell'utente a condizioni pericolose, come radiazioni ed elettrocuzione, sia limitata. Gli annunci devono indicare chiaramente lo scopo e le linee guida operative di base di un prodotto e dovresti utilizzare queste risorse quando scrivi il manuale del proprietario.
   • Affinché il manuale utente di un prodotto sia efficace, deve essere scritto in conformità con le etichette apposte direttamente sul prodotto.
   • Assicurati che il tuo dispositivo abbia la licenza ufficiale per la vendita prima di scrivere il manuale dell'utente.
5. Decidi il layout del tuo manuale. Esistono diversi modi importanti per semplificare il manuale. È necessario inserire un'intestazione in grassetto all'inizio di ogni sezione con ogni parola in lettere maiuscole. Ad esempio, "Configura il tuo dispositivo", "Utilizza il tuo dispositivo" e "Risoluzione dei problemi" possono essere tutti titoli delle sezioni in grassetto.
   • Un altro modo per semplificare la guida è utilizzare due colonne, una a destra con il testo e l'altra appena a sinistra del testo, con punti elenco, numeri o piccole icone, come segni di avvertenza o punti esclamativi rossi.
   • Il manuale può consistere principalmente di immagini con del testo sotto ogni immagine per spiegare il dispositivo, oppure può essere principalmente testo con solo poche immagini di accompagnamento. È inoltre possibile utilizzare un diagramma di flusso per guidare l'utente. Pensa al tuo prodotto e a come ogni metodo può aiutarti a scrivere il tuo manuale. Tuttavia, evitare di mescolare layout diversi all'interno di un manuale. Scegline uno e resta fedele.

Parte 2 di 4: incorporare le informazioni essenziali

1. Organizza il manuale in modo logico. Il manuale dovrebbe essere strutturato in modo tale che l'utente possa trarne il massimo beneficio. Dividere il manuale in capitoli o sezioni che hanno senso per l'utilizzo del prodotto e includere un sommario all'inizio del manuale in modo che ogni sezione possa essere trovata rapidamente.
   • Un sommario è particolarmente necessario per i manuali più lunghi.
   • Un glossario o un indice è necessario se ci sono molti termini per spiegare che il tuo pubblico potrebbe non avere familiarità. Tuttavia, un glossario non è consigliato; la scelta migliore è spiegare i termini confusi nel testo del manuale stesso. Se scegli di includere un glossario, posizionalo all'inizio del manuale, subito dopo il sommario.
   • Un elenco di tabelle o figure è necessario solo se il manuale contiene più di poche tabelle o figure.
   • È necessaria un'appendice per le cose che devono essere spiegate ma che non possono essere spiegate altrove nel manuale, poiché interromperebbe il flusso e la messa a fuoco.
2. Includere gli avvertimenti necessari. Le avvertenze generali o le informazioni precauzionali dovrebbero fornire informazioni sui potenziali pericoli causati da un uso improprio del prodotto, inclusi morte o lesioni gravi. Questi avvisi dovrebbero essere posti all'inizio del manuale, dopo la prima pagina, in modo che l'utente li veda per primo. Avvertenze specifiche dovrebbero essere incluse nel testo del manuale subito dopo o subito prima che venga suggerita una fase potenzialmente pericolosa.
   • Ad esempio, un'avvertenza generale per un elettrodomestico potrebbe essere di non utilizzarlo quando piove.
   • Un'istruzione specifica potrebbe essere quella di assicurarsi che entrambe le mani e il dispositivo siano asciutti prima di collegare il dispositivo alla presa di corrente.
   • Fornire immagini (come un teschio e ossa incrociate) o un testo di un colore diverso (come il testo rosso) per distinguere l'avvertimento dal resto delle istruzioni nelle istruzioni per l'uso e attirare l'attenzione degli utenti su di esso.
3. Descrivi il dispositivo. La descrizione dovrebbe includere sia una spiegazione scritta dello scopo del dispositivo sia una piccola rappresentazione grafica dell'aspetto del dispositivo. La figura dovrebbe etichettare e nominare tutti gli interruttori, pulsanti e parti collegabili contenuti nel dispositivo.
4. Fornire istruzioni per l'installazione. La sezione relativa all'installazione dovrebbe contenere le informazioni di base su come prepararsi all'uso del prodotto o del dispositivo. Se l'elettrodomestico non può essere costruito o configurato da un utente domestico, indicarlo chiaramente in un titolo in grassetto nella parte superiore della sezione di installazione. Dovresti anche includere quanto segue:
   • Un elenco delle parti
   • Istruzioni per il disimballaggio
   • Avvertenze per l'installazione
   • Conseguenze di un'installazione errata
   • Chi chiamare in caso di difficoltà durante l'installazione
5. Fornire informazioni sull'operazione. Questa sezione è la parte più importante del manuale dell'utente e dovrebbe fornire informazioni concrete e dettagliate su come utilizzare il dispositivo. Inizia con la preparazione di base per l'utilizzo dell'unità, come collegare il cavo di alimentazione o lavarsi le mani. Continua con i passaggi logici e numerati che descrivono come utilizzare il dispositivo, oltre a qualsiasi feedback (ad esempio, "Sentirai un clic ...") che l'utente può aspettarsi quando utilizza il dispositivo correttamente.
   • Alla fine di questo capitolo, gli utenti dovrebbero fare riferimento al capitolo sulla risoluzione dei problemi per risolvere i problemi che non possono essere spiegati rapidamente.
   • Posiziona le immagini dove necessario. Alcuni passaggi vengono spiegati al meglio sia con immagini che con parole. Considera l'uso di foto o illustrazioni nel tuo manuale.
   • In questa sezione, come in qualsiasi sezione, è necessario includere avvisi di sicurezza pertinenti sull'uso o il funzionamento improprio. Ad esempio, potresti avvertire gli utenti di motoseghe di non bere alcolici o di usare la motosega mentre assumono determinati farmaci.
   • Se ritieni che gli utenti ne trarranno vantaggio, valuta la possibilità di includere collegamenti a video online che dimostrino il corretto utilizzo e funzionamento del dispositivo. È possibile registrare questi video all'inizio di questa sezione o (nel caso di video che illustrano solo un passaggio) alla fine di ogni passaggio.
6. Includere un riepilogo del prodotto alla fine. Il riepilogo dovrebbe apparire alla fine del manuale, subito prima dell'indice, per fornire i passaggi operativi di base. Questa dovrebbe essere una versione semplificata e ridotta delle informazioni operative e non dovrebbe essere più di una pagina. Riassumi come deve essere utilizzato il dispositivo o il prodotto. Includere avvisi di base, passaggi numerati che spiegano come utilizzare il prodotto e numeri di telefono o indirizzi e-mail che invitano gli utenti ad aiutare.
   • Se ti aspetti che l'utente rimuova o faccia spesso riferimento al foglio di riepilogo, puoi stamparlo su una carta laminata rimovibile o su un cartone spesso per facilitare il trasporto e il riferimento da parte dell'utente.
   • In alternativa, è possibile applicare un riepilogo direttamente al prodotto per un rapido e facile riferimento da parte dell'utente.

Parte 3 di 4: descrizione della manutenzione del prodotto

1. Spiega come pulire il dispositivo. Se il tuo dispositivo o prodotto necessita di pulizia, spiega come farlo. Elencare gli agenti detergenti necessari. Spiega al lettore quanto spesso pulire. Quindi, come in qualsiasi altra parte del manuale, includi istruzioni numerate passo passo su come pulirlo.
   • Se la pulizia richiede lo smontaggio del prodotto o la rimozione di una o più parti particolari, indicare come smontare il prodotto.
   • Fornire un avviso sui risultati della mancata pulizia del dispositivo. Ad esempio, potresti dire: "Se il dispositivo non viene pulito, le prestazioni saranno meno che ottimali".
2. Contare l'utente su come eseguire la manutenzione di base. Se il prodotto o il dispositivo può essere riparato dall'utente per correggere i problemi di prestazioni, fornire istruzioni numerate su come farlo per l'utente. Ad esempio, se le batterie devono essere sostituite ogni 300 ore di utilizzo, fornire istruzioni su come verificare se le batterie devono essere sostituite, come rimuovere le batterie scariche e come installare quelle nuove.
   • Se ci sono alcune attività di manutenzione che possono essere eseguite solo da un tecnico certificato, dividere la parte relativa alla manutenzione del manuale in due parti.
3. Discuti le opzioni di archiviazione. Se necessario, il manuale dovrebbe spiegare come conservare correttamente il prodotto o il dispositivo. dovresti anche includere informazioni sul motivo per cui la conservazione è necessaria e sulle conseguenze di una conservazione impropria. Ad esempio: potresti scrivere:
   • Conservare il prodotto in un luogo fresco e asciutto. Una conservazione impropria può ridurre la durata del prodotto a causa dell'accumulo di umidità. "
   • "Non esporre il prodotto a fonti di calore né conservarlo a temperature superiori a 50 gradi Celsius.Se lo fai, può portare alla combustione. "
4. Fornire informazioni sulla risoluzione dei problemi. È possibile organizzare questa sezione come un elenco di problemi comuni e delle relative soluzioni. Raggruppa problemi simili sotto un'intestazione logica. In questo modo, gli utenti possono trovare rapidamente problemi specifici.
   • Ad esempio, se si verificano diversi problemi con il computer che visualizza una schermata blu, raggrupparli in un sottotitolo, ad esempio "Problemi comuni dello schermo".
   • È inoltre necessario includere un numero di telefono e / o un'e-mail per il servizio clienti in questa sezione.

Parte 4 di 4: scrivi un manuale leggibile

1. Leggi altre guide per l'utente. Prima di scrivere un manuale per il tuo prodotto, consulta altre efficaci guide per l'utente. Presta attenzione alla struttura, alla scelta delle parole e alla struttura delle frasi. I principali marchi come Apple, Google e Microsoft producono guide per l'utente forti ed efficaci che possono aiutarti a produrre una guida per l'utente scritta in modo più ponderato.
   • Non limitarti a leggere tutti manuali utente. Leggi i manuali di prodotti simili che vendi. Ad esempio, se vendi prodotti per bambini, leggi i manuali per bambini, non quelli tecnici.
2. Seleziona i tuoi standard. La standardizzazione dell'ortografia, della scelta delle parole e della formulazione renderà il manuale dell'utente più intuitivo. Anche il Manuale di stile di Chicago e il Manuale di stile di Microsoft possono essere utili guide di stile quando si scrive il manuale del proprietario; controlla entrambi per vedere se uno è adatto al tuo manuale.
   • Ad esempio, invece di utilizzare sia "interruttore di alimentazione" che "pulsante di accensione" nel manuale, scegli uno dei due termini e rispettalo.
3. Usa la voce attiva. La voce attiva è un modo di scrivere che spiega le cose dal punto di vista dell'utente. È più facile da capire dell'alternativa, la voce passiva, in cui il soggetto è indefinito.
   • Prova l'app Hemingway (www.hemmingwayapp.com) per identificare i passaggi passivi nella tua scrittura.
   • Studia queste due frasi di esempio: la prima è attiva e la seconda è passiva:
     • Devi aprire la confezione lentamente e con attenzione.
     • La confezione deve essere aperta lentamente e con attenzione.
4. Scrivi istruzioni numerate. Le istruzioni ordinate numericamente aiutano il lettore a concentrarsi meglio sul processo di utilizzo, collegamento o costruzione del prodotto in questione. Invece di scrivere un paragrafo lungo e dettagliato o una serie di paragrafi non numerati, scrivi la tua guida per l'utente con passaggi semplici ed espliciti, ciascuno chiaramente numerato.
5. Inizia ogni passaggio con un imperativo. Un imperativo è un verbo orientato all'azione. Iniziando ogni passaggio con un verbo, dai al lettore un suggerimento sull'azione richiesta per completare il passaggio. Ad esempio, a seconda del prodotto di cui stai scrivendo, puoi iniziare i tuoi passaggi con un comando come "Connetti", "Conferma" o "Scorri". Tuttavia, non iniziare i tuoi passaggi con una risposta dal sistema.
   • Ad esempio, se lo schermo diventa blu e inizia a lampeggiare, non avviare il passaggio con: "Lo schermo lampeggerà e diventerà blu." Prova: "Tieni premuto il tasto Home. Lo schermo lampeggerà e diventerà blu. "
6. Determina quale vocabolario userai. Se stai scrivendo un manuale di yo-yo, il tuo pubblico sarà per lo più bambini piccoli. Usa parole semplici e vocabolario per spiegare come funziona lo yo-yo. Quando scrivi un manuale del microscopio elettronico a scansione, il tuo pubblico è composto da scienziati altamente qualificati in grado di comprendere informazioni molto dettagliate, quindi non esitare a utilizzare un vocabolario specializzato o spiegazioni sfumate.
   • In generale, cerchi di evitare il gergo e il linguaggio tecnico.
   • Per essere efficace per la più ampia base di utenti possibile, prova a scrivere a un livello dal sesto al settimo anno della scuola primaria.
7. Quando spedisci un prodotto all'estero, assicurati che le tue traduzioni siano accurate. Assumi un traduttore per tradurre il tuo manuale utente nella lingua madre del paese in cui stai spedendo il tuo prodotto. Puoi anche utilizzare un programma di traduzione online, ma chiedi a un madrelingua di leggere la traduzione e verificare la presenza di errori.
   • Se nel tuo pubblico sono rappresentati più gruppi linguistici, includi le traduzioni del manuale dell'utente in ciascuna lingua pertinente.
   • Il traduttore deve avere familiarità con il prodotto in quanto potrebbero esserci parole diverse nella lingua di destinazione per termini specifici che non sono traduzioni parola per parola.
8. Scrivi frasi brevi. Invece di pochi paragrafi lunghi, usi molti paragrafi brevi. Cerca interruzioni logiche in ogni sezione e digita le informazioni utili in blocchi di una o due frasi. Lo stesso vale a livello di frase. Mantieni le tue frasi brevi e semplici, piuttosto che lunghe e prolisse.
   • Se un passaggio diventa troppo lungo, suddividilo in passaggi più piccoli. Ciò non ridurrà il conteggio delle parole, ma le interruzioni di riga renderanno più facile la lettura.
9. Verificare la presenza di errori nel manuale. Un manuale può perdere credibilità a causa di errori grammaticali e di ortografia. Chiedi a un collega o ad uno scrittore tecnico di modificare e correggere anche il manuale. Oltre all'ortografia e alla grammatica, un correttore di bozze dovrebbe prestare attenzione a quanto segue:
   • Voce passiva
   • Linguaggio poco chiaro o confuso
   • Struttura della frase racchiusa
   • Paragrafi eccessivamente lunghi

Suggerimenti

• Le persone imparano in modi diversi; Se possibile e appropriato, includere ausili visivi o collegamenti a video online nel manuale per accogliere lettori orientati alla vista.