Come scrivere un manuale utente software: la guida definitiva (incluso un modello)

Non sei sicuro di come scrivere un manuale utente software per il tuo prodotto?

Se vuoi aiutare i tuoi utenti a ottenere il massimo dal tuo prodotto nel modo più efficiente possibile, la creazione di un manuale utente di software di qualità è un ottimo punto di partenza.

Fornendo agli utenti i contenuti di cui hanno bisogno per apprendere e risolvere i problemi del tuo prodotto da soli, puoi aiutarli ad avere successo senza che debbano contattare i tuoi canali di supporto umano.

Questo non solo semplifica le cose per i tuoi utenti, ma può anche ridurre le richieste di supporto presso la tua azienda, il che ti fa risparmiare tempo e denaro.

Quindi, come puoi creare il manuale utente del software perfetto per i tuoi utenti? Questo è lo scopo di questa guida.

Per aiutarti a metterti in funzione, ecco tutto ciò che tratteremo in questo post:

• Che cos'è un manuale utente del software
• Come scrivere un manuale utente del software in quattro passaggi, incluso un modello di manuale utente del software
• Best practice per la creazione di contenuti di alta qualità per il manuale dell'utente

Scaviamo!

Che cos'è un manuale dell'utente del software?

Un manuale utente del software è una documentazione che fornisce informazioni su come utilizzare e gestire l'app o il prodotto software.

Il manuale dell'utente del software può includere guide introduttive, istruzioni, glossari, suggerimenti per la risoluzione dei problemi e altri tipi di contenuti simili.

Fondamentalmente, include tutte le informazioni di cui i tuoi utenti hanno bisogno per ottenere valore dal tuo software.

In genere, inizierà con le fasi di installazione, quindi coprirà una panoramica generale dell'interfaccia e come utilizzare le diverse funzionalità, quindi approfondirà la risoluzione dei problemi e le domande frequenti, se necessario. Ancora una volta, condivideremo di seguito un modello di manuale utente del software più dettagliato.

Per vedere un esempio di manuale utente del software, puoi consultare il Manuale utente di Forklift 3, che passa direttamente alla spiegazione dell'interfaccia.

Per un altro esempio, puoi guardare il contenuto della Guida introduttiva di Slack, che passa direttamente alla spiegazione dell'interfaccia di Slack.

Perché è importante creare un manuale utente del software?

Ci sono due motivi principali per creare un manuale utente del software per il tuo prodotto:

1. Migliore esperienza utente : rendendo più facile per gli utenti imparare a utilizzare il tuo software e massimizzare il valore che ricevono dal tuo software, i tuoi utenti avranno esperienze migliori.
2. Onere di supporto ridotto : offrendo agli utenti la possibilità di risolvere i propri problemi, è possibile ridurre l'onere sui canali di supporto umano. Ciò è particolarmente vero se si combina il manuale dell'utente con altri tipi di contenuti di supporto come una knowledge base e/o domande frequenti (FAQ).

Come scrivere un manuale utente software in quattro passaggi

Ora entriamo nella guida generale passo passo su come scrivere un manuale utente del software. Nella sezione successiva, esamineremo anche alcune best practice per il contenuto effettivo del manuale dell'utente.

Se sei interessato a uno sguardo più generale a questi argomenti, abbiamo anche una guida su come creare qualsiasi tipo di manuale utente.

1. Pianificare la struttura del manuale dell'utente del software

Prima di iniziare a creare qualsiasi contenuto per il tuo manuale, devi prima mappare correttamente la struttura del tuo manuale.

Per rendere il tuo manuale il più completo possibile, potresti voler riunire più parti interessate chiave per aiutarti a farlo.

Ad esempio, ciò potrebbe includere il successo dei clienti, le vendite e così via: chiunque sia a conoscenza di come aiutare gli utenti a ottenere il massimo valore possibile dal prodotto. In alcuni casi, potrebbe anche essere necessario coinvolgere più personale tecnico per aiutare con dettagli più avanzati.

Ovviamente, se gestisci un progetto solista, indosserai tu stesso tutti questi cappelli. Questa è la gioia di essere un fondatore solista.

Una volta che hai i possessori di conoscenze pertinenti, puoi costruire lo schema del tuo manuale utente.

