Passo 1 Ottenere conoscenze generali sul modello Manuale utente
Prima di utilizzare effettivamente il modello Manuale utente e gli altri strumenti che ho sviluppato per Philip, volevo assicurarmi di avere lo stesso punto di partenza. Gli ho fornito alcune informazioni generali sulle istruzioni per l’uso e alcuni buoni esempi di manuali utente esistenti.
Ho elencato queste informazioni di seguito.,
Qual è la definizione di manuale utente?
Un manuale utente è un documento di comunicazione tecnica destinato a fornire assistenza alle persone su come utilizzare un prodotto. Un buon manuale utente aiuta gli utenti su come utilizzare un prodotto in modo sicuro, sano ed efficace.,
Altri nomi, o altre forme di un manuale utente, potrebbe essere:
- manuale
- documentazione Tecnica
- manuale
- manuale
- manuale di Formazione
- Guida Rapida
- manuale di Installazione
- manuale di Manutenzione
- manuale
Oltre all’obiettivo primario di un manuale per l’utente (per aiutare un utente), gli obiettivi secondari potrebbe essere quella di creare una migliore esperienza di utente e dei requisiti legali.
Un manuale utente è costituito da informazioni visive testuali(illustrazioni, screenshot, tabelle ecc.,) per assistere l’utente nel completamento di compiti specifici.
L’utente svolge il ruolo centrale nella stesura di un manuale utente. Un manuale utente ben redatto fornisce solo le informazioni pertinenti per l’utente previsto del prodotto.
Il manuale dell’utente deve contenere sia informazioni procedurali (istruzioni passo-passo) che informazioni concettuali (informazioni di cui l’utente ha bisogno per comprendere le informazioni procedurali).
Un buon manuale utente è conciso e utilizza un linguaggio privo di gergo. Un buon manuale utente dovrebbe rispondere a COME e QUALI domande., Dovrebbero contenere informazioni su cosa succede se un’attività non viene eseguita correttamente.
In alcuni casi, un prodotto è destinato ad essere utilizzato da diversi tipi di utenti. I tipi di utente tipici sono l’utente finale, l’installatore, l’ingegnere di manutenzione e l’operatore. Ogni tipo di utente ha bisogno di un approccio diverso in termini di linguaggio da utilizzare, il tono della voce e fornito informazioni concettuali.
Quali informazioni dovrebbero essere in un manuale utente?
Diversi tipi di prodotti hanno bisogno di un manuale utente. Un prodotto può essere un sistema, uno strumento, un dispositivo, uno strumento, un software o un’app.,arnings
l’Utilizzo di un manuale per l’utente modello
Il principale strumento che ho sviluppato per aiutare Filippo a redigere il suo manuale per l’utente è un Utente Manuale Modello., Il modello contiene tutte le informazioni e più dalla lista di cui sopra. È conforme ai requisiti per il suo prodotto.
Il modello Manuale utente può essere utilizzato per creare il manuale per il sistema, strumento, dispositivo, strumento, o per creare un manuale di installazione, manuale del software, manuale operativo, manuale di manutenzione o manuale di formazione.
Sulla base del primo modello per Philip, abbiamo sviluppato modelli per i seguenti gruppi di prodotti:
- Dispositivi medici
- Giocattoli
- Macchinari
- Elettronica
Quali formati ha un manuale utente?,
I manuali d’uso possono essere forniti in formato cartaceo o in formato elettronico (PDF o online o su dispositivo in HTML). Il modello manuale utente è un documento MS Word che può essere stampato o messo online.
I manuali utente possono essere creati utilizzando una varietà di strumenti. Ogni strumento ha i suoi vantaggi e svantaggi., contenuti possibili
Tutto in una soluzione
Omni-piattaforma pubblicazioni
Contiene di default manuale utente modelli
manuale dell’Utente esempi
Mentre la redazione di un manuale per l’utente con l’aiuto del Manuale per l’Utente Modello, può essere utile avere alcuni buoni esempi., Attraverso i seguenti link è possibile scaricare un esempio di manuale utente per la documentazione:
- IKEA istruzioni per l’installazione
- Jura manuale utente
Passo 2 Identificare l’utente(s) del vostro modello di manuale utente
Ok, così ora Philip ha alcune conoscenze di base sui manuali utente. Tuffiamoci nei dettagli e nelle azioni.
Quando si desidera scrivere un manuale che aiuti l’utente a risolvere i problemi, è necessario prima definire chi è l’utente. Questo può essere fatto creando un profilo utente, chiamato anche una persona.,
Con una persona, fai alcune ipotesi ragionevoli sulle caratteristiche del tuo utente. Questo non è solo utile per creare le istruzioni per l’utente, ma è un elemento essenziale all’inizio dello sviluppo di qualsiasi prodotto! Come ingegnere di progettazione industriale istruito, questo è il modo in cui abbiamo iniziato tutti i nostri incarichi di progettazione.
Quando ho controllato il sito web ISOVOX, non ho nemmeno trovato una descrizione chiara dei loro utenti previsti. Ecco perché ho chiesto a Philip di definire i suoi utenti e rispondere a domande come:
- Chi è l’utente del tuo prodotto?,
- Il prodotto viene utilizzato professionalmente o principalmente privatamente?
- Quali altre esperienze tecniche hanno? Cosa descrive l’utente?
Ho creato un modello che contiene le domande. Ho chiesto a Philip di compilare il modello.
È possibile utilizzare il modello da soli per determinare chi è l’utente. Si prega di notare che la seconda scheda contiene anche le risposte di Philip, in modo da avere un esempio di come il foglio potrebbe essere utilizzato.
Azione: usa il modello per descrivere i tuoi utenti.
Sono un grande fan della visualizzazione delle cose., Quindi, se vuoi fare un ulteriore passo avanti nella definizione del tuo utente, ti suggerisco di visualizzare il tuo utente sotto forma di persona. Quando crei una persona stai dando al tuo utente un nome, età ecc., quindi diventa una persona reale che rappresenta il tuo utente.
L’ho fatto per Philip., Questo è il risultato:
Azione: Creazione di una visualizzazione del vostro utente
Se volete sapere di più sulla definizione di pubblico e di creazione di profili:
Fase 3 Creazione di Temi per l’Utente Problemi
Inizia con l’identificazione dei problemi di utente(s) potrebbero verificarsi durante il ciclo di vita del prodotto e che si vuole risolvere. I problemi tipici possono includere: installazione del prodotto, utilizzo del prodotto, utilizzo del prodotto in modo sicuro, manutenzione del prodotto e smaltimento del prodotto.,
Se il problema è troppo complesso, è possibile scomporlo in blocchi.
Ho chiesto a Philip di identificare i problemi e le soluzioni che il suo utente potrebbe incontrare durante il ciclo di vita del prodotto. Per fare ciò, ho creato un altro modello per Philip. Nella colonna di sinistra della scheda Ciclo di vita vengono menzionate le fasi del ciclo di vita di un prodotto. Questi sono derivati dallo standard internazionale per le istruzioni per l’utente, IEC/IEEE 82079. I nostri modelli di manuale utente sono conformi a questo standard.
Nella scheda Ciclo di vita si vede come Philip ha adattato il ciclo di vita al proprio prodotto.,
Azione: utilizzare questo modello e le istruzioni sulla prima scheda per identificare i problemi che l’utente potrebbe avere durante il ciclo di vita del prodotto e presentare le loro soluzioni.,
Se volete saperne di più su come definire i tuoi problemi dell’utente, e la creazione di argomenti:
- Argomento per la creazione basata su
- Minimalismo
- la mappatura delle Informazioni
- Chunking
Fase 4 Definire la Struttura del Manuale d’uso Template
Filippo ha identificato i problemi che un utente può avere con il suo prodotto durante il suo ciclo di vita, e ora ha pensato la soluzione per risolvere il problema. In altre parole: Philip ha definito gli argomenti per il suo manuale utente., Ogni argomento può riguardare solo un argomento specifico, ha uno scopo identificabile e deve essere in grado di stare da solo.
Un argomento dovrebbe dare la risposta alla domanda di un solo utente. Un utente vuole risolvere un problema alla volta. Quando un utente ha risolto il problema, andrà e risolverà il prossimo problema.
Un argomento diventerà una sezione nel manuale utente. Può essere un capitolo o un (sotto)paragrafo. Non appena un utente è alla ricerca di una risposta al suo problema, userà il sommario per scoprire come navigare a quella risposta.,
Ho chiesto a Philip di strutturare gli argomenti e definire il loro posto nel manuale utente, assegnando un determinato argomento a uno specifico capitolo o (sotto)paragrafo. Il risultato può essere visto nella scheda Sommario.
Azione: Per definire la struttura del manuale utente:
- Copiare il contenuto dalla scheda Ciclo di vita alla scheda Sommario.
- Nella scheda Sommario, sostituire il nome del prodotto con il proprio nome del prodotto.
- Aggiungi una colonna a sinistra. Chiamalo ‘Sezione’.
- Se applicabile, organizzare le sezioni logicamente.
- Determina quali argomenti diventeranno capitoli aggiungendo i numeri dei capitoli., Iniziare la numerazione PREPARAZIONE DEL PRODOTTO PER L’USO con il numero 4. Aggiungeremo altri capitoli nella fase successiva.
- Determina quali argomenti diventeranno paragrafi aggiungendo i numeri di sezione.
- Determina quali argomenti diventeranno sotto-paragrafi aggiungendo i numeri di sottosezione.
Ora è stato creato il Sommario (Sommario). Il sommario è il contorno del manuale utente. Più tardi aggiungeremo altri argomenti / sezioni, come l’introduzione, le informazioni sulla sicurezza ecc., quindi non si preoccupi di aggiungere quello adesso.,
Passo 5 Creare intestazioni significative
Ogni argomento nel manuale utente ottiene la propria intestazione. Le intestazioni sono i (sotto)titoli che precedono il testo vero e proprio. Appaiono nel sommario, in modo che l’utente possa navigare verso le informazioni necessarie.
Quindi, Philip ha appena creato i (sotto-)titoli per i suoi argomenti.
Poiché le voci del sommario svolgono un ruolo così importante nell’aiutare l’utente a trovare la propria strada e per aiutarli a saltare ciò che NON è importante, hanno bisogno di un po ‘ più di attenzione.
Fondamentalmente, dovresti provare a lavorare con tre livelli di intestazioni: intestazioni di primo, secondo e terzo livello.,
L’intestazione di primo livello descrive di cosa tratta l’intero capitolo o sezione (ad esempio l’INSTALLAZIONE DEL PRODOTTO). I titoli di secondo livello dovrebbero utilizzare lo stile di fraseggio ” come cosa “(ad esempio come assemblare il prodotto e come eseguire l’installazione elettrica). Un titolo di terzo livello utilizza frasi sostantive (ad esempio, contenuto dell’imballaggio e strumenti da utilizzare).
Ho chiesto a Philip di reindirizzare le sue intestazioni e di prendere nota delle seguenti linee guida generali:
- Utilizzare la struttura come mostrato sopra per l’intestazione di primo, secondo e terzo livello.,
- Assicurati che le intestazioni siano auto-esplicative. L’intestazione Fare frittelle è molto più user-oriented rispetto all’utilizzo del MagicCook5000.
- Assicurati che l’intestazione copra l’intero argomento. Se la sezione riguarda la manutenzione e la riparazione di un prodotto, la voce Manutenzione sarebbe incompleta.
- Se possibile, prova a omettere gli articoli all’inizio delle intestazioni
Azione: Scrivi nuove intestazioni per le voci del sommario.
Il ToC di Philips con intestazioni significative si trova nella scheda ToC w. Intestazioni significative.,
Passo 6 Determinare il contenuto legale
A seconda del mercato in cui il prodotto viene immesso o messo in servizio e, a seconda del gruppo di prodotti a cui il prodotto appartiene, si applica una legislazione specifica al prodotto.
In generale, la legislazione richiede che il prodotto sia “sicuro” e quindi fornisce requisiti generali di sicurezza che il prodotto deve soddisfare.
Questi requisiti includono anche i requisiti sul contenuto del manuale utente e le istruzioni di sicurezza.,
Al fine di vendere il prodotto in un mercato specifico, è necessario assicurarsi che il manuale utente sia conforme a questi requisiti.
Questi due articoli qui sotto ti diranno come puoi scoprire esattamente quale legislazione si applica al tuo prodotto per il mercato europeo e statunitense e quali sono i requisiti per il tuo manuale utente. Suggerimento: quando è già disponibile una Dichiarazione di conformità, è possibile trovare le direttive applicabili.,
- Come creare manuali conformi per l’UE
- Come creare manuali conformi per gli Stati Uniti
Philip non aveva bisogno di eseguire questi passaggi, in quanto il modello utilizzato conteneva già il contenuto legale richiesto dalle direttive pertinenti.
Per il suo prodotto, ciò significa che le seguenti informazioni sono necessarie per il manuale utente per il suo prodotto:
EU (pertinenti direttive di marcatura CE: LVD, EMC, RoHS, RAEE, REACH):
- Il manuale utente deve essere tradotto nella lingua(e) del paese in cui il prodotto è venduto.,
- Il manuale dell’utente deve descrivere l’uso previsto del prodotto.
- Il manuale dell’utente deve descrivere l’uso non intenzionale ragionevolmente previsto del prodotto.
- Se applicabile, va menzionata la non conformità nelle aree residenziali.
- Il tipo, lotto o numero di serie o altro elemento che consente l’identificazione del prodotto deve essere indicato sul prodotto. Se il prodotto è troppo piccolo questo può essere inserito nel manuale utente.
- Il nome, il nome commerciale registrato o il marchio registrato e l’indirizzo postale devono essere menzionati sul prodotto., Se il prodotto è troppo piccolo questo può essere inserito nel manuale utente.
- Deve essere condotta un’analisi dei rischi per determinare i rischi residui legati all’uso del prodotto. Le informazioni di sicurezza sono fornite al fine di informare l’utilizzatore delle misure da adottare.
- Le informazioni RAEE devono essere incluse
- Le informazioni sui rifiuti di imballaggio devono essere incluse.
Oltre a questa legislazione, esiste anche uno standard internazionale per i manuali utente, IEC/IEEE 82079-1:2019. Questa norma è stata armonizzata nell’UE., La conformità alle norme armonizzate costituisce una presunzione di conformità alla legislazione corrispondente!
Il modello di manuale utente è conforme a questo standard.
Ho anche creato una lista di controllo IEC 82079 che può essere utilizzata per verificare che il manuale utente sia conforme a questo standard.
Al fine di creare un manuale utente conforme a livello internazionale, è sempre necessario assicurarsi che il manuale soddisfi i requisiti UE, USA e 80279.,
Azione: Per determinare i requisiti legali del manuale utente:
- Seguire i passaggi 1-2 dalla conformità UE e / o i passaggi 1-6 dagli articoli sulla conformità degli Stati Uniti per determinare il quadro legale per le istruzioni.
- Studiare la lista di controllo IEC 82079 per assicurarsi che il manuale sia conforme allo standard 82079.
In questo video spiego come è possibile creare un manuale conforme allo standard 82079:
ALLO STORE
Passo 7 Scaricare e preparare il modello di manuale utente
Ora Philip può iniziare la creazione effettiva del suo manuale utente.,
Gli ho chiesto di regolare il sommario del modello in base al proprio sommario. Senza rimuovere e elementi obbligatori, naturalmente…
Ti ricordi dal passaggio 4 che ho chiesto di iniziare la numerazione delle sezioni con il capitolo 4? Una volta scaricato il manuale utente template doc te stesso, vedrai che sono stati aggiunti alcuni capitoli standard e alcune appendici.,
Azione: Per regolare il modello manuale utente:
Se si desidera lavorare con il modello gratuito:
- Scaricare il modello manuale utente gratuito Word 2013 o 2007
- Modificare le intestazioni delle sezioni in base al proprio sommario. Avviso! Non regolare il sommario. Il sommario può essere aggiornato automaticamente dopo aver regolato le intestazioni delle sezioni.
- Aggiungere il contenuto obbligatorio come determinato nel passaggio 6 del manuale.
- Se applicabile, modificare le sezioni 1-3 e le appendici in base alle proprie esigenze.,
O utilizzare uno dei nostri pagato i modelli che contengono tutti i contenuti obbligatori, come fece Filippo:
- Dispositivi Medici EU
- Dispositivi Medici US
- Macchine dell’unione europea
- Macchine US
- Elettronica UE
- Giocattoli UE
Fase 8 Creare i Contenuti per l’Utente Manuale Modello
Scrivere la destinazione d’Uso
Lo scopo del vostro prodotto, o meglio: la destinazione d’uso, è il cuore di un manuale utente e costituisce la base per garantire il sano e sicuro l’uso del prodotto.,
Il modo in cui viene descritto l’uso previsto determina anche la responsabilità dell’utente e influisce sugli ulteriori contenuti del manuale utente.
La maggior parte della legislazione richiede di includere una descrizione dell’uso previsto nelle istruzioni per l’uso.
Lo standard internazionale per le istruzioni per l’uso, IEC 82079-1, fornisce la seguente definizione per l’uso previsto:
Una gamma esaustiva di funzioni o applicazioni previste definite e progettate dal fornitore del prodotto
Descrivendo l’uso previsto si determina l’involucro sicuro del prodotto., E una volta determinato l’uso previsto, è possibile concentrarsi sulla fornitura solo quelle istruzioni di sicurezza e utente per come utilizzare il prodotto all’interno della busta data.
Inoltre, per l’uso previsto, molti altri standard, direttive e regolamenti richiedono anche di includere una descrizione dell’uso improprio ragionevolmente prevedibile.
Ad esempio, l’uso improprio ragionevolmente prevedibile di un detergente aggressivo potrebbe essere l’uso di esso in un ambiente di trasformazione alimentare.
Prestare troppa poca attenzione alla descrizione dell’uso improprio ragionevolmente prevedibile influirà sulla responsabilità di un’azienda.,
Le leggi / i regolamenti sulla responsabilità del prodotto tengono un produttore responsabile per un prodotto difettoso. Se è necessario determinare la difettosità di un prodotto, verranno prese in considerazione tutte le circostanze. Ciò include l’uso ragionevolmente prevedibile del prodotto.
La descrizione dell’uso previsto determina quali istruzioni sono fornite nel resto del manuale. Ad esempio, se un sistema di raffreddamento viene utilizzato solo per il raffreddamento di determinati farmaci, è necessario descrivere solo queste procedure.,
Quando si potrebbe ragionevolmente prevedere che il sistema di raffreddamento possa essere utilizzato come sistema per raffreddare gli organi, questo dovrebbe essere descritto nelle istruzioni. In questo modo, tu, come produttore, limiterai la tua responsabilità e potrai concentrarti solo sulla descrizione di come utilizzare il sistema per raffreddare i farmaci.
Azione: scrivi l’uso previsto e l’uso improprio ragionevolmente prevedibile del tuo prodotto.
Figura 1. Uso improprio ragionevolmente prevedibile?,
Scrivere le avvertenze di sicurezza sulla base dell’analisi dei rischi
Anche se la destinazione d’uso è stata ormai chiaramente definita, ciò non significa che l’utilizzo di un prodotto sia completamente privo di rischi.
Per identificare i pericoli derivanti dall’uso di un prodotto, è possibile condurre un’analisi dei rischi. Un’analisi dei rischi può anche essere obbligatoria per alcuni gruppi di prodotti, come apparecchiature a bassa tensione, giocattoli, macchinari e attrezzature per l’uso in atmosfere esplosive.
Gli standard, come la ISO 12100, sono stati sviluppati su come condurre un’analisi dei rischi., La norma ISO 12100 fornisce anche un metodo per adottare misure di mitigazione: il metodo in tre fasi. Secondo questo metodo, c’è la seguente gerarchia di riduzione del rischio, misure:
- misure di progettazione Intrinsecamente sicura
- la Salvaguardia e le misure di protezione complementari
- Informazioni per l’uso
Questo significa che la guida per l’utente dovrà avvisare di eventuali rischi residui connessi con l’uso del prodotto. Questo viene fatto con avvisi di sicurezza.,
ACQUISTA ORA
Un buon avviso di sicurezza descrive la natura di una situazione pericolosa, le conseguenze di non evitare una situazione pericolosa e i metodi per evitarla.
Per indicare il grado di pericolo che può essere riscontrato dall’utente, utilizzare le parole di segnalazione “Pericolo”, “Avvertimento” e “Attenzione”.
Dai un’occhiata ai seguenti messaggi di sicurezza:
ATTENZIONE! Parti rotanti. Rischio di lesioni gravi. Tieni le mani libere. Blocco / Tagout prima della manutenzione.
Quindi si desidera avvisare l’utente in cui potrebbe verificarsi una situazione pericolosa. L’ANSI Z535.,6 standard descrive le seguenti posizioni nel manuale utente in cui questo potrebbe essere:
- Raggruppati in un capitolo a parte.
- Nella prima parte della sezione specifica:
- Incorporato in una procedura:
1. Fallo.
2. Fallo. ATTENZIONE! Si tratta di messaggi di sicurezza incorporati. Testo generale testo generale testo generale.
3. Fallo.,
- Nella prefazione è possibile inserire qualsiasi direttiva supplementare, come Leggere tutte le istruzioni prima dell’uso o Conservare queste istruzioni per riferimento futuro nell’introduzione di un manuale utente.
Nell’UE, a seconda del tipo di prodotto, potrebbe essere consentito fornire solo le informazioni sulla sicurezza in forma stampata e il resto delle informazioni online.
Per aiutare Philip a creare e inserire un messaggio di sicurezza, ho creato un altro modello.
Azione: condurre un’analisi dei rischi e creare i messaggi di sicurezza utilizzando questo modello.,
Crea tutti gli altri contenuti
Ora ho chiesto a Philip di creare tutti gli altri contenuti, come le procedure, le specifiche tecniche e le informazioni legali.
Ho dato i seguenti suggerimenti:
- Escludere materiale non necessario per evitare il sovraccarico di informazioni (ad esempio promozione delle vendite, ripetizione estesa ecc.).
- Assicurati che i termini siano familiari all’utente, le caratteristiche tecniche e i termini siano ben spiegati e utilizzino i termini in modo coerente.
- Descrivere tutti i prerequisiti che devono essere soddisfatti prima dell’inizio delle istruzioni effettive., Questo può anche descrivere utensili speciali o spazio per la manutenzione e la riparazione.
- Fornire informazioni concettuali quando le informazioni sono necessarie per un’adeguata comprensione ed esecuzione dei compiti.
- Scrivi sempre in base all’argomento.
- Utilizzare un carattere in grassetto per tutti gli elementi del prodotto.
- Usa una guida di stile per aiutarti a scrivere e formattare la documentazione in modo più chiaro.
- Indicare quando si desidera aggiungere un’immagine per una migliore comprensione in seguito.
- Assicurati che parole e frasi non siano troppo complicate o troppo sofisticate.,
- Usa frasi semplici/standardizzate e brevi: una frase-un comando.
- Non mettere troppe informazioni in una frase.
- Usa la voce attiva diretta e i comandi assertivi.
- Usa parole come nomi e verbi in modo coerente per evitare ambiguità.
- Per scrivere istruzioni migliori, utilizzare i principi del minimalismo nella comunicazione tecnica e l’inglese tecnico semplificato.
Azione: creare tutti gli altri contenuti per il manuale utente.
Ancora una volta, per la maggior parte dei gruppi di prodotti sono disponibili modelli a pagamento che potrebbero semplificare il lavoro., Questi modelli contengono tutti i testi legali, le informazioni obbligatorie sullo smaltimento, le dichiarazioni sul copyright e sono conformi allo standard IEC 82079 sulle istruzioni per l’utente.
Posizionare gli avvisi di sicurezza nella giusta posizione
Quando si utilizza il modello per la creazione dei messaggi di sicurezza, ho chiesto a Philip di indicare se un messaggio di sicurezza è una direttiva supplementare o deve essere posizionato come messaggio di sicurezza raggruppato, sezione o incorporato.
Ora tutto il testo è stato creato, i messaggi di sicurezza possono essere posizionati nel posto giusto.,
Azione: posizionare tutti i messaggi di sicurezza nella posizione corretta nel manuale utente.
Passo 9 Aggiungi navigazione al tuo modello di manuale utente
Un manuale utente dovrebbe fornire assistenza alle persone fornendo informazioni su come utilizzare un prodotto. Trovare le giuste informazioni che risolvono il problema dell’utente dovrebbe richiedere il minor tempo possibile.
La creazione di intestazioni significative è uno degli strumenti che aiutano gli utenti a trovare informazioni., Tuttavia, ci sono molti altri strumenti per aiutare l’utente a trovare le informazioni che desidera, come ad esempio:
- Sommario
- Numerazione delle pagine
- Indice
Ho chiesto a Philip di aggiornare il sommario e aggiungere la numerazione delle pagine e un indice.
Azione: aggiungi o aggiorna il sommario, la numerazione delle pagine e l’indice.
Passo 10 Rivedi il tuo manuale utente
Philip ha ora creato la versione bozza del suo manuale utente, utilizzando il modello manuale utente. Chiamiamo questa versione il design dei contenuti testuali.,
Come Philip ha un partner commerciale e uno sviluppatore con approfondita conoscenza tecnica del prodotto, ho chiesto a Philip di far loro rivedere il lavoro finora.
Sia il suo partner commerciale e lo sviluppatore ha fornito un feedback. Philip ha utilizzato questo feedback per ottimizzare il manuale utente.
Azione: invia la bozza di versione del manuale utente a chiunque all’interno del tuo team possa fornire feedback. Chiedere loro di combinare tutti i feedback in un unico documento prima di inviare di nuovo a voi. Questo stimola la discussione dei membri del team e impedisce il disaccordo in una fase successiva.,
Passo 11 Creare le immagini
Una volta che il manuale utente è stato rivisto e ottimizzato, i testi sono più o meno definiti. Ciò significa che tutte le immagini possono ora essere create e aggiunte al contenuto.
La ragione per aspettare che i testi siano pronti è che creare o modificare le immagini può richiedere molto tempo. Poiché le immagini dovrebbero supportare, sostituire o aumentare il testo, si desidera attendere la loro creazione fino a quando i testi non saranno definitivi.
Le immagini nei manuali utente possono includere illustrazioni, foto, screenshot, tabelle, diagrammi e schemi.,
Ci sono molti strumenti che possono aiutare a creare le vostre immagini, come ad esempio:
- Snagit o Adobe Photoshop per l’editing screenshot o foto
- Solidworks Composer o Google Sketchup per la creazione di disegni
- Lucidchart o Microsoft Visio per i diagrammi e gli schemi
ho consigliato a Filippo di non utilizzare le foto come una alternativa a basso costo per le illustrazioni. Spesso le foto non sono così informative perché contengono troppe informazioni. Oltre a ciò, le foto possono rendere un manuale utente disordinato.,
Per questo motivo, Philip ha usato Google Sketchup per creare le sue illustrazioni.
Azione: Crea le immagini per il tuo manuale utente.
Se volete saperne di più sulla creazione di immagini:
- Uso del testo, immagini o video
- Creazione di IKEA-ish manuali
Fase 12 Verifica Finale del Manuale d’uso Template
Prima di iniziare a fare sembrare bello e tradurre il contenuto, vogliamo essere sicuri che il contenuto sia completo.
Per farlo, ho chiesto a Philip di utilizzare una lista di controllo.,
Azione: l assicurarsi che il manuale utente sia conforme a tutti i requisiti pertinenti della norma IEC 82079-1:2012 utilizzando questa lista di controllo.
Passo 13 Progetta il tuo modello di manuale utente
Un manuale ben progettato contribuisce a una migliore esperienza di marca e utente.
È possibile regolare il modello Manuale utente in MS Word con l’aggiunta di un logo aziendale e regolare il carattere, colori eccetera, ma che potrebbe avere limitazioni.
Quando si sa come lavorare con Adobe Indesign, o sono disposti a imparare a lavorare con esso, questo vi offrirà molto maggiori possibilità di progettazione.,
Ho creato questo modello in Indesign e ho chiesto a Philip di adattarlo alla sua identità di marca.
Azione: regolare il modello Manuale utente in base alla propria identità di marca, oppure scaricare il modello manuale utente InDesign e regolarlo.
Passo 14 DTP Funziona
DTP sta per Desktop Publishing e Wikipedia lo descrive come “la creazione di documenti utilizzando le abilità di layout di pagina su un personal computer principalmente per la stampa”.
Philip ora ha sia il contenuto del suo manuale utente (file Word) che il modello manuale utente (file InDesign)., Il contenuto deve essere inserito nel modello InDesign. Questo è chiamato Desktop Publishing.
Azione: inserire il contenuto del file Word nel modello Indesign. Se hai deciso di non utilizzare il modello InDesign ma bloccato sul file Word, puoi saltare questo passaggio.
Passo 15 Traduci e pubblica i tuoi manuali utente
A seconda del mercato in cui venderai il tuo prodotto, potrebbe essere necessario tradurre il manuale utente.
Alcuni suggerimenti generali:
- Cercare un traduttore con esperienza simile., Questo potrebbe essere un traduttore esperto nella traduzione di contenuti tecnici, con prodotti simili o con la traduzione di manuali d’uso.
- Se hai bisogno di tradurre in diverse lingue, lavorare con un’agenzia di traduzioni potrebbe farti risparmiare un sacco di tempo.
- Chiedere al traduttore o agenzia circa le loro procedure di qualità e che sta per rivedere il testo dopo la traduzione.
- Poiché conosci meglio il tuo prodotto e chi è il tuo pubblico, potrebbe essere una buona idea fornire al traduttore o all’agenzia un glossario o un elenco con la terminologia che desideri utilizzare.,
- Cercare un traduttore che può lavorare direttamente nel file Word o InDesign o trovare un’agenzia che può fare il DTP funziona pure. In alternativa, puoi farlo da solo, ovviamente.
Poiché Philip venderà il suo prodotto sia negli Stati Uniti che nell’UE, ha deciso di lavorare con un’agenzia.
Azione: trova un traduttore o un’agenzia che si adatta alle tue esigenze e fai tradurre il tuo manuale utente.
In generale, un manuale utente dovrebbe essere disponibile in un formato facilmente accessibile all’utente. Che può essere stampato, o utilizzato online o sul dispositivo.,
Come un utente desidera informazioni nel momento in cui ne ha bisogno e quindi non pensa nei canali, l’approccio migliore sarebbe fornire le istruzioni omni-platform.
Nell’Unione Europea, per alcuni gruppi di prodotti, è ancora limitato a fornire il manuale utente stampato con il prodotto.
Tuttavia, a partire da aprile 2016, le istruzioni di molti gruppi di prodotti possono essere consegnate in un formato diverso piuttosto che in stampa. C’è un’eccezione, tuttavia.
Le informazioni di sicurezza devono comunque essere fornite in forma cartacea insieme al prodotto., Inoltre, su richiesta di un consumatore, dovrebbe essere messo a disposizione del consumatore un manuale d’uso cartaceo.
Philip ha deciso di quanto segue:
- Fornisce un manuale completo stampato con il prodotto, comprese le istruzioni di sicurezza.
- Ha creato una guida rapida separata da fornire con il prodotto pure.
- Ha messo online una versione pdf del manuale completo.
- Creerà una sezione di aiuto online sul suo sito web con la versione HTML del manuale utente. Qui può aggiungere anche video., E ottimizzando la versione HTML per i motori di ricerca rende più facile per il suo utente trovare informazioni per il suo utente
Conclusione
Questo è tutto ciò che c’è da fare. È così che Philip ha creato un manuale utente conforme con l’aiuto del modello Manuali utente e degli altri strumenti disponibili che ho fornito.
La parte migliore di tutto questo è che puoi ottenere gli stessi risultati di Philip seguendo questo processo passo-passo su come creare un manuale utente.