Come creare la migliore documentazione per l'utente

È probabile che se i tuoi prodotti sono più complessi di un rotolo di asciugamani di carta, crei una sorta di documentazione per l'utente per aiutare le persone a imparare a usarli.

Un manuale del prodotto o una guida per l'utente ben realizzati e di facile utilizzo possono fare la differenza tra un'esperienza cliente fantastica e una terribile.

Inoltre, la documentazione per l'utente non è solo per i nuovi utenti.

I clienti esperti possono anche fare riferimento ai manuali dell'utente o alle guide dei prodotti per rinfrescare i propri ricordi su una funzionalità che non hanno utilizzato spesso o per risolvere un problema specifico che hanno.

Per questo post, ci concentreremo principalmente sulle procedure consigliate per la creazione di documentazione utente per prodotti non fisici come il software, ma la maggior parte (se non tutti) di questi suggerimenti si applicano anche all'ambito hardware.

Ecco cosa imparerai:

• Che cos'è la documentazione per l'utente e perché è importante.
• In che modo la documentazione per l'utente finale fa parte dell'esperienza del cliente.
• In che modo una buona documentazione per l'utente può aiutare a alleggerire il tuo 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 passaggi per creare una documentazione che soddisfi i tuoi clienti e resista alla prova del tempo.

Che cos'è la documentazione per l'utente?

La 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 accompagnano il tuo prodotto per aiutare qualcuno a imparare a usarlo correttamente o, nel caso di prodotti fisici, anche ad assemblarlo.

Se hai mai messo insieme un mobile IKEA, hai utilizzato la documentazione per l'utente finale.

Tuttavia, la documentazione per l'utente assume molte forme.

I videogiochi sono dotati di manuali che ti dicono quali pulsanti premere per sparare ai cattivi. La documentazione del software mostra cosa può fare il tuo acquisto e come farlo.

I moduli fiscali vengono forniti con guide su come compilarli correttamente.

I tosaerba e gli spazzaneve dispongono di guide ai prodotti per mostrarti come avviare i motori e dove fare il pieno di carburante.

Passa a come creare la documentazione per l'utente

Perché la documentazione per l'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 anche informazioni importanti sulla sicurezza, la documentazione dell'utente finale è una parte importante del rapporto con i clienti.

La documentazione per l'utente può deliziare i tuoi clienti

La documentazione per l'utente è facile, giusto? Voglio dire, scrivi solo alcune cose su come utilizzare il tuo prodotto e sei a posto!

Non è così semplice.

È più di un semplice "come fare". Fa parte dell'esperienza del cliente. E questo significa che è anche materiale di marketing.

In qualità di consumatore, ho sperimentato guide per l'utente fantastiche e orribili. Scommetto che molti di voi hanno avuto esperienze simili.

Un ottimo manuale utente o guida al prodotto mostra ai tuoi clienti che ti interessa non solo se acquistano il tuo prodotto, ma se hanno un'esperienza davvero eccezionale nell'usarlo.

I clienti che sentono che tieni a 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 straordinaria documentazione per l'utente è una parte essenziale di quell'esperienza post-acquisto.

In che modo la documentazione utente supporta il tuo team di supporto

Le persone spesso contattano il tuo team di supporto quando qualcosa non funziona, ma potrebbero anche chiamare quando semplicemente non riescono a capire qualcosa. Avere un'ottima documentazione per l'utente aiuta il tuo team di supporto in due modi principali.

1. Fornisce loro una facile guida di riferimento

Un'ottima documentazione per l'utente non deve essere solo per i clienti. Il tuo team di supporto del prodotto può utilizzare la documentazione per aiutare a supportare meglio i tuoi clienti quando chiedono aiuto. Quando includi elementi essenziali, come un sommario o un indice, possono trovare rapidamente le informazioni di cui hanno bisogno. E, se è un documento elettronico ricercabile, è 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. In effetti, oltre il 70% delle persone preferisce utilizzare il sito Web di un'azienda per ottenere assistenza piuttosto che ottenere assistenza tramite telefono o e-mail.

Anche la migliore documentazione non eliminerà tutte queste chiamate, ma la creazione di guide per l'utente e manuali chiari, completi e concisi contribuirà notevolmente a ridurre il volume complessivo delle richieste di supporto.

Quali sono gli elementi essenziali di un'ottima documentazione per l'utente?

