Vuoi Creare Guide Utente Informative? I Nostri 10 Migliori Consigli Possono Aiutarti!
Product Documentation Product Updates

Do You Want to Create Informative User Guides? Our 10 Top Tips Can Help!

Ciaran Sweet

Ciaran Sweet

September 22, 2021

Leggi questi 10 consigli principali e impara a scrivere guide di documentazione utente migliori!


Share this article:

What You'll Learn

  • Identify effective multimedia elements to enhance user guides and documentation
  • Implement structured, sequential documentation that ensures successful user outcomes
  • Adapt technical content for different audience expertise levels using appropriate language
  • Create organized documentation libraries using Docsie's workspace structure
  • Apply best practices for creating self-service documentation that reduces support workload

Le guide utente sono una parte fondamentale nell'offerta di servizi digitali. I clienti digitali si aspettano di poter accedere all'autoservizio, richiedendo informazioni immediate. Una spiegazione telefonica non è più sufficiente; ore spese a spiegare cose che possono essere illustrate meglio attraverso guide di documentazione utente.

In Docsie, sosteniamo che tutte le aziende dovrebbero creare una biblioteca di guide utente informative per i clienti. Questo permetterà l'autoservizio, ridurrà il carico di lavoro del supporto e fornirà accesso in tempo reale 24/7 alle informazioni di cui i clienti hanno bisogno per utilizzare al meglio il vostro prodotto o servizio.

10 Consigli Principali per Guide Utente e Documentazione in Docsie

Prima di iniziare, avete già un sistema per archiviare, scrivere e pubblicare documentazione?

Visitate la pagina di Onboarding Docsie per collaborazione incentrata sul cliente, ampie opzioni di embedding, traduzioni personalizzate e potenti strumenti di pubblicazione a portata di mano.

Ora che siete entrati nel club, passiamo ai nostri 10 consigli principali!

1 - Arricchisci le Guide Utente con Contenuti Multimediali

Testo, parole, lettere – li usiamo ogni giorno. Purtroppo, la parola scritta non può competere con l'efficacia dei video o l'ispirazione delle immagini.

Quando crei guide di documentazione utente, leggile dalla prospettiva dell'utente. Questa sezione potrebbe essere spiegata meglio con una GIF, un video incorporato o un'immagine annotata? Se sì, aggiungila!

In Docsie puoi aggiungere immagini, incorporare video e integrare contenuti iFrame. Provalo!

Immagini, Video e GIF in Docsie

2 - Crea un Ordine, Non Quello Jedi!

Le istruzioni passo-passo sono il pilastro di ogni ricettario! Quando segui una ricetta, mescoli le uova con la farina in modo casuale? Sai esattamente cosa fare perché segui i passaggi!

Scherzi a parte, assicurati di verificare qualsiasi guida utente con istruzioni sequenziali. Seguendo quei passaggi, ottieni effettivamente il risultato previsto? Istruzioni imprecise che non portano al risultato desiderato sono un grande campanello d'allarme per i clienti. Istruzioni accurate, invece, instillano fiducia e forniscono valore attraverso la condivisione di informazioni.

Crea un ordine usando gli elenchi numerati in Docsie, o con gli Articoli dei Libri Docsie per segmentare la tua documentazione.

Articoli, Scaffali e Spazi di lavoro in Docsie

3 - Adatta i Contenuti per Tutti i Livelli di Lettura

Presupponi che i clienti sappiano distinguere il JavaScript dai tuoi consigli principali? L'uso di gergo e terminologia complessa è generalmente consigliato nel contesto di guide tecniche. Per i non esperti, però, più semplice è il linguaggio, meglio è!

La maggior parte dei lettori vuole solo sapere come fare una cosa e ripeterla. Un approccio è presentare un concetto complesso e di alto livello, per poi ripeterlo in versione semplificata per i non esperti. Questo soddisfa sia gli utenti tecnici che quelli meno esperti in un colpo solo.

