9 suggerimenti per una straordinaria documentazione utente (con esempi)

La documentazione per l'utente è una parte importante del prodotto complessivo consegnato al cliente. Aiuta gli utenti finali ad avere più successo con il tuo prodotto o servizio.

In passato, la documentazione per l'utente veniva fornita tramite un file di aiuto locale sulla macchina dell'utente o un manuale fisico o un opuscolo. Ciò significava che non poteva essere aggiornato o modificato facilmente e che i fornitori di software ricevevano pochissimi dati su come veniva utilizzato il loro contenuto.

Al giorno d'oggi, la documentazione per gli utenti è quasi sempre offerta online, il che ha aiutato gli scrittori tecnici a essere più fantasiosi nel modo in cui assistono gli utenti. Possono raccogliere dati, provare diverse tecniche di apprendimento, eseguire iterazioni più rapidamente e produrre un'esperienza di contenuto più ricca per gli utenti.

È qui che entra in gioco questo post sul blog! io

In questo post, esploreremo cosa puoi fare per migliorare la tua documentazione utente ed esamineremo alcuni esempi di eccellenti contenuti di supporto per gli utenti.

Inizia con un piano

Come la maggior parte delle cose nella vita, è meglio iniziare con un piano e la creazione della documentazione per l'utente non è diversa. Ecco perché vorrai assicurarti di porre a te stesso (e possibilmente a coloro che richiedono la documentazione) molte domande prima di iniziare.

1. Considera il tuo pubblico

Per chi lo stai facendo? L'utente finale? Un amministratore di sistema? Questo contenuto verrà rivisto solo internamente o verrà visualizzato anche esternamente? Per chi stai creando la documentazione per l'utente aiuta a inquadrare le informazioni che condividi.

2. Valuta e tieni a mente il tuo obiettivo finale

Lo scopo principale di qualsiasi documentazione è insegnare qualcosa al tuo pubblico. Dopo aver determinato chi consumerà la tua documentazione, dovrai decidere cosa vuoi che ne traggano.

Qual è l'azione che vorresti che il tuo pubblico potesse eseguire dopo aver esaminato la documentazione? Tenendo presente la risposta a questa domanda, sarai in grado di fornire la giusta quantità di contenuti per l'attività in questione.

3. Assicurati che la tua documentazione per l'utente sia facilmente reperibile

La documentazione utente nascosta è quasi inutile quanto la documentazione utente scadente. È importante assicurarsi che la documentazione per l'utente che crei sia facilmente reperibile a coloro che ne hanno bisogno.

Ciò non significa solo assicurarsi che sia visibile, ma significa anche che gli utenti possono navigare all'interno della documentazione tecnica e trovare rapidamente le risposte alle loro domande.

Più velocemente il tuo pubblico troverà quelle risposte, più sarà felice. Ti farà anche risparmiare tempo dal dover rispondere a domande importanti ma comuni sul tuo prodotto.

Scrittura concisa, forte

Una scrittura forte è essenziale per un'ottima documentazione per l'utente. Ma la scrittura influisce più di come legge o suona la documentazione dell'utente. Può anche influenzare la facilità di navigazione nella documentazione dell'utente.

4. Scrivi titoli e sottotitoli descrittivi

Assicurati che i tuoi titoli siano utili e, soprattutto, specifici. Scrivere titoli o sottotitoli formulati per rispondere a una domanda è spesso il migliore. Inquadrare i titoli in questo modo rende più facile per i tuoi utenti finali trovare ciò che stanno cercando e ti aiuta anche a scrivere articoli che rispondono direttamente alle esigenze degli utenti.

Unbounce fa un ottimo lavoro scrivendo titoli e sottotitoli efficaci nella documentazione dell'utente. Questo rende la loro documentazione facile da navigare. Ogni articolo specifico ha il proprio indice che rende un gioco da ragazzi trovare la risposta a una domanda particolare.

5. Semplifica la navigazione

Fornire informazioni in modo facile da scansionare aiuta gli utenti a risparmiare tempo. Come esseri umani, apprezziamo qualsiasi risparmio di tempo che possiamo ottenere. Inoltre, gli utenti potrebbero non sapere esattamente cosa stanno cercando. È allora che i contenuti facili da sfogliare sono più vantaggiosi.

IBM fa un buon lavoro nel rendere il contenuto della guida facile da sfogliare organizzando un sommario pulito e fornendo argomenti correlati.

6. Rendilo facilmente ricercabile

Google ci ha insegnato che trovare le risposte alle nostre domande è semplice come digitarle in una casella di ricerca. La documentazione della tua guida dovrebbe riflettere questa aspettativa. Se il contenuto della guida non è ricercabile, probabilmente non è molto utile.

L'approfondita knowledge base di Hubspot semplifica il self-service per i propri clienti.

Usa le immagini per migliorare la comprensione

Una buona documentazione per l'utente è altamente visiva. Mentre una scrittura e un testo forti sono essenziali per una documentazione utente eccezionale, le persone imparano meglio quando sono presenti anche elementi visivi.

7. Usa schermate annotate

Gli screenshot annotati sono potenti elementi visivi da utilizzare nella documentazione dell'utente. Rimuovono le congetture per gli utenti mostrando esattamente quali passaggi devono intraprendere.

Con programmi come TechSmith Snagit, è facile aggiungere callout di testo, frecce e altro agli screenshot. Ad esempio, noterai che sto utilizzando schermate annotate che ho realizzato con Snagit in questo post del blog.

Se ti senti ispirato, puoi anche provare lo strumento Step di Snagit che ti consente di identificare parti di un'immagine posizionando callout ordinati mentre punti e fai clic. Ogni volta che fai clic per aggiungere un altro passaggio, il numero avanza automaticamente.

Un'azienda che sta facendo un ottimo lavoro nell'utilizzare la potenza degli screenshot nella propria documentazione è Asana. In tutta la loro fantastica documentazione per l'utente, usano schermate annotate per guidare chiaramente i clienti.

8. Sfrutta il video per mostrare non dirlo

Il video funziona bene per dimostrare un processo. Un sacco di fantastica documentazione per l'utente combina la potenza del video con le istruzioni di testo. Ad esempio, è buona norma utilizzare un breve video per eseguire rapidamente un processo.

Quindi, insieme al video, puoi fornire una guida di testo passo passo a cui gli utenti possono fare riferimento mentre provano il processo da soli. In questo modo non devono guardare il video più e più volte se hanno solo bisogno di un rapido promemoria.

Nei nostri tutorial sui prodotti TechSmith, utilizziamo un video principale per fornire una panoramica completa della funzionalità o dell'argomento di cui stiamo parlando. Quindi, sotto il video, forniamo snippet accompagnati da screenshot o GIF animate per ribadire i punti principali del video.

9. Mostra esempi e risultati finali

Gli utenti devono sapere come appare il completamento di ogni attività con successo. Fornire agli utenti uno screenshot di un risultato finale di esempio è un buon modo per dimostrare il risultato ideale al tuo pubblico.

Un'ottima documentazione per gli utenti consente agli utenti finali di trovare facilmente le risposte alle loro domande, il che crea utenti felici e soddisfatti.

Una parte fondamentale della creazione di una straordinaria documentazione per l'utente è fornire informazioni chiare e facilmente scansionabili. Elementi visivi come screenshot, video o GIF animate sono tutti ottimi modi per comunicare in modo più efficiente ed efficace con i tuoi utenti.