Anche se ogni prodotto è unico e richiederà elementi diversi per creare documenti utente davvero eccezionali, ci sono alcune best practice per la documentazione dell'utente finale da seguire, qualunque cosa accada.

Un'ottima documentazione per l'utente dovrebbe includere:

• Linguaggio semplice
• Semplicità
• Visuale
• Un focus sul problema
• Una gerarchia logica e un flusso
• Un sommario
• Contenuti ricercabili
• Contenuti accessibili
• Buon design
• Feedback da utenti reali
• Collegamenti ad altre risorse

Linguaggio semplice

Niente frustrerà un cliente più della lettura di qualcosa che non riesce a capire. Nessuno vuole sentirsi stupido e il linguaggio che fa sentire i tuoi clienti in quel modo non è certamente un modo per promuovere un'esperienza eccezionale.

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 di un prodotto o servizio che conosci da davanti a dietro è più difficile di quanto potresti pensare. Conosci tutti i tipi di gergo, acronimi e altre informazioni "insider" che i clienti probabilmente non conoscono. È naturale che tu lo usi.

Ma è lì che puoi incorrere in qualche guaio serio.

Non dare per scontato che il tuo cliente sappia qualcosa 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.

Non scrivere come se fossero bambini, ma comprendi che potrebbero aver bisogno di ulteriore aiuto per metterli veramente al passo. Scrivi la documentazione in modo facile da leggere.

Semplicità

Mantieni la documentazione il più semplice possibile per raggiungere il suo obiettivo. Questo vale sia per il contenuto del documento che per il suo design. Lunghi blocchi di testo e pagine fitti di contenuti scritti e grafici possono rendere le guide per l'utente o i manuali intimidatori e ostili.

È molto più probabile che i clienti intimiditi dai tuoi materiali utente chiedano aiuto al tuo team di supporto piuttosto che cercare di risolvere le loro domande da soli. Inoltre, è molto meno probabile che abbiano una buona esperienza del cliente.

Visuale

La migliore documentazione per l'utente illustra perfettamente la frase "mostra, non dire".

I contenuti visivi, tra cui immagini, schermate annotate, grafica e video, mostrano rapidamente a qualcuno come funziona il tuo prodotto. Non devono leggerlo: possono vederlo!

Una recente ricerca di TechSmith mostra 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 spezzare lunghi blocchi di testo e può aiutare a eliminare gran parte del testo che rende molte guide per l'utente o manuali intimidatori e spiacevoli.

I metodi più diffusi per includere il contenuto visivo nella documentazione dell'utente includono schermate, registrazioni dello schermo, video tutorial e altro ancora.

Hai sentito parlare di grafica semplificata? A volte chiamata interfaccia utente semplificata (o SUI), la grafica semplificata acquisisce immagini di un'interfaccia utente o di un altro elemento grafico e, proprio come suggerisce il nome, le semplifica. Questa versione più semplice mette in evidenza le informazioni più essenziali riducendo il testo e la grafica che non sono importanti per le forme più semplici.

Quindi, qualcosa che assomiglia a questo:

Ora si presenta così:

Se stavo cercando di mostrare a qualcuno come selezionare la voce di menu Connect Mobile Device, la seconda immagine rimuove tutto il disordine e consente agli occhi del cliente di concentrarsi dove devono essere.

È probabile che tu abbia già riscontrato la grafica semplificata e non te ne sei nemmeno reso conto, come questo del Centro didattico di G Suite:

Ci sono molti strumenti là fuori, ma se stai cercando modi semplici e potenti per creare schermate e registrazioni dello schermo, ti consiglio vivamente di scaricare una versione di prova gratuita di Snagit.

Concentrati sul problema da risolvere

Ogni prodotto risolve un problema. Ma troppo spesso siamo così innamorati delle nostre fantastiche funzionalità di prodotto che 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 attività con il tuo prodotto.

Naturalmente, ciò riguarderà le caratteristiche del prodotto, ma le evidenzierà nel contesto dell'aiutare l'utente a capire il motivo per cui ha acquistato il tuo 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 funzionalità specifiche, ma lo fanno nel contesto del motivo per cui qualcuno potrebbe utilizzare quella particolare funzionalità. Si tratta del perché, non solo del come.

Ecco un ottimo esempio...

Gerarchia logica e flusso