"L'intelligenza artificiale implica l'emulazione algoritmica dell'intelligenza umana per aumentare la produttività; l'IA mira a svolgere lavoro replicando l'intelligenza umana tramite codice informatico" – significano la stessa cosa, ma si rivolgono a pubblici diversi.

Usa Docsie per creare Scaffali per non esperti e Scaffali per utenti tecnici. In questo modo puoi avere Libri per assistere entrambi i tipi di pubblico, con hosting completo disponibile attraverso il Portale Docsie.

Esempio di codice complesso semplificato per non esperti in Docsie

4 - Usa i Template e Smetti di Fare le Ore Piccole!

Riscrivi ogni guida utente da zero? Dovresti invece creare template con struttura base e messaggi del brand, per poi costruire attorno a questi contenuti.

Scrivere da zero richiede tempo, impegno e rischia l'incoerenza quando più scrittori lavorano allo stesso progetto. I template sono un ottimo modo per risparmiare tempo durante la scrittura e garantire maggiore coerenza tra le pagine. La fiducia si costruisce su messaggi coerenti e sulla generazione di valore, aspetti che i template promuovono.

Clicca su ...Altro e seleziona Template in Docsie. Qui puoi archiviare template e iniziare nuovi Libri usando il template come fonte!

Template in Docsie Template attivo nell'Editor Docsie

5 - Scrivi Velocemente, Itera Spesso

Nello sviluppo software Agile, il mantra è fallire velocemente e iterare spesso. Applicando questo alle guide di documentazione utente, il tuo staff dovrebbe puntare a scrivere velocemente e iterare spesso.

Questo non significa sacrificare la qualità per la velocità. Permette invece di raccogliere feedback dai clienti con meno sforzo iniziale. Questo feedback può essere sfruttato nelle successive iterazioni della documentazione, aiutando l'azienda a diventare più orientata al cliente.

Docsie Vocally raccoglie il feedback dei lettori, con valutazioni e registrazioni dello schermo per individuare esattamente i contenuti che hanno letto. Provalo mentre scrivi velocemente e iteri spesso!

Vista Feedback di Docsie Vocally

6 - Conoscenza Interconnessa con Link Interni

La tua documentazione contiene link verso altre pagine? Aggiungendo collegamenti a sezioni rilevanti della documentazione, aiuti i lettori a comprendere meglio il tuo prodotto o servizio a livello concettuale.

Quando menzioni una funzionalità specifica, aggiungi sempre un link. Consenti al lettore di accedere rapidamente a quell'informazione, anziché costringerlo a cercare e caricare la pagina da solo. Parli di login all'account? Aggiungi l'URL di login al testo "accedi al tuo account" su quella pagina e su tutte le altre. Rendi la tua documentazione comoda e navigabile all'interno del testo, piuttosto che una biblioteca infinita da sfogliare.

Docsie permette di creare link interni. Basta evidenziare del testo e cliccare sul pulsante 🖇️ nella barra degli strumenti dell'Editor Docsie. Inoltre, puoi rendere i link indipendenti dalla lingua e dalla versione con i link relativi a oggetti.

Creazione di link in Docsie con riferimenti a oggetti

7 - Spolverare e Aggiornare i Contenuti Vecchi

Hai vecchie guide utente e documentazione visibili online? Se hai pubblicato documentazione per la versione 1.2 mentre il tuo prodotto è alla versione 1.3, la tua documentazione non è più rilevante. Invece di pubblicare nuova documentazione per ogni versione, usa il Versionamento Docsie.

Il Versionamento Docsie consente agli utenti di accedere alle versioni storiche e attuali della documentazione. Man mano che vengono rilasciate nuove versioni, le vecchie vengono archiviate pur rimanendo accessibili da un menu a tendina. Tutto questo sulla stessa pagina web, rendendo più facile per gli utenti trovare informazioni rilevanti.

Allo stesso modo, se la tua guida di consigli per il 2021 è ancora pubblicata nel 2022, aggiornala! Cambia il nome, aggiorna citazioni e fonti con ricerche recenti, e verifica che le informazioni siano ancora rilevanti. Spolverala e mantienila sempre attuale; i contenuti possono sempre essere riutilizzati.