Per un modello di manuale utente software approssimativo, puoi seguire qualcosa del genere...

1. Sommario : elenca le diverse sezioni del manuale dell'utente in modo che gli utenti sappiano cosa aspettarsi.
2. Introduzione : spiega lo scopo del manuale utente del software.
3. Requisiti di sistema : specifica tutti i requisiti specifici di cui le persone hanno bisogno per utilizzare il tuo software, come le specifiche hardware, il sistema operativo, ecc.
4. Istruzioni di installazione : descrivono come l'utente può installare il software.
5. Panoramica dell'interfaccia utente : fornisce una panoramica di alto livello dell'interfaccia.
6. Come utilizzare funzionalità specifiche : crea una sezione per ciascuna funzionalità principale che mostri agli utenti come funziona.
7. Domande frequenti : coprono alcune domande comuni che un utente potrebbe avere.
8. Risoluzione dei problemi : condividi i consigli per la risoluzione dei problemi.
9. Glossario : se il tuo software ha una terminologia specifica, potresti voler aggiungere un glossario verso la fine del manuale utente del software.
10. Dettagli di contatto dell'assistenza : spiega come gli utenti possono contattare l'assistenza se hanno bisogno di ulteriore aiuto. Vuoi mantenerlo alla fine in modo che gli utenti cerchino di aiutare se stessi prima di contattare l'assistenza.

Non è necessario seguire esattamente questo modello di manuale dell'utente del software: è solo un punto di partenza per darti un'idea di cosa potresti voler includere.

2. Creare il contenuto del manuale dell'utente del software

Una volta che hai il tuo schema, sei pronto per iniziare a creare il contenuto del manuale utente del software.

La maggior parte dei tuoi contenuti sarà costituita da testo, ma non dimenticare di includere anche immagini, GIF e video pertinenti.

Anche se questo passaggio richiederà probabilmente la maggior parte del tempo, per ora manterremo questa sezione breve perché, nella prossima sezione, condivideremo alcune best practice del manuale dell'utente del software per aiutare il tuo team a creare contenuti efficaci del manuale dell'utente.

Chi scrive i tuoi contenuti dipenderà dalle dimensioni della tua organizzazione e dalla complessità del tuo prodotto. Se non si dispone di un redattore tecnico dedicato nello staff, potrebbe essere necessario assegnare il contenuto al team per il successo dei clienti o al team tecnico, a seconda della complessità del software.

Oppure, se sei un fondatore solista, probabilmente sarai la persona migliore per scrivere il contenuto del tuo manuale poiché hai la comprensione più profonda del tuo contenuto. Puoi sempre assumere un editore per aiutarti a migliorare la tua prima bozza.

3. Pubblica il manuale utente del tuo software

Una volta ottenuto il contenuto per il manuale utente del software, è necessario pubblicare il manuale in modo che gli utenti possano consultarlo facilmente.

La maggior parte del software di knowledge base o di documentazione dovrebbe funzionare bene per un manuale utente del software, sebbene tu possa sempre codificare la tua soluzione se ti senti eccessivamente limitato. Alcune aziende pubblicano anche una versione PDF del manuale dell'utente oltre alla versione web.

Per vedere alcune fantastiche opzioni per la pubblicazione della versione web del manuale dell'utente del software, puoi consultare i nostri elenchi dei migliori software di knowledge base e dei migliori strumenti di documentazione.

Se stai cercando un software manuale utente che ti offra un solido elenco di funzionalità, la piena proprietà dei tuoi contenuti e la flessibilità di personalizzare le cose in base alle tue esigenze, puoi utilizzare il nostro plug-in WordPress Heroic Knowledge Base.

Heroic Knowledge Base è un software open source che estende il sistema di gestione dei contenuti (CMS) di WordPress, anch'esso open source, con tutte le funzionalità necessarie per pubblicare il manuale utente del software.

Avrai la piena proprietà della tua piattaforma, oltre alla flessibilità di adattare ogni elemento secondo necessità. Ma allo stesso tempo, Heroic Knowledge Base include ancora funzionalità integrate per tutte le caratteristiche importanti di cui ha bisogno il tuo manuale utente del software:

• Organizzazione degli articoli : è possibile organizzare gli articoli nel manuale del software utilizzando le categorie. Ad esempio, potresti avere diverse categorie per "Installazione", "Interfaccia", "Utilizzo delle funzionalità", "Risoluzione dei problemi" e così via.
• Funzionalità di scoperta dei contenuti : per aiutare gli utenti a trovare i contenuti pertinenti il ​​più rapidamente possibile, Heroic Knowledge Base include utili funzionalità di scoperta dei contenuti come suggerimenti di ricerca in tempo reale, sommario automatico e altro ancora.
• Sistema di feedback degli utenti : gli utenti possono condividere feedback sull'utilità di ogni articolo, che ti consente di sapere cosa stai facendo bene (e dove devi migliorare).
• Analisi dettagliate : puoi tenere traccia di quali articoli ottengono il maggior numero di visualizzazioni, quali articoli portano alle richieste di supporto più umane, quali termini cercano gli utenti, quali ricerche non restituiscono alcun risultato e altro ancora.

4. Aggiorna il manuale dell'utente del software in base a feedback e modifiche

La creazione di un manuale per l'utente di un software di qualità non è una cosa "una volta per tutte". Una volta pubblicato il manuale, è importante assegnare comunque alle parti interessate chiave l'aggiornamento e la revisione del manuale secondo necessità.

In alcuni casi, questi aggiornamenti potrebbero essere richiesti da una modifica del software. Ad esempio, se aggiungi una nuova funzionalità o modifichi l'interfaccia del tuo software, dovrai aggiornare il manuale dell'utente per tenere conto di tali modifiche.

In altri casi, questi aggiornamenti potrebbero derivare dal feedback degli utenti. Ad esempio, se vedi che gli utenti sono confusi da un determinato articolo, puoi aggiornare quell'articolo per renderlo più utile.

Oppure, se vedi che gli utenti stanno cercando un argomento che non esiste nel manuale utente del tuo software, potresti dover creare un nuovo articolo per trattare quell'argomento.

La pubblicazione del manuale dell'utente con uno strumento come Heroic Knowledge Base ti consentirà di tenere facilmente traccia di questi tipi di analisi in modo da poter monitorare e migliorare il contenuto del manuale dell'utente.

Best practice per scrivere il manuale dell'utente del software

Ora che hai compreso il processo di base su come scrivere un manuale per l'utente del software, esaminiamo alcune best practice per la creazione di contenuti efficaci per il manuale dell'utente.

Comprendi chi è il tuo pubblico

Se desideri creare contenuti utili per il manuale dell'utente, è essenziale sapere per chi stai scrivendo:

• Da dove provengono i tuoi utenti.
• Quello che stanno cercando di ottenere con il tuo software.
• Quali punti dolenti stanno vivendo.
• Il loro livello di conoscenza generale del tuo settore e/o di eventuali aree tecniche pertinenti.
• Per quale azienda lavorano (o se sono utenti singoli).
• Eccetera.

Ad esempio, supponiamo che il tuo software si occupi di Salesforce. Se i tuoi utenti target sono amministratori esperti di Salesforce, i tuoi contenuti appariranno molto diversi rispetto a se i tuoi utenti target fossero gli stessi venditori.

Probabilmente avrai già una buona comprensione dei tuoi utenti target dal tuo lavoro esistente. Tuttavia, se non sei sicuro, puoi utilizzare personaggi dei clienti, sondaggi e interviste per ottenere una comprensione più profonda.

Usa una struttura logica e un'organizzazione

Ne abbiamo parlato nel primo passaggio della sezione precedente, ma è importante organizzare il manuale dell'utente in modo ottimale per consentire agli utenti di ottenere facilmente valore dai contenuti.

Esistono diversi modi per organizzare il manuale dell'utente e potresti utilizzare più approcci in diverse sezioni:

• Esperienza lineare : puoi organizzare il tuo manuale nel modo in cui gli utenti sperimenteranno le cose. Ad esempio, potresti iniziare con "Installazione" come prima sezione e poi passare alla prima azione dopo l'installazione nella sezione successiva.
• Funzionalità : puoi organizzare il contenuto del tuo manuale in base alle diverse funzionalità del tuo software.
• Risoluzione dei problemi : puoi raccogliere i passaggi comuni per la risoluzione dei problemi in un unico punto.