Una buona documentazione richiede una gerarchia di intestazioni e sottotitoli che consenta all'utente di sapere cosa mostrerà ogni sezione. E quella gerarchia dovrebbe seguire un flusso logico che aiuti l'utente a imparare a utilizzare il tuo prodotto nel modo più utile.

Ad esempio, probabilmente non vorrai iniziare la tua documentazione mostrando ai clienti come utilizzare le funzioni più avanzate senza prima mostrare loro le basi del funzionamento del tuo prodotto. Inizia prima con le cose facili e poi, man mano che i tuoi utenti sviluppano le loro conoscenze, mostra loro le funzionalità avanzate.

Sommario

Un sommario offre ai tuoi clienti un modo semplice, efficiente e familiare per trovare rapidamente una soluzione alla loro domanda o problema. Si trova proprio all'inizio del documento, quindi non devono setacciare pagine di testo per trovare ciò che stanno cercando. Dovrebbe includere tutte le intestazioni e i sottotitoli principali come descritto sopra.

Rendilo ricercabile

C'è stato un tempo in cui la maggior parte della documentazione per gli utenti veniva stampata. Ora, in un'era in cui quasi tutti hanno accesso a uno smartphone, ha più senso creare documentazione elettronica. Ciò non significa che non puoi creare anche versioni stampate, ma una versione elettronica offre una serie di vantaggi di cui parleremo più dettagliatamente 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 non vedenti o ipovedenti, non udenti o con problemi di udito o che potrebbero avere disabilità cognitive.

Ricorda, molti dei tuoi clienti hanno bisogno di questo per comprendere e accedere completamente alla tua documentazione utente. Non lasciarli indietro!

Buon design

Dai ai tuoi utenti un documento che vogliono guardare e sarà più probabile che lo utilizzino.

Progetta i materiali pensando ai tuoi clienti. Rendilo utilizzabile e amichevole. Evita lunghi paragrafi di testo o pagine troppo piene di contenuti. Consenti spazio bianco per aiutare a rompere la monotonia e rendere meno scoraggiante la prospettiva di apprendere un nuovo prodotto.

Includi grafica e immagini il più possibile da mostrare piuttosto che dire ai tuoi clienti come utilizzare il tuo prodotto. Per la documentazione elettronica, utilizza 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 creare se non ne esiste già una), assicurati che la tua documentazione aderisca ad essa.

I modelli Snagit rendono incredibilmente facile creare documentazione utente dall'aspetto professionale da una serie di schermate o altre immagini. Raccogli semplicemente le immagini di cui hai bisogno, scegli Crea e poi Immagine da modello e sei sulla buona strada.

Snagit viene fornito con una serie di modelli gratuiti progettati in modo professionale e con TechSmith Assets per Snagit, puoi accedere a molto di più!

Feedback da utenti reali e/o beta tester

Non puoi creare una documentazione utente davvero eccezionale finché non hai ascoltato le persone esterne alla tua organizzazione che effettivamente utilizzano i prodotti.

Impara i loro punti deboli e cerca di affrontarli nel miglior modo possibile. Scopri cosa ti dicono che è necessario sapere per utilizzare al meglio i tuoi prodotti. Anche se alcune cose potrebbero sembrare ovvie, ti garantisco che imparerai cose che non hai nemmeno considerato.

Collegamenti 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 elettronica dell'utente, questo può essere semplice come fornire collegamenti a tutorial, domande frequenti, forum utente e altro ancora.

Ma anche la documentazione stampata può includere cose come indirizzi di siti Web e numeri di telefono per ulteriore supporto.

Bonus! Aggiungi istruzioni dettagliate

Le guide dettagliate aiutano a evitare lunghi blocchi di testo e forniscono un modo molto più chiaro per mostrare un processo rispetto al tentativo di spiegarlo solo tramite il testo. Sono più facili da seguire, più facili da capire e offrono un'esperienza molto più intuitiva rispetto al semplice dire a qualcuno come completare un'attività.

E ricorda, includere contenuti visivi nelle istruzioni dettagliate li rende ancora migliori.

Snagit fornisce uno strumento passo-passo facile da usare che ti aiuta a creare un'ottima documentazione passo dopo passo. Inoltre, lo strumento Combina immagini ti consente di combinare schermate individuali e altre immagini in un'unica immagine per semplificare la modifica e il markup.

Come creare un'ottima documentazione per l'utente

Passaggio 1: pianificare

Ogni grande set di documenti utente inizia con un piano. Ecco alcuni suggerimenti su come arrivare dove vuoi andare.

