Come creare un manuale utente: da zero a eroe (guida completa)

Non sei sicuro di come creare un manuale utente per aiutare i tuoi clienti a ottenere più valore dal tuo prodotto?

Un manuale utente è un contenuto che aiuta i tuoi clienti (o dipendenti) a utilizzare il tuo prodotto o servizio in modo efficace. Potresti anche vederlo chiamato guida per l'utente, manuale di istruzioni, manuale del prodotto e così via.

Oltre ad aiutare i tuoi clienti a utilizzare efficacemente il tuo prodotto, la creazione di un manuale utente di alta qualità può anche aiutarti a ridurre il servizio clienti e le richieste di supporto perché gli utenti possono risolvere i loro problemi senza contattare l'assistenza.

In questa guida dettagliata imparerai come creare un manuale utente che aiuti i tuoi clienti a raggiungere il successo.

Per far sì che ciò accada, ecco tutto ciò che tratteremo:

• Diversi tipi di manuali utente
• Dove pubblicare il manuale dell'utente
• Come creare un manuale utente

Scaviamo!

Diversi tipi di manuali utente

Esistono diversi tipi di manuali per l'utente, sia per i clienti che per i contenuti interni.

Prima di iniziare, è importante capire quale tipo di manuale desideri creare, in quanto ciò influenzerà il modo in cui ti avvicini al contenuto.

Di seguito è riportato un breve riepilogo dei diversi tipi di manuali utente:

• Manuale dell'utente : un classico manuale dell'utente insegna agli utenti come utilizzare un prodotto.
• Manuale di formazione : un manuale di formazione insegna agli utenti come eseguire una determinata attività o completare un determinato lavoro.
• Manuale operativo : un manuale operativo è in genere un manuale interno che documenta le operazioni della tua azienda.
• Manuale di servizio : un manuale di servizio si concentra sull'insegnamento agli utenti come mantenere correttamente un prodotto in diversi punti del ciclo di vita del prodotto.
• Procedure operative standard (SOP) - Le SOP sono manuali interni che insegnano ai membri dell'organizzazione come completare correttamente determinati processi "nel modo giusto".

Per le istruzioni riportate di seguito, ci occupiamo principalmente della creazione di un manuale per l'utente rivolto al pubblico. Tuttavia, i principi di base riportati di seguito si applicano a qualsiasi tipo di manuale dell'utente.

Dove pubblicare il manuale dell'utente

La posizione in cui pubblichi il tuo manuale utente dipenderà dal tipo di manuale utente che stai creando.

Per i manuali utente rivolti ai clienti, vorrai quasi sempre pubblicarli sul tuo sito web. In questo modo, gli utenti possono accedere al manuale da qualsiasi luogo.

Inoltre, la pubblicazione del contenuto del manuale dell'utente sul Web consente anche di creare un'esperienza più user-friendly rispetto a un manuale dell'utente fisico, come l'aggiunta di sommari cliccabili e suggerimenti di ricerca in tempo reale.

Tuttavia, per i prodotti fisici, potresti anche voler includere un manuale dell'utente fisico come compagno del tuo manuale basato sul web.

Per i manuali utente interni, in genere vorrai nasconderli dalla visualizzazione pubblica.

Un modo per ottenere questo risultato è renderli disponibili solo su una intranet aziendale. Tuttavia, con così tante persone che lavorano da casa, questo può essere difficile da fare a meno che la tua azienda non disponga di una propria configurazione VPN.

Invece, puoi prendere in considerazione la protezione tramite password del contenuto, richiedendo al dipendente di accedere a un account utente o semplicemente aggiungendo una password per accedere alla pagina.

Per i manuali utente fisici, puoi utilizzare uno strumento di gestione della conoscenza dedicato per aiutarti a pubblicare manuali più complessi. Oppure, per manuali utente più semplici, puoi semplicemente scrivere in Google Documenti e pubblicare da lì: la nostra raccolta di strumenti di scrittura tecnica ha alcuni strumenti utili per semplificarti la vita.

Per pubblicare online il manuale dell'utente, è possibile utilizzare la maggior parte dei software di documentazione o knowledge base. Se desideri uno strumento in grado di gestire manuali utente sia pubblici che interni, puoi prendere in considerazione il plug-in Heroic Knowledge Base open source per WordPress. Ne parleremo più approfonditamente nel tutorial.

Ecco un esempio di un manuale utente online dalla base di conoscenza eroica (e sulla base di conoscenza eroica):

A proposito del tutorial...

Come creare un manuale utente in sei passaggi

Ora che hai alcune informazioni di base, vediamo come creare un manuale utente, partendo da zero e arrivando fino a un manuale utente finito.

1. Crea la tua persona(i) utente

Prima di iniziare a creare qualsiasi contenuto, devi capire a chi è destinato il contenuto, cosa che puoi ottenere creando personaggi utente.

Probabilmente hai già una buona idea di chi sono i tuoi clienti, ma è utile scriverlo per concentrare davvero i tuoi sforzi.

