È probabile che se i tuoi prodotti sono più complessi di un rotolo di asciugamani di carta, crei una sorta di documentazione utente per aiutare le persone a imparare come usarli.
Un manuale di prodotto ben realizzato e facile da usare o una guida per l’utente può significare la differenza tra una fantastica esperienza del cliente e una terribile.
E la documentazione utente non è solo per i nuovi utenti.,
I clienti esperti possono anche fare riferimento a manuali utente o guide di prodotto per aggiornare i loro ricordi su una funzione che non hanno usato spesso o per risolvere un problema specifico che possono avere.
Per questo post, ci concentreremo principalmente sulle best practice per la creazione di documentazione utente per prodotti non fisici come il software, ma la maggior parte se non quasi tutti questi suggerimenti si applicano anche al regno del prodotto fisico.
Ecco cosa imparerai:
- Cos’è la documentazione utente e perché è importante?
- Come la documentazione per l’utente finale fa parte dell’esperienza del cliente.,
- Come buona documentazione utente può aiutare a prendere l’onere fuori il vostro team di assistenza clienti.
- Perché il contenuto visivo è l’ingrediente segreto per la migliore documentazione.
- Gli elementi essenziali che garantiscono la migliore documentazione per l’utente.
- I quattro passi per la creazione di documentazione che delizia i vostri clienti e supera la prova del tempo.
Crea facilmente una guida per l’utente (modello gratuito)
I modelli di Snagit sono il modo più veloce per creare guide per l’utente. Crea guide passo-passo con un aspetto semplice e professionale.,
Scarica
Che cos’è la documentazione utente?
Documentazione per l’utente (chiamata anche manuali per l’utente finale, guide per l’utente finale, manuali di istruzioni, ecc.) è il contenuto che fornisci agli utenti finali per aiutarli ad avere più successo con il tuo prodotto o servizio.
Questi sono i materiali didattici che vanno con il prodotto, per aiutare qualcuno a imparare a usarlo correttamente o — nel caso di prodotti fisici — anche a metterlo insieme.,
Se hai mai assemblato un mobile Ikea, hai utilizzato la documentazione per l’utente finale.
Ma la documentazione per l’utente assume molte forme.
I videogiochi sono dotati di manuali per dirti quali pulsanti spingere per sparare ai cattivi. La documentazione del software mostra cosa può fare il tuo acquisto e come farlo.,
I moduli fiscali sono dotati di guide su come compilarli correttamente.
Tosaerba e spazzaneve hanno guide di prodotto per mostrare come avviare i motori e dove riempire il carburante.
Vai a come creare la documentazione utente
Perché la documentazione utente è importante?
Sai che il tuo prodotto è fantastico. Vuoi che anche i tuoi clienti lo sappiano. La documentazione per l’utente aiuta a garantire che i tuoi clienti o utenti imparino effettivamente come ottenere il massimo dal tuo prodotto.,
Che si tratti di salvare un documento, avviare un motore, utilizzare uno strumento specifico o informazioni importanti sulla sicurezza, la documentazione dell’utente finale è una parte importante del rapporto con i clienti.
Può deliziare i vostri clienti
La documentazione utente è facile, giusto? Voglio dire, basta scrivere alcune cose su come utilizzare il prodotto e sei a posto!
Non è così semplice.
È più di un semplice materiale “how-to”. Fa parte dell’esperienza del cliente., E questo significa che è anche materiale di marketing.
Come consumatore io stesso, ho sperimentato sia guide utente grandi e orribili. Scommetto che la maggior parte di voi ha avuto esperienze simili.
Un ottimo manuale utente o una guida ai prodotti mostra ai tuoi clienti che ti interessa non solo se acquistano il tuo prodotto, ma se hanno un’esperienza davvero eccezionale di utilizzo.
E i clienti che sentono che ti preoccupi di loro oltre il loro portafoglio continueranno a tornare da te.,
Se vuoi che gridino al mondo quanto amano i tuoi prodotti e servizi, fornire una fantastica documentazione per l’utente è una parte essenziale di quell’esperienza post-acquisto.
Come la documentazione utente supporta il tuo team di supporto
Le persone contattano il tuo team di supporto quando qualcosa non funziona, ma chiamano anche quando non riescono a capire qualcosa. Avere un’ottima documentazione utente aiuta il tuo team di supporto in due modi principali.
1., Fornisce loro una guida di riferimento semplice
La grande documentazione utente non deve essere solo per i clienti. Il team di supporto del prodotto può utilizzare la documentazione per aiutare a supportare meglio i clienti quando chiamano. Quando includi pezzi essenziali come un sommario o un indice, possono trovare rapidamente le informazioni di cui hanno bisogno. E, se si tratta di un documento elettronico ricercabile, che è ancora meglio! Impareremo di più su questo più avanti nell’articolo.
2. Riduce le chiamate
Come notato sopra, le persone spesso chiamano il supporto quando non riescono a capire qualcosa., Ma se i clienti riescono a capirlo da soli, è molto meno probabile che abbiano bisogno di aiuto. Infatti, più del 70 per cento delle persone preferisce utilizzare il sito web di una società per chiedere aiuto piuttosto che utilizzare un telefono o e-mail.
Ora, anche la migliore documentazione non eliminerà tutte queste chiamate, ma la creazione di guide utente e manuali completi, facili da capire, chiari e concisi farà molto per ridurre il volume complessivo di chiamate, e-mail, chat, ecc.
Quali sono gli elementi essenziali della grande documentazione utente?,
Anche se ogni prodotto è unico e richiederà elementi diversi per creare documenti utente veramente grandi, ci sono alcune best practice di documentazione per l’utente finale da seguire, non importa quale.,
Grande utente documentazione deve includere:
- linguaggio
- Semplicità
- Grafica
- Un focus sul problema
- Una gerarchia logica e il flusso
- Una tabella di contenuti
- contenuto Ricercabile
- contenuto Accessibile
- Buona progettazione
- Feedback da utenti reali
- Collegamenti a ulteriori risorse
linguaggio
Nulla di vanificare un cliente più di leggere qualcosa che non capisco. Nessuno vuole sentirsi stupido., Far sentire il tuo cliente in questo modo non è certamente un modo per promuovere una grande esperienza.
Usa un linguaggio semplice e semplice quando possibile per aiutare i tuoi clienti a comprendere anche i concetti più complessi.
Ricorda, scrivi per l’utente, non per lo sviluppatore.
Sembra un gioco da ragazzi, ma scrivere in un linguaggio semplice su un prodotto o servizio che conosci front-to-back è molto più difficile di quanto si possa pensare. Conosci tutti i tipi di gergo, acronimi e altre informazioni “insider” che i clienti probabilmente non lo fanno. È naturale per te usarlo.,
Ma è lì che puoi incorrere in qualche problema serio.
Non dare per scontato che il tuo cliente sappia nulla del tuo prodotto. Non dare per scontato che conoscano tutte le parole d’ordine tecniche e/o di settore che probabilmente usi ogni giorno all’interno del tuo ufficio. Scrivilo per loro.
Non scrivere come se fossero bambini, ma capisci che potrebbero aver bisogno di un aiuto extra per aggiornarli veramente. Scrivi la documentazione in modo facile da leggere.
Semplicità
Mantienilo il più semplice possibile per raggiungere il suo obiettivo. Ciò vale sia per il contenuto del documento che per il suo design., Lunghi blocchi di testo e pagine strettamente imballati con contenuti scritti e grafici possono rendere le guide utente o manuali si sentono intimidatorio e ostile.
I clienti che sono intimiditi dai tuoi materiali utente sono molto più propensi a chiamare il tuo team di supporto per chiedere aiuto di quanto non lo siano per cercare di risolvere le loro domande da soli. E, sono molto meno probabilità di avere una buona esperienza del cliente.
Visuals, visuals, visuals
La migliore documentazione utente illustra perfettamente l’adagio “mostra, non dirlo.,”
Il contenuto visivo, incluse immagini, screenshot annotati, grafica e video, mostra rapidamente a qualcuno come funziona il tuo prodotto. Non hanno bisogno di leggere, possono vederlo!
Recenti ricerche di TechSmith mostrano che le persone assorbono effettivamente le informazioni visive più velocemente ed eseguono meglio le attività quando vengono fornite istruzioni con contenuti visivi o video.,
Il contenuto visivo aiuta anche a rompere lunghi blocchi di testo e può aiutare a eliminare molto testo che può rendere molte guide utente o manuali intimidatorie e spiacevoli.
I modi più diffusi per includere contenuti visivi nella documentazione dell’utente includono screenshot, registrazioni dello schermo, video tutorial e altro ancora.
Hai sentito parlare di grafica semplificata?, A volte chiamato interfaccia utente semplificata (o SUI), grafica semplificata prendere le immagini di un’interfaccia utente o altro grafico e — proprio come suggerisce il nome — li semplifica. Questa versione più semplice evidenziare le informazioni più essenziali, riducendo il testo e la grafica che non sono importanti per forme più semplici.,
Così, qualcosa di simile a questo:
Ora assomiglia a questo:
Se io stavamo cercando di mostrare a qualcuno come selezionare Connetti Dispositivo Mobile voce di menu, la seconda immagine rimuove tutto il disordine e consente al cliente gli occhi a fuoco dove hanno bisogno di essere.
È probabile che tu abbia già incontrato una grafica semplificata e non te ne sei nemmeno reso conto.,
questo tipo G Suite Centro di Apprendimento:
Ci sono un sacco di strumenti là fuori, ma se siete in cerca di potenti e semplici modi per creare screenshot e registrazioni dello schermo, Mi raccomando di scaricare una versione di prova gratuita di Snagit.
Concentrarsi sul problema da risolvere
Ogni prodotto risolve un problema., Ma troppo spesso, siamo così innamorati delle nostre fantastiche caratteristiche del prodotto, tutto ciò che vogliamo fare è evidenziare ciò che può fare piuttosto che il motivo per cui i nostri clienti ne hanno bisogno.
Assicurati di mostrare agli utenti come eseguire le attività con il tuo prodotto.
Naturalmente, ciò comporterà caratteristiche del prodotto, ma farlo nel contesto di aiutare l’utente a raggiungere il motivo per cui ha acquistato il prodotto in primo luogo — per risolvere un problema specifico.,
Ad esempio, i nostri tutorial Camtasia e Snagit (sì, i video tutorial possono essere una forma di documentazione) evidenziano caratteristiche specifiche, ma lo fanno nel contesto del motivo per cui qualcuno potrebbe usare quella funzione. Riguarda il perché, non solo il come.
Ecco un ottimo esempio
Gerarchia logica e flusso
Una buona documentazione richiede una gerarchia di intestazioni e sottotitoli che consente all’utente di sapere cosa mostrerà loro ogni sezione., E quella gerarchia dovrebbe seguire un flusso logico che aiuta l’utente a imparare a utilizzare il prodotto nel modo più utile.
Ad esempio, probabilmente non si desidera iniziare la documentazione mostrando ai clienti come utilizzare le funzioni più avanzate senza prima mostrare loro le basi di come funziona il prodotto. Inizia prima con le cose facili e poi, man mano che gli utenti costruiscono le loro conoscenze, mostra loro le funzionalità avanzate.,
Sommario
Un sommario fornisce ai clienti un modo semplice, efficiente e familiare per trovare rapidamente una soluzione alla loro domanda o problema. È proprio all’inizio del documento in modo che non debbano setacciare pagine di testo per trovare ciò che stanno cercando. Dovrebbe includere tutte le principali voci e sottovoci sopra descritte.
Rendilo ricercabile
C’è stato un momento in cui la maggior parte della documentazione utente è stata stampata., Ora, in un’epoca in cui quasi tutti hanno accesso a uno smartphone, ha più senso creare documentazione elettronica. Ciò non significa che non è possibile creare versioni di stampa, anche, ma una versione elettronica offre una serie di vantaggi che vedremo più in dettaglio di seguito.
Come un sommario, il contenuto ricercabile offre agli utenti un accesso più facile ai tuoi contenuti e li aiuta a trovare soluzioni da soli.
Accessibilità
Crea contenuti accessibili., Ciò significa garantire che la documentazione elettronica aderisca agli standard di accessibilità per le persone che possono essere non vedenti o ipovedenti, sordi o con problemi di udito o che possono avere disabilità cognitive.
Ricorda, molti dei tuoi clienti hanno bisogno di questo per comprendere e accedere completamente alla tua documentazione utente. Non lasciarli indietro!
Good design
Dai ai tuoi utenti un documento che vogliono guardare e saranno più propensi a usarlo.
Progettare materiali con i vostri clienti in mente. Renderlo utilizzabile e amichevole., Evita lunghi paragrafi di testo o pagine troppo piene di contenuti. Consentire lo spazio bianco per aiutare a rompere la monotonia e rendere la prospettiva di imparare un nuovo prodotto meno scoraggiante.
Includi grafica e immagini il più possibile per mostrare piuttosto che dire ai tuoi clienti come utilizzare il tuo prodotto. Per la documentazione elettronica, utilizzare video e gif.
Usa caratteri coerenti e colori complementari su più documenti. Se la tua organizzazione ha una guida di stile (che consiglio vivamente di utilizzare), assicurati che la tua documentazione aderisca ad essa.,
Snagit templates rende incredibilmente facile creare documentazione utente dall’aspetto professionale da una serie di screenshot o altre immagini. Basta raccogliere le immagini necessarie, scegliere Crea e Immagine dal modello e siete sulla buona strada.
Snagit viene fornito con una serie di modelli gratuiti, dal design professionale, e con le risorse TechSmith per Snagit, si ottiene l’accesso a un sacco di più!
Feedback da utenti reali e / o beta tester
Non è possibile creare documentazione utente veramente grande fino a quando non hai ascoltato le persone al di fuori della vostra organizzazione che effettivamente utilizzano i prodotti.,
Impara i loro punti di dolore e cerca di affrontarli nel miglior modo possibile. Scopri cosa ti dicono che hanno bisogno di sapere per utilizzare al meglio i vostri prodotti. Mentre alcuni di essi potrebbe essere ovvio, vi garantisco imparerete cose che non hai mai nemmeno considerato.
Link ad altra documentazione
Assicurati che i tuoi clienti abbiano accesso a più risorse della tua organizzazione su come avere successo con i tuoi prodotti. Per la documentazione utente elettronica, questo può essere semplice come fornire link a tutorial, FAQ, forum degli utenti e altro ancora.,
Ma anche la documentazione di stampa può includere cose come indirizzi di siti Web e numeri di telefono per ulteriore supporto.
Bonus! Aggiungi istruzioni passo-passo
Le guide passo-passo aiutano a evitare lunghi blocchi di testo e forniscono un modo molto più chiaro per mostrare un processo piuttosto che cercare di spiegarlo tramite testo da solo. Sono più facili da seguire, più facili da capire e offrono un’esperienza molto più user-friendly che semplicemente dire a qualcuno come completare un’attività.,
E ricordate, compreso il contenuto visivo nelle istruzioni passo-passo li rende ancora meglio.
Snagit fornisce uno strumento passo super-facile da usare che consente di creare grande documentazione passo-passo. Inoltre, lo strumento Combina immagini consente di combinare singoli screenshot e altre immagini in un’unica immagine per facilitare la modifica e il mark up.
Come creare una grande documentazione utente
Passo 1: Piano
Ogni grande insieme di documenti utente inizia con un piano., Ecco alcuni suggerimenti su come arrivare dove stai andando.
Sapere da dove cominciare
Molte persone presumono che se si conosce il prodotto, si può solo iniziare a creare la documentazione, ma c’è molto di più che va in esso. Invece, inizia con un piano per assicurarti di aiutare effettivamente i tuoi utenti.
Prima di fare la documentazione, ecco alcune cose da considerare:
- Cosa dovresti includere? Cosa si dovrebbe lasciare fuori? (Suggerimento: Questo è dove il feedback degli utenti può essere davvero utile!)
- In quale ordine dovremmo presentare le informazioni?, (Ricorda i contorni del saggio della scuola media? Usale!)
- Quali altre risorse saranno disponibili? Come forniremo accesso / link a quelli?
- Chi è responsabile della creazione del documento? Chi è responsabile del feedback sul documento? Chi ha l’approvazione finale?
- Questo dovrà essere tradotto o localizzato?
Le risposte a queste domande modellano il modo in cui crei la tua documentazione. La pianificazione garantisce un processo fluido e un documento utente migliore.
Conosci il tuo prodotto
Assicurati di conoscere il tuo prodotto.,
Ciò non significa che devi essere l’esperto assoluto di tutto, ma chiunque crei un manuale utente o una guida utente dovrebbe avere un’esperienza pratica con il prodotto.
Affidatevi ai vostri esperti in materia per la conoscenza più approfondita, di sicuro, ma si dovrebbe sapere come usarlo da soli prima di provare a insegnare a qualcun altro.
Scegli il tuo formato
Inoltre, il formato finale di un documento è altrettanto importante. Sarà solo stampa? Sarà elettronico? Se sì, dove vivrà?,
Non era molto tempo fa che quasi tutta la documentazione utente era solo stampata. Ma, a meno che tu non abbia una buona ragione, ti consiglio di avere almeno una versione elettronica disponibile sul tuo sito web.
La maggior parte degli utenti ha accesso 24 ore su 24 a smartphone, computer o tablet e sono abituati a trovare tutto ciò che vogliono sapere ogni volta che vogliono saperlo. Mettere online le risorse degli utenti consente loro di accedere ovunque si trovino, il che significa che non devono cercare nei cassetti o negli schedari per trovare un manuale utente che non vedono da anni.,
Inoltre, è semplicemente più facile rendere accessibile la documentazione elettronica per le persone con disabilità. Una versione di sola stampa funzionerà per la maggior parte delle persone, ma sei pronto a creare una versione braille per gli utenti che potrebbero essere non vedenti o ipovedenti? Che dire degli utenti che hanno una disabilità fisica in cui è difficile per loro manipolare gli oggetti con le mani?
Esistono strumenti per rendere la documentazione elettronica più facile per tutti l’accesso, ma le versioni di sola stampa forniscono un problema di accessibilità molto più difficile.,
Inoltre, la documentazione elettronica è molto più facile da aggiornare, poiché vive sul web.
PDF: Dovresti o non dovresti?
A meno che tu non voglia che le persone stampino la tua documentazione, NON renderla un PDF. Invece, rendere disponibile una versione elettronica sul tuo sito web come normale testo del sito web. Ci sono una serie di ragioni per questo, ma tutto si riduce a questo: è solo più facile da usare.
Se vuoi offrire una versione PDF scaricabile della tua documentazione, va bene. Ma assicurati che sia disponibile sul tuo sito web in un formato non PDF.,
Passo 2: Crea il tuo documento utente
Una volta che hai risposto a tutte le domande e preso tutte le decisioni sopra descritte, è il momento di creare la tua documentazione utente. Non ho intenzione di presumere di dirti ESATTAMENTE come creare la documentazione per il tuo prodotto specifico, ma ci sono alcune cose chiave da tenere a mente.
- Evita gergo e termini altamente tecnici tranne quando assolutamente necessario (e quindi assicurati di definirli).
- Evita gli acronimi a meno che non spieghi cosa significano.
- Usa uno stile di scrittura comunemente riconosciuto come AP o Chicago quando possibile., Se la tua organizzazione ha una guida di stile aziendale, usala.
- Non dare per scontato che l’utente sappia nulla del tuo prodotto o di ciò che fa. MOSTRARE loro ciò che hanno bisogno di sapere per avere successo.
- Ricordati di usare un linguaggio semplice. Scrivi per un livello di terza media. Anche per i lettori avanzati, un linguaggio semplice porta a un’elaborazione più rapida e una migliore comprensione.
- Il design dovrebbe essere piacevole, non intimidatorio e attirare l’utente. Fagli VENIRE voglia di usare la tua documentazione.,
Passo 3: testarlo
Una guida per l’utente è grande solo se aiuta i clienti a utilizzare il prodotto al meglio delle loro capacità. E non puoi saperlo finche ‘ qualcuno non lo usa. Prima che la tua nuova creazione esca nel mondo in generale, vuoi testarla. Ecco alcuni suggerimenti!
- Best practice: dare a un gruppo di utenti reali o beta tester e vedere come fanno. Incorporare il loro feedback nel documento finito.
- Se non si dispone di beta testing feedback degli utenti, testarlo internamente, preferibilmente con i dipendenti che hanno meno familiarità con il prodotto.,
- Ottenere un feedback da parte degli sviluppatori e ingegneri. Conoscono il prodotto meglio di chiunque altro e possono indicare cose che potresti aver perso.
Passo 4: Mantieni aggiornata la tua documentazione
Quando il tuo prodotto cambia, avrai bisogno di tutto aggiornato. Come notato sopra, ciò offre alla documentazione elettronica un enorme vantaggio rispetto alla stampa. Tuttavia, anche i documenti di sola stampa possono essere aggiornati e resi disponibili per il download sul tuo sito web.
Ricorda, il tuo contenuto è fantastico solo se è accurato. Assicurati che ciò che dai ai tuoi clienti li aiuti effettivamente a utilizzare il tuo prodotto.,
Sommario
Se non ricordi nient’altro, tieni presente che un’ottima documentazione utente dovrebbe essere creata, progettata e presentata in un modo che sia più utile per i tuoi utenti.
Dai loro una documentazione che continua a deliziarli e fornisce il tipo di esperienza del cliente che vorresti avere.
Rendi la tua documentazione accessibile, utile, visiva.
Crea facilmente una guida per l’utente (modello gratuito)
I modelli di Snagit sono il modo più veloce per creare guide per l’utente. Crea guide passo-passo con un aspetto semplice e professionale.,
Scarica
Domande frequenti
Documentazione per l’utente (chiamata anche manuali per l’utente finale, guide per l’utente finale, manuali di istruzioni, ecc.) è il contenuto che fornisci agli utenti finali per aiutarli ad avere più successo con il tuo prodotto o servizio.
In passato, la documentazione dell’utente veniva fornita tramite un file di aiuto locale sul computer dell’utente o un manuale fisico o un opuscolo., Al giorno d’oggi, la documentazione dell’utente è quasi sempre offerta online, il che ha aiutato gli scrittori tecnici a essere più fantasiosi nel modo in cui assistono gli utenti.
Grande documentazione utente dovrebbe includere: linguaggio semplice, semplicità, immagini, un focus sul problema, una gerarchia logica e flusso, un sommario, contenuti ricercabili, contenuti accessibili, buon design, feedback da utenti reali, e collegamenti a ulteriori risorse.
Grande documentazione per l’utente può essere fatto in quattro semplici passi: Prima conoscere i vostri obiettivi e creare un piano per raggiungerli. Quindi, crea
la tua guida in base al tuo piano. Quindi prova la tua guida per assicurarti che faccia il lavoro prima di liberarla. Infine, tienilo aggiornato. Quando il prodotto cambia, aggiornare la documentazione per riflettere le modifiche.
Nota: Questo post è stato originariamente pubblicato nell’agosto 2019, ma è stato aggiornato a settembre 2020 per chiarezza e per includere nuove informazioni.
Lascia un commento