Sapere da dove cominciare

Molte persone presumono che se conosci il tuo prodotto, puoi semplicemente iniziare a creare la tua 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 creare la documentazione, ecco alcune cose da considerare:

• Cosa dovresti includere? Cosa dovresti tralasciare? (Suggerimento: è qui che il feedback degli utenti può essere DAVVERO utile!)
• In quale ordine dobbiamo presentare le informazioni? (Ricordi gli schemi dei saggi a scuola? Usali!)
• 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 determinano 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 in tutto, ma chiunque crei un manuale utente o una guida utente dovrebbe avere un'esperienza pratica con il prodotto.

Affidati ai tuoi esperti in materia per una conoscenza più approfondita, ma dovresti sapere come usarla tu stesso prima di provare a insegnare a qualcun altro.

Scegli il tuo formato

Inoltre, il formato finale di un documento è altrettanto importante. Sarà solo stampato? Sarà elettronico? Se sì, dove vivrà?

Non è passato molto tempo da quando quasi tutta la documentazione per l'utente veniva stampata solo. Tuttavia, a meno che tu non abbia un'ottima 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 lo desiderano. Mettere le risorse utente online 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 la documentazione elettronica accessibile alle persone con disabilità. Una versione di sola stampa funzionerà per la maggior parte delle persone, ma sei pronto a creare una versione braille per utenti non vedenti o ipovedenti? Che dire degli utenti che hanno una disabilità fisica in cui è difficile per loro manipolare oggetti con le mani?

Esistono strumenti per rendere più facile l'accesso alla documentazione elettronica per tutti, ma le versioni solo stampate forniscono un problema di accessibilità molto più difficile.

Inoltre, la documentazione elettronica è molto più facile da aggiornare, poiché vive sul web.

Devo trasformare la mia documentazione in PDF?

Se vuoi offrire una versione PDF scaricabile della tua documentazione, va bene. Ma assicurati che sia disponibile sul tuo sito web anche in un formato non PDF.

Passaggio 2: crea il tuo documento utente

Dopo aver risposto a tutte le domande e aver preso tutte le decisioni sopra descritte, è il momento di creare la documentazione per l'utente. Non ho intenzione di dirti come ESATTAMENTE creare la documentazione per il tuo prodotto specifico, ma ci sono alcune cose chiave da tenere a mente.

• Evita termini gergali e altamente tecnici tranne quando assolutamente necessario (e quindi assicurati di definirli).
• Evita gli acronimi a meno che tu 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, usa quella.
• Non dare per scontato che l'utente sappia nulla del tuo prodotto o di cosa fa. MOSTRA loro quello che devono sapere per avere successo.
• Ricorda di usare un linguaggio semplice. Scrivi per un livello di terza media o inferiore. 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. Invitali a VOGLIA di utilizzare la tua documentazione.

Passaggio 3: provalo

Una guida per l'utente è eccezionale solo se aiuta i tuoi clienti a utilizzare il tuo prodotto al meglio delle loro capacità. E non puoi saperlo finché qualcuno non lo usa. Prima che la tua nuova creazione esca nel mondo in generale, vuoi testarla. Ecco alcuni suggerimenti!

• Best practice: consegnalo a un gruppo di utenti reali o beta tester e guarda come se la cavano. Incorpora il loro feedback nel documento finito.
• Se non disponi del feedback degli utenti del beta test, testalo internamente, preferibilmente con i dipendenti che hanno meno familiarità con il prodotto.
• Ricevi feedback da sviluppatori e ingegneri. Conoscono il prodotto meglio di chiunque altro e possono sottolineare cose che potresti esserti perso.

Passaggio 4: mantieni la tua documentazione aggiornata

Quando il tuo prodotto cambia, dovrai mantenere aggiornata la documentazione per l'utente. 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, i tuoi contenuti sono fantastici solo se sono accurati. Assicurati che ciò che offri ai tuoi clienti li aiuti effettivamente a utilizzare il tuo prodotto.

Riepilogo

Se non ricordi nient'altro, tieni presente che un'ottima documentazione per l'utente dovrebbe essere creata, progettata e presentata in un modo che sia il più utile per i tuoi utenti .

Fornisci loro una documentazione che continui a soddisfarli e fornisca il tipo di esperienza del cliente che vorresti avere.

Rendi la tua documentazione accessibile, utile e visiva.

Fai domande frequenti