Perché questo è importante?

Bene, ecco un esempio:

C'è una grande differenza tra la creazione di contenuti tecnici per ingegneri meccanici e la creazione di contenuti tecnici per utenti non tecnici.

Per la maggior parte dei prodotti, le differenze non saranno così nette. Ma è comunque importante comprendere i personaggi dei tuoi clienti in modo da poter garantire che il tuo manuale utente abbia un senso per le persone che lo utilizzeranno effettivamente.

2. Identificare i problemi chiave e gli obiettivi

Una volta capito chi sono i tuoi clienti, il passo successivo è capire cosa stanno cercando di ottenere con il manuale utente che stai per creare.

Cioè, qual è l'obiettivo finale (o gli obiettivi finali) delle persone che leggeranno questo manuale?

Capire questo è importante perché lo scopo del tuo manuale dovrebbe essere quello di aiutare i tuoi utenti a raggiungere quell'obiettivo nel modo più efficiente possibile.

In alcuni casi, questo obiettivo finale potrebbe essere una cosa specifica. Ad esempio, se disponi di uno strumento di gestione dei social media, potrebbe essere "programmazione di un post sui social media".

In altri, potrebbe essere un obiettivo più astratto, come "migliorare i nostri processi di gestione dei progetti".

Per i prodotti più grandi, potrebbero esserci più cose che l'utente sta cercando di ottenere, il che ci porta alla sezione successiva.

3. Creare una struttura logica e una gerarchia

Ora che hai capito chi sono i tuoi clienti e cosa vogliono ottenere, puoi iniziare a mappare la struttura del tuo manuale utente.

Vuoi creare una struttura che porti i tuoi utenti da "zero" al raggiungimento degli obiettivi finali che hai elencato nella sezione precedente.

Ecco alcuni suggerimenti per aiutarti a farlo:

1. Pensa a come aiutare i clienti a iniziare a ottenere valore dal tuo prodotto il più rapidamente possibile.
2. Prendine la tua conoscenza personale. Ovviamente sai molto del tuo prodotto, ma i tuoi clienti non avranno quel livello di conoscenza di base.
3. Assicurati di coprire eventuali problemi comuni o dettagli confusi che i tuoi clienti potrebbero incontrare quando provano a utilizzare il tuo prodotto. Questi dovrebbero essere affrontati logicamente nei momenti in cui è più probabile che i clienti incontrino problemi.

4. Scrivere il contenuto del manuale dell'utente

Dopo aver mappato i tuoi contenuti, sei pronto per iniziare a scrivere.

A seconda delle dimensioni del tuo prodotto/organizzazione, potresti scrivere tutto da solo. Oppure potresti dover collaborare con altri membri del team per scrivere il contenuto.

Di seguito sono riportate alcune best practice generali del manuale dell'utente da considerare durante la stesura del manuale dell'utente:

• Utilizza un modello per garantire una formattazione coerente . La creazione di un modello formattato non solo velocizza il tuo lavoro, ma garantisce anche che ogni articolo del tuo manuale sia coerente con gli altri.
• Includi elementi visivi (immagini e video) per aiutare gli utenti . Un'immagine o una GIF ben annotate possono essere più utili delle istruzioni di testo autonome, indipendentemente da quanto dettagliato e completo sia il testo.
• Usa un linguaggio semplice ed evita il gergo . Oppure, quando il gergo è assolutamente inevitabile, assicurati di spiegarlo.
• Mantenerlo breve e al punto . Il tuo obiettivo con un manuale utente dovrebbe essere quello di coprire completamente l'argomento, ma con il minor numero di parole possibile. Non tralasciare informazioni importanti, ma taglia spietatamente qualsiasi contenuto non necessario.
• Usa punti elenco ed elenchi per le istruzioni quando possibile . L'utilizzo di un elenco numerato o puntato può rendere più facile per gli utenti tenere traccia della guida. Oppure, se hai bisogno di più dettagli di quelli consentiti da un elenco, puoi assegnare a ogni passaggio il proprio sottotitolo.
• Usa la voce attiva . La voce passiva può essere particolarmente confusa per le istruzioni in un manuale utente. È la differenza tra “Il prodotto può essere acceso premendo il pulsante rosso” e “Puoi accendere il prodotto premendo il pulsante rosso”. Quest'ultimo esempio (voce attiva) è più chiaro e rende più facile per il lettore inserirsi nelle istruzioni.

Infine, è sempre una buona idea testare le istruzioni del manuale utente come se fossi un utente alle prime armi.

Cioè, una volta che hai scritto un articolo, torna indietro e segui effettivamente quelle istruzioni passo dopo passo per assicurarti di non aver perso nulla.

5. Pubblica il tuo manuale utente

Una volta che hai i tuoi contenuti, l'ultimo passo per andare in diretta è pubblicare il tuo manuale utente per renderlo facilmente disponibile ai tuoi clienti.