Selettore di versione per trovare contenuti più vecchi in Docsie

8 - Suddividi i Compiti, Completali in Gruppi

Quando scrivi, scrivi l'intera pagina in una volta sola senza pianificazione? Parte di questo dipende dalle preferenze personali degli scrittori. Suddividendo i compiti, tuttavia, il lavoro può essere completato più velocemente e con maggiore concentrazione.

Crea una struttura semplice con tag H1 e H2 e brevi descrizioni per ogni sezione. Usala durante la scrittura e affronta le singole sezioni invece di preoccuparti dell'intera pagina. Questo è chiamato schema nell'industria della scrittura. Lo schema offre l'opportunità di ricevere feedback dagli editor prima che inizi la scrittura e funge da quadro di riferimento mentre lo scrittore scrive.

Crea un nuovo Libro in Docsie e aggiungi alcune intestazioni di base e testo per uno schema. Puoi anche aggiungere Attività usando il menu laterale destro, suddividendo il lavoro in piccoli gruppi mentre più membri del team collaborano ai contenuti. La cronologia delle versioni ti permette di tornare indietro se uno scrittore aggiunge contenuti non ottimali – perfetto per scrivere velocemente e iterare spesso!

Calendario per gli assegnatari delle attività in Docsie

9 - Un Indice per Raggiungere Più Lettori

Con documentazione complessa e diversificata, un muro di testo può intimidire i lettori. Questo problema può essere risolto con un Indice completo. Comunemente usato nelle enciclopedie, aiuta gli utenti a identificare e saltare alle informazioni rilevanti, fornendo struttura a un ambiente di portale della conoscenza.

Gli Articoli, gli Scaffali e gli Spazi di Lavoro di Docsie creano un Indice. Questo verrà mostrato automaticamente sul lato sinistro del tuo portale della conoscenza, fornendo un modo facile per navigare attraverso la tua knowledge base. Con questo consiglio, Docsie lo fa per te!

Indice generato automaticamente da Docsie

10 - Padroneggia l'Argomento

Il tuo scrittore è un esperto dell'argomento? Inoltre, è capace di ricercare efficacemente temi con cui potrebbe non avere familiarità? In definitiva, nonostante tutti i nostri consigli, è lo scrittore a determinare la qualità della tua documentazione utente.

Più conosce il tuo prodotto, più accurato sarà il suo lavoro. Consenti agli scrittori la flessibilità di testare e "rompere" il tuo prodotto, poiché gli utenti potrebbero incontrare problemi simili. Meglio ancora, fai una demo del prodotto con il tuo team di vendita, e dai loro esperienza diretta con il processo di vendita e i messaggi contenuti. Questo favorisce ulteriormente la coerenza, trasformando i tuoi scrittori in utenti. Non tutti gli scrittori diventano utenti, ma tutti gli utenti possono diventare buoni scrittori con conoscenze pratiche.

Metti in Pratica Questi Consigli in Docsie!

Grazie per aver letto i nostri 10 consigli principali per migliori guide utente. Ti invitiamo ad applicare questi consigli ai tuoi documenti Docsie!

Docsie è una piattaforma completa di gestione della documentazione che le aziende utilizzano per creare FAQ web, documentazione di prodotto, guide utente, documenti di aiuto e manuali utente. La piattaforma offre collaborazione incentrata sul cliente, ampie opzioni di embedding, traduzioni personalizzate e potenti strumenti di pubblicazione a portata di mano.

Fai la tua mossa iniziando con Docsie oggi stesso, e offri documentazione di qualità ai tuoi clienti!

Related Articles

Ready to Transform Your Documentation?

Discover how Docsie's powerful platform can streamline your content workflow. Book a personalized demo today!

Book Your Free Demo
4.8 Stars (100+ Reviews)
Ciaran Sweet

Ciaran Sweet

A freelance technology writer that covers everything B2B and B2C.