Istruzioni passo passo gratis 
Se si dispone di un prodotto in grado di eseguire molte attività o sottoattività diverse, è necessario eseguire un`analisi delle attività per ciascuna attività. Ad esempio: in macchina puoi suonare il clacson, allacciarti la cintura e accendere o spegnere i fari. Crea un`analisi del lavoro per ciascuno di questi, se necessario. 
Affinché il manuale utente di un prodotto sia efficace, deve essere scritto in conformità con le etichette apposte direttamente sul prodotto. Prima di scrivere il manuale utente, assicurati che il tuo dispositivo disponga di licenze ufficiali in vendita. 
Un altro modo per semplificare il manuale è 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 segnali di avvertimento o punti esclamativi rossi. Il manuale può essere composto principalmente da immagini con del testo sotto ogni immagine per spiegare il dispositivo, oppure può essere composto principalmente da testo con solo alcune 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, evita di mescolare layout diversi all`interno di un manuale. Scegline uno e mantienilo. 
Ad esempio, un avvertimento generale per un elettrodomestico potrebbe essere quello di non utilizzarlo durante la pioggia. Un suggerimento specifico potrebbe essere quello di assicurarsi che le mani e il dispositivo siano asciutti prima di collegare il dispositivo. Fornire immagini (come un teschio e ossa incrociate) o testo di un colore diverso (come testo rosso) per distinguere l`avviso dal resto delle istruzioni nel manuale e attirare l`attenzione degli utenti su di esso. 
Un elenco di parti Istruzioni per il disimballaggio Avvisi di installazione Conseguenze di un`installazione errata Chi chiamare in caso di difficoltà di installazione 
Alla fine di questo capitolo, gli utenti dovrebbero essere indirizzati al capitolo sulla risoluzione dei problemi, per risolvere problemi che non possono essere spiegati rapidamente. Posta immagini dove necessario. Alcuni passaggi sono meglio spiegati con immagini e parole. Pensa di usare foto o illustrazioni nel tuo manuale. In questa parte, come in qualsiasi altra parte, è necessario includere avvertenze di sicurezza pertinenti sull`uso o il funzionamento impropri. Ad esempio, potresti avvertire gli utenti della motosega di non bere alcolici o di usare la motosega durante l`assunzione di determinati farmaci. Se ritieni che possa avvantaggiare gli utenti, considera l`inclusione di collegamenti a video online che dimostrino l`uso e il funzionamento corretti del dispositivo. Puoi includere questi video all`inizio di questa sezione o (nel caso di video che illustrano solo un passaggio) alla fine di ogni passaggio. 
Se si prevede che l`utente rimuova il foglio riepilogativo o sia necessario consultarlo frequentemente, è possibile stamparlo su una scheda laminata rimovibile o su un cartone spesso per facilitare il trasporto e la consultazione da parte dell`utente. In alternativa, puoi inserire un riepilogo direttamente sul prodotto per una rapida e facile consultazione per l`utente. 
Se ci sono alcune attività di manutenzione che possono essere eseguite solo da un tecnico certificato, dividere la sezione di manutenzione del manuale in due parti. 
`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 al calore e non conservarlo a temperature superiori a 50 gradi Celsius. Se lo fai, può portare all`accensione.` 
Ad esempio, se si verificano diversi problemi con il computer che mostra una schermata blu, raggrupparli in un sottotitolo, ad esempio "Problemi comuni dello schermo". È necessario includere anche un numero di telefono del servizio clienti e/o un`e-mail in questa sezione. 
Ad esempio, invece di utilizzare sia "interruttore on/off" che "pulsante on/off" nel manuale, scegli uno dei due termini e attieniti ad esso. 
Prova l`app Hemingway (www.hemmingwayapp.com) per riconoscere i passaggi passivi nella tua scrittura. Studia queste due frasi campione: la prima è attiva e la seconda passiva: Devi aprire la confezione lentamente e con attenzione. La confezione deve essere aperta lentamente e con attenzione. 
Ad esempio, se lo schermo diventa blu e inizia a lampeggiare, non avviare il passaggio con "Lo schermo lampeggia e diventa blu.` Prova: `Premi e tieni premuto il tasto Home. Lo schermo lampeggerà e diventerà blu.` 
In generale, cerca di evitare il gergo e il linguaggio tecnico. Per essere efficace per la base di utenti più ampia possibile, prova a scrivere a un livello dal sesto al settimo anno. 
Se nel tuo pubblico sono rappresentati più gruppi linguistici, includi le traduzioni del manuale dell`utente in ciascuna lingua pertinente. Il traduttore dovrebbe avere familiarità con il prodotto poiché potrebbero esserci altre parole nella lingua di destinazione per termini specifici che non sono traduzioni parola per parola. 
Se un passaggio inizia a diventare troppo lungo, scomponilo in passaggi più piccoli. Questo non ridurrà il conteggio delle parole, ma le interruzioni di riga renderanno più facile la lettura. 
Voce passiva Linguaggio poco chiaro o confuso struttura della frase avvolta Paragrafi eccessivamente lunghi
Scrivere una guida per l'utente
Contenuto
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 dovrebbe essere scritto da qualcuno che conosce il prodotto fino in fondo, come un redattore tecnico o il designer del prodotto. La scrittura di un manuale utente efficace richiede che tu sappia chi utilizzerà il prodotto e che tu scriva il manuale pensando a questi utenti. Mantieni la tua scrittura chiara, precisa e semplice per garantire un`esperienza utente senza problemi.
Passi
Parte 1 di 4: Pianificazione della guida per l`utente
1. Fai un`analisi dell`utente. La guida per l`utente dovrebbe essere scritta per gli utenti, coloro che acquisteranno il tuo prodotto o servizio e leggeranno la guida per l`utente. Un`analisi dell`utente ti dirà chi sarà il tuo pubblico principale o di destinazione e ti guiderà nella scrittura del testo.
- Parla con le persone che utilizzeranno il tuo dispositivo. Fornire agli utenti di test i prototipi del dispositivo e una bozza del manuale utente in condizioni controllate. Chiedi a questi utenti di test un feedback su cose che non sono chiare o confuse nella guida per l`utente e apporta modifiche alla guida per l`utente in base a questo feedback.
- Non puoi mai accontentare tutto il tuo pubblico; scrivere il manuale su misura per il pubblico di destinazione o il pubblico più vasto.
- Pensa all`età, alla salute (hanno malattie, difficoltà di apprendimento o disabilità??) e il livello di istruzione del pubblico, per determinare l`approccio migliore per la stesura del manuale dell`utente.
2. Coordinare la progettazione del manuale utente. Se facevi parte del team che ha aiutato a progettare e sviluppare il dispositivo o il prodotto, può essere difficile guardare obiettivamente al prodotto per spiegare come funziona. Dovresti quindi chiedere consiglio a uno scrittore (preferibilmente qualcuno con esperienza nella scrittura di istruzioni) e un grafico per aiutarti a preparare il manuale utente. Potresti scegliere queste persone attraverso una consulenza esterna o dalla tua stessa azienda o organizzazione.
3. Fai un`analisi del lavoro. Un`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 apparecchiature (come batterie, farmaci o altri prodotti forniti dall`utente) necessari per ogni passaggio, nonché le azioni, gli errori e i consigli per la risoluzione dei problemi che ogni passaggio potrebbe richiedere.
4. Assicurati che il tuo prodotto soddisfi i requisiti di etichettatura e autorizzazione all`immissione in commercio. Questi requisiti garantiscono che i prodotti siano fabbricati tenendo conto della sicurezza dell`utente e che l`esposizione dell`utente a condizioni pericolose, come radiazioni ed elettrocuzione, sia limitata. Gli annunci pubblicitari dovrebbero indicare chiaramente lo scopo e le linee guida operative di base di un prodotto e dovresti utilizzare queste risorse quando scrivi la tua guida per l`utente.
5. Decidi il layout del tuo manuale. Esistono diversi modi importanti per semplificare il manuale. Devi inserire un`intestazione in grassetto all`inizio di ogni sezione con ogni parola in maiuscolo. Ad esempio, "Configura il tuo dispositivo", "Controlla il tuo dispositivo" e "Risoluzione dei problemi" possono essere tutti titoli di sezione in grassetto.
Parte 2 di 4: Incorporamento di informazioni essenziali
1. Organizza il manuale in modo logico. Il manuale dovrebbe essere strutturato in modo tale che l`utente ne tragga il massimo beneficio. Dividi il manuale in capitoli o sezioni che hanno senso per l`uso del prodotto e includi un sommario nella parte anteriore del manuale in modo che ogni sezione possa essere trovata rapidamente.
- Un sommario è particolarmente necessario per le guide più lunghe.
- Un glossario o un indice è necessario se ci sono molti termini per spiegare che il tuo pubblico potrebbe non conoscere. Tuttavia, un glossario non è raccomandato; la scelta migliore è spiegare i termini confusi nel testo del manuale stesso. Se scegli di includere un glossario, mettilo all`inizio del manuale, subito dopo il sommario.
- Un elenco di tabelle o figure è necessario solo se nel manuale sono presenti più tabelle o figure.
- È necessaria un`appendice per le cose che devono essere spiegate ma non possono essere spiegate altrove nel manuale, poiché interromperebbe il flusso e la messa a fuoco.
2. Includere gli avvisi necessari. Le avvertenze generali o le informazioni precauzionali devono fornire informazioni sui potenziali pericoli che possono derivare da un uso improprio del prodotto, inclusi morte o lesioni gravi. Queste avvertenze dovrebbero essere collocate all`inizio del manuale, dopo la prima pagina, in modo che l`utente le veda per prima. Avvertenze specifiche dovrebbero anche essere incluse nel testo del manuale subito dopo o subito prima che venga suggerito un passaggio potenzialmente pericoloso.
3. Descrivi il dispositivo. La tua descrizione dovrebbe includere sia una spiegazione scritta dello scopo del dispositivo sia una piccola rappresentazione grafica dell`aspetto del dispositivo. L`illustrazione dovrebbe etichettare e nominare tutti gli interruttori, i pulsanti e le parti collegabili contenuti nel dispositivo.
4. Fornire istruzioni per l`installazione. La sezione relativa all`installazione deve contenere le informazioni di base su come prepararsi all`uso del prodotto o del dispositivo. Se il dispositivo non può essere costruito o configurato da un utente domestico, indicarlo chiaramente in un`intestazione in grassetto nella parte superiore della sezione di installazione. Dovresti anche includere quanto segue:
5. Fornire informazioni sull`operazione. Questa sezione è la parte più importante del manuale utente e dovrebbe fornire informazioni concrete e dettagliate su come utilizzare il dispositivo. Inizia con la preparazione di base prima di utilizzare l`apparecchio, come collegare la spina o lavarti le mani. Procedi con passaggi logici e numerati che descrivono come utilizzare il dispositivo, oltre al feedback (ad esempio, "Si sente un clic...`) che l`utente può aspettarsi quando utilizza correttamente il dispositivo.
6. Aggiungi un riepilogo del prodotto alla fine. Il riassunto dovrebbe arrivare alla fine del manuale, poco prima dell`indice, per dare i passaggi fondamentali del funzionamento. Questa dovrebbe essere una versione semplificata e ridotta delle informazioni operative e non dovrebbe superare una pagina. Riepiloga come utilizzare 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 indirizzano gli utenti ad aiutare.
Parte 3 di 4: Descrivere la manutenzione del prodotto
1. Spiega come pulire il dispositivo. Se il tuo dispositivo o prodotto deve essere pulito, spiega come farlo. Elenca i detergenti necessari. Spiega al lettore quanto spesso pulire. Quindi, come in qualsiasi altra parte del manuale, includi istruzioni dettagliate e numerate su come pulire.
- Se la pulizia richiede lo smontaggio del prodotto o la rimozione di una o più parti, 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 non saranno ottimali.`
2. Conta l`utente come eseguire la manutenzione di base. Se l`utente può riparare il prodotto o il dispositivo per correggere problemi di prestazioni, fornire istruzioni numerate su come farlo dall`utente. Ad esempio: se è necessario sostituire le batterie dopo ogni 300 ore di utilizzo, fornire istruzioni su come verificare se è necessario sostituire le batterie, come rimuovere le batterie usate e come inserire le nuove batterie.
3. Discuti delle opzioni di archiviazione. Il manuale dovrebbe spiegare, se necessario, come conservare correttamente il prodotto o il dispositivo. dovresti anche includere informazioni sul motivo per cui l`archiviazione è necessaria e quali sono le conseguenze di un`archiviazione errata. Ad esempio potresti scrivere:
4. Fornire informazioni sulla risoluzione dei problemi. Potresti organizzare questa sezione come un elenco di problemi comuni e delle loro soluzioni. Raggruppa problemi simili sotto un`intestazione logica. In questo modo, gli utenti possono trovare rapidamente problemi specifici.
Parte 4 di 4: Scrivere una guida leggibile
1. Leggi altre guide per l`utente. Prima di scrivere un manuale per il tuo prodotto, guarda altri manuali utente efficaci. Presta attenzione alla struttura, alla scelta delle parole e alla struttura della frase. I principali marchi come Apple, Google e Microsoft producono guide per l`utente solide ed efficaci che possono aiutarti a produrre una guida per l`utente scritta in modo ponderato.
- Non limitarti a leggere tutto 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à la guida per l`utente più facile da usare. 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 è giusto per il tuo manuale.
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.
4. Scrivi le 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, potresti iniziare i tuoi passaggi con un comando come "Connetti", "Conferma" o "Scorri". Tuttavia, non iniziare i tuoi passaggi con una risposta dal sistema.
6. Decidi quale vocabolario utilizzerai. Se scrivi un manuale utente per uno yo-yo, il tuo pubblico sarà composto principalmente da bambini piccoli. Usa parole e vocaboli semplici per spiegare come funziona lo yo-yo. Quando scrivi un manuale per un microscopio elettronico a scansione, il tuo pubblico è composto da scienziati altamente qualificati in grado di comprendere informazioni molto dettagliate, quindi non esitare a usare un vocabolario specializzato o spiegazioni sfumate.
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 spedisci il tuo prodotto. Puoi anche utilizzare uno strumento di traduzione online, ma chiedi a un madrelingua di leggere la traduzione e verificare la presenza di errori.
8. Scrivi in brevi frasi. Invece di pochi paragrafi lunghi, usa molti paragrafi brevi. Cerca le interruzioni logiche in ogni sezione e raccogli le informazioni utili in blocchi di una o due frasi. Lo stesso vale a livello di frase. Mantieni le tue frasi brevi e semplici, invece che lunghe e prolisse.
9. Controllare il manuale per errori. Un manuale può perdere credibilità a causa di errori di grammatica e ortografia. Chiedi anche a un collega o scrittore tecnico di modificare e correggere il manuale. Oltre all`ortografia e alla grammatica, un correttore di bozze dovrebbe prestare attenzione a quanto segue:
Consigli
- Le persone imparano in modi diversi; Se possibile e appropriato, includi ausili visivi o collegamenti a video online nel manuale per accogliere i lettori visivamente orientati.
Articoli sull'argomento "Scrivere una guida per l'utente"
Condividi sui social network:
Popolare