Il modo in cui lo fai dipenderà dal tipo di prodotto che stai offrendo. Ad esempio, potresti voler includere una versione fisica del tuo manuale se stai spedendo prodotti fisici.

Tuttavia, indipendentemente dal tipo di prodotto che stai offrendo, ti consigliamo di pubblicare il tuo manuale dell'utente online in modo che le persone possano trovarlo facilmente.

Per aiutarti a farlo, puoi utilizzare il software di knowledge base/documentazione.

Ad esempio, con il plug-in WordPress Heroic Knowledge Base, puoi pubblicare il tuo manuale utente utilizzando il software WordPress open source.

Questo approccio open source ti offre la piena proprietà e il controllo sulla tua piattaforma, pur fornendo molti strumenti utili per aiutare i tuoi clienti a navigare nel tuo manuale utente in modo più efficace:

• Organizzazione delle categorie : puoi facilmente organizzare il tuo manuale utente in categorie logiche e ordinare tali categorie utilizzando il trascinamento della selezione.
• Suggerimenti di ricerca in tempo reale : se i clienti desiderano passare direttamente a un tutorial specifico, possono semplicemente iniziare a digitare nella ricerca e vedere i suggerimenti di ricerca in tempo reale basati sulle loro query.
• Sommario automatico : il plug-in genererà automaticamente un sommario cliccabile per ogni articolo del manuale dell'utente, che aiuta i lettori a saltare direttamente alla sezione che è rilevante per loro.
• Callout/formattazione semplici: puoi aggiungere facilmente callout e altre formattazioni per attirare l'attenzione sugli elementi chiave dei tuoi articoli.
• Widget per le risposte istantanee : oltre a creare una pagina del manuale dell'utente dedicata sul tuo sito, puoi anche aggiungere un widget per le risposte istantanee ricercabili che consente ai visitatori di sfogliare il contenuto del manuale dell'utente da qualsiasi punto del tuo sito.

Se vuoi vedere ancora più opzioni per il software che ti aiuti a pubblicare un manuale utente, puoi leggere i nostri post sul miglior software di knowledge base e sui migliori strumenti di documentazione.

6. Aggiorna e rivedi il tuo manuale utente secondo necessità

La creazione di un manuale utente non è uno sforzo una tantum. Andando avanti, dovrai dedicare del tempo alla revisione e all'aggiornamento dei tuoi contenuti.

Esistono due motivi principali per cui potrebbe essere necessario aggiornare il manuale dell'utente:

1. Hai aggiunto nuove funzionalità al tuo prodotto o modificato il funzionamento delle funzionalità/interfacce esistenti.
2. Vuoi migliorare il contenuto del tuo manuale utente per renderlo più utile.

La prima situazione è ovvia: se modifichi in qualche modo il tuo prodotto, devi aggiornare il manuale dell'utente per tenere conto di tali modifiche.

Tuttavia, è importante tenere conto anche della seconda situazione. Per quanto ci provi, probabilmente non otterrai tutti gli articoli del manuale dell'utente perfetti fin dal primo giorno.

Per aiutare meglio i tuoi utenti, ti consigliamo di aggiornare e rivedere i contenuti manuali a basso rendimento per renderli più utili.

Se pubblichi il tuo manuale utente con uno strumento come Heroic Knowledge Base, include valutazioni di utilità degli articoli integrate in modo da poter vedere facilmente quali articoli devono essere migliorati. Gli utenti possono anche lasciare un feedback di testo sull'articolo, che può indirizzarti a parti specifiche dell'articolo che non aiutano tanto quanto potrebbero essere:

Potresti anche mancare articoli per argomenti con cui gli utenti hanno problemi. Per aiutarti a trovare questi argomenti mancanti, Heroic Knowledge Base include anche analisi di ricerca integrate in modo da poter tenere traccia di quali ricerche non hanno risultati per argomento ( così come le ricerche complessive in generale ):

Crea oggi stesso il tuo manuale utente

Imparare a creare un manuale utente è importante se vuoi preparare i tuoi clienti al successo.

Con i suggerimenti e le migliori pratiche in questo post, ora dovresti avere la conoscenza di cui hai bisogno per essere operativo con il tuo manuale utente.

Per un modo semplice per pubblicare il tuo manuale utente online e aiutare i tuoi clienti a navigarlo, puoi utilizzare WordPress e il plug-in Heroic Knowledge Base.

Heroic Knowledge Base rende facile pubblicare i tuoi articoli e organizzarli secondo necessità. Inoltre, i tuoi clienti possono usufruire di funzioni utili come suggerimenti di ricerca in tempo reale, sommario automatico e altro ancora.

Inizia oggi e pubblicherai il tuo manuale dell'utente in men che non si dica.

Se sei interessato a creare documentazione per migliorare la conoscenza interna della tua azienda, potrebbe interessarti anche il nostro tutorial su come pubblicare un manuale di formazione per il tuo personale.