Ancora una volta, va benissimo usare più approcci all'interno del tuo manuale. Ad esempio, potresti iniziare organizzando le cose in modo lineare per il processo di installazione.

Ma una volta che hai coperto l'installazione e gli utenti possono iniziare ad applicare il tuo software in modi diversi, potresti passare a un approccio organizzativo basato sulle funzionalità.

Mantieni la tua scrittura semplice e coerente

Per rendere il manuale utente del software il più accessibile possibile, è importante mantenere la scrittura il più semplice possibile.

Ecco alcune cose da tenere a mente per farlo accadere:

• Non usare gergo o parole confuse : non tutti i tuoi utenti avranno la stessa conoscenza quando si tratta del tuo settore e/o della lingua del tuo prodotto, quindi è importante evitare gergo tecnico non necessario e vocabolario confuso. Puoi testare i tuoi contenuti con strumenti come il test Flesch Reading Ease per trovare problemi.
• Evita la voce passiva : l'uso della voce passiva può creare confusione in un manuale utente. Ad esempio, invece di utilizzare una voce passiva come "È possibile salvare una copia della bozza premendo il pulsante Salva bozza ", è meglio utilizzare una voce attiva come "Premere il pulsante Salva bozza per salvare una copia della bozza."
• Usa frasi brevi : suddividere il contenuto in frasi brevi rende più facile per gli utenti consumare e scansionare il contenuto del manuale dell'utente. Quando possibile, evita i paragrafi lunghi (AKA "muri di testo").
• Rimani coerente : l'uso di termini e formattazioni coerenti renderà più facile per gli utenti comprendere il tuo manuale. Ad esempio, se utilizzi sempre un elenco ordinato per elencare i singoli passaggi in una determinata attività, cerca di mantenere tale formattazione nell'intero manuale dell'utente.
• Evita problemi con la grammatica : assicurati di non avere errori grammaticali che potrebbero rendere più difficile per gli utenti la comprensione del tuo manuale. Puoi verificarlo usando strumenti come Grammarly e Hemingway.

Includi immagini e video dove utile

Mentre il contenuto testuale costituirà la base del tuo manuale utente, è importante includere anche immagini e video dove ha senso.

Il detto che "un'immagine vale più di mille parole" potrebbe essere un cliché, ma può sicuramente essere vero quando stai cercando di spiegare come gli utenti possono ottenere valore dal tuo prodotto software.

Per aiutare a spiegare i concetti del tuo testo, puoi aggiungere immagini con annotazioni o GIF che dimostrino di cosa stai parlando.

Ad esempio, Slack fa un ottimo lavoro nell'annotare le immagini introduttive dell'interfaccia.

I contenuti video possono anche essere utili per alcuni utenti. Tuttavia, dovresti fare attenzione a fare affidamento esclusivamente sui contenuti video, poiché non è sempre un modo ottimale per gli utenti di consumare contenuti manuali del software.

Ad esempio, se un utente sta solo cercando di risolvere un dettaglio specifico, di solito è molto più facile per lui trovare quel dettaglio nel contenuto di testo che in un video.

Crea oggi stesso il tuo manuale utente software

Questo conclude la nostra guida su come scrivere un ottimo manuale per l'utente del software che preparerà i tuoi utenti al successo.

Se desideri il modo più semplice per pubblicare il manuale utente del tuo software, puoi utilizzare il plug-in Heroic Knowledge Base per WordPress.

Heroic Knowledge Base è un plug-in open source che ti consente di sfruttare il CMS di WordPress per creare il tuo manuale utente del software self-hosted completamente sotto il tuo controllo.

Allo stesso tempo, non è necessario sacrificare la funzionalità perché Heroic Knowledge Base offre tutte le funzionalità necessarie per creare un ottimo manuale utente del software. Queste funzionalità includono suggerimenti di ricerca in tempo reale, organizzazione delle categorie, raccolta di feedback degli utenti, analisi e altro ancora.

Se sei pronto per iniziare, acquista Heroic Knowledge Base oggi e avrai un manuale utente dall'aspetto eccezionale in pochissimo tempo.