Gli articoli di guida (how-to) sono uno dei formati di contenuto a più alto traffico sul web. Con Trupeer, puoi risparmiare ore di scrittura per i tuoi contenuti di guida partendo da un modello di articolo gratuito, personalizzandolo con le tue linee guida del brand e trasformando ogni articolo in un video tutorial accattivante che offre ai lettori un secondo modo per apprendere.

Un articolo di guida si rivolge a un lettore che si trova in uno stato d'animo molto particolare. Si trova a metà di un processo, qualcosa non funziona e ha già perso più tempo di quanto avrebbe voluto. Non sta leggendo, sta scorrendo la pagina alla ricerca del punto che possa sbloccarlo.

Quasi tutte le regole sulla scrittura di questi articoli derivano da questo presupposto.

Scarica il modello di articolo di guida

Gratuito, modificabile, senza filigrana.

I tre motivi per cui un articolo di guida fallisce

Ogni fallimento rientra in uno di questi casi e richiede soluzioni diverse.

La maggior parte dei consigli di scrittura affronta la terza fase. La maggior parte degli articoli fallisce nelle prime due.

Fase uno: il titolo

Se il titolo non corrisponde alle parole che il lettore userebbe, l'articolo per lui non esiste.

Scrivi l'attività, non la funzionalità. "Come esportare il report in CSV" è preferibile a "Uso del modulo di esportazione". Le persone cercano ciò che stanno cercando di fare.

Usa il loro vocabolario. Il nome interno che dai a una funzionalità non è quello con cui la chiamano i clienti. Prendi le espressioni dai ticket di supporto e dalle ricerche sul sito.

Inizia con il verbo. "Come reimpostare la password" si legge più velocemente rispetto a "Reimpostazione password: guida".

Sii sufficientemente specifico da non lasciare dubbi. "Come aggiungere un utente" è ambiguo se disponi di tre tipi di utenti. "Come aggiungere un utente amministratore a uno spazio di lavoro" non lo è.

Un'attività per titolo. Se il titolo contiene la congiunzione "e", hai bisogno di due articoli distinti.

Fase due: l'introduzione

Il lettore è atterrato sulla pagina. Ha circa cinque secondi per decidere se è quella corretta.

Il blocco introduttivo risponde a tre domande prima dell'inizio della procedura.

Cosa fa questo articolo. Una sola frase. "Questo articolo spiega come collegare il sistema di contabilità per sincronizzare automaticamente le fatture."

A chi è rivolto. Qualsiasi ruolo, autorizzazione o piano tariffario richiesto. "Per eseguire questa operazione è necessario l'accesso come amministratore."

Cosa serve prima di iniziare. I prerequisiti, indicati prima del passaggio uno anziché scoperti al passaggio quattro.

Quest'ultimo punto evita la frustrazione più comune nella documentazione tecnica, ovvero completare tre passaggi e scoprire che era necessario qualcosa di cui non si dispone. I prerequisiti vanno sempre inseriti all'inizio.

Aggiungi il tempo previsto se superiore a un paio di minuti. "Richiede circa 15 minuti" consente a qualcuno di decidere se iniziare subito o tornare più tardi.

Fase tre: i passaggi

Il momento in cui il lettore porta a termine l'attività o desiste.

• Un'azione per passaggio. Se un passaggio contiene "e poi", dividilo.

• Inizia ogni passaggio con un verbo. "Fai clic su Impostazioni" e non "A questo punto dovresti fare clic su Impostazioni".

• Indica dove prima di cosa fare. "In alto a destra, fai clic su Esporta" dice subito dove guardare.

• Nomina ciò che vedranno. Le etichette esatte dei pulsanti, rispettando maiuscole e minuscole. Se il pulsante dice "Salva e chiudi", scrivi esattamente così.

• Usa gli elenchi numerati. Gli elenchi puntati suggeriscono che l'ordine non sia importante.

• Rimani sotto i dieci passaggi quando possibile. Le attività più lunghe vanno suddivise in fasi con sotto-intestazioni.

• Mostra il risultato. Dopo l'ultimo passaggio, indica cosa dovrebbe accadere ora. "La sincronizzazione viene eseguita ogni ora. Vedrai l'ora dell'ultima sincronizzazione nella pagina delle integrazioni."

• Non spiegare il perché a metà attività. Il lettore sta eseguendo, non studiando. Inserisci le motivazioni in una nota o in un articolo concettuale separato.

Come personalizzare questo modello in Trupeer

Passaggio 1: Apri la sezione Modelli

Vai alla sezione Modelli dal menu di navigazione principale.

Passaggio 2: Seleziona e apri un modello

Fai clic su un modello qualsiasi con cui desideri lavorare per aprirlo.

Passaggio 3: Espandi la vista del modello

Se necessario, espandi la visualizzazione del modello per vedere chiaramente il layout completo e i dettagli.

Passaggio 4: Modifica il modello

Fai clic su Modifica per iniziare a personalizzare il modello selezionato.

All'interno dell'editor puoi:

• Aggiungere nuove sezioni

• Definire o aggiornare le regole di formattazione

• Aggiungere un logo e regolarne la posizione e le relative impostazioni

Passaggio 5: Salva il tuo modello personalizzato

Dopo aver apportato tutte le modifiche necessarie, fai clic su Salva per memorizzare il modello aggiornato come tuo.

Passaggio 6: Visualizza l'anteprima e perfeziona il modello

Se desideri vedere l'aspetto del tuo modello personalizzato, apri l'Anteprima.

Dalla schermata di anteprima puoi continuare a fare modifiche direttamente, se necessario, assicurandoti che il modello appaia esattamente come desideri.

Con un modello di articolo di guida puoi:

• Risparmiare ore di scrittura: Evita la pagina bianca grazie a una struttura pensata appositamente per le guide passo-passo.

• Posizionarti nei motori di ricerca: Le guide ben strutturate con schema HowTo si posizionano bene su Google.

• Mantenere la coerenza del brand: Applica il tuo logo, i caratteri e i colori utilizzando il brand kit di Trupeer.

• Ridurre il carico del supporto: Articoli di guida chiari aiutano gli utenti a trovare risposte in autonomia.

• Aggiungere video esplicativi: Inserisci video tutorial per i passaggi difficili da spiegare a parole.

• Raggiungere lettori in tutto il mondo: Traduci gli articoli di guida in oltre 65 lingue con un solo clic.

Il modello di articolo di guida

Dieci sezioni, di cui quattro molto brevi. La parte principale è costituita da passaggi e risoluzione dei problemi.

Screenshot

La differenza tra un articolo di guida usabile e un muro di testo di istruzioni.

• Uno screenshot per passaggio se l'interfaccia non è ovvia. Non su ogni passaggio, altrimenti l'articolo diventa illeggibile a colpo d'occhio.

• Ritaglia l'area pertinente. Un'immagine a schermo intero costringe il lettore a cercare l'elemento a cui ti riferisci.

• Aggiungi annotazioni leggere. Una sola casella o freccia. Troppe annotazioni si sovrappongono e creano confusione.

• Mostra lo stato, non solo la posizione. Quando un passaggio modifica qualcosa, un prima e dopo vale più di una singola immagine.

• Evita dati personali o dei clienti. Utilizza un account demo e controlla le schede del browser e le notifiche nell'angolo dello schermo acquisito.

• Considera i costi di manutenzione. Gli screenshot diventano obsoleti a ogni modifica dell'interfaccia, e screenshot superati minano la fiducia nell'intero articolo. Questo è il motivo principale per preferire una registrazione rispetto a un'immagine statica.

Risoluzione dei problemi

La sezione che distingue un articolo discreto da uno veramente utile, e quella che più spesso viene dimenticata.

Elenca le tre o quattro cose che solitamente non funzionano, usando le parole del lettore, insieme alla soluzione.

Non appare nulla dopo il passaggio 4. Di solito significa che la connessione non ha ancora completato l'autorizzazione. Attendi un minuto e aggiorna la pagina. Se è ancora vuota, l'account potrebbe non avere l'autorizzazione necessaria.

Il pulsante è grigio/disattivato. È necessario l'accesso come amministratore. Rivolgiti a chi ha configurato lo spazio di lavoro.

Ha funzionato ma i dati sembrano errati. Controlla il filtro dell'intervallo di date, che per impostazione predefinita è impostato sul mese corrente.

Raccogli questi casi dai ticket di supporto reali anziché affidarti all'immaginazione. Se quattro persone ti hanno contattato per lo stesso problema dopo aver seguito l'articolo, quel problema deve essere inserito nell'articolo.

Esempi: inefficace vs efficace

Inefficace: Gli utenti possono configurare le impostazioni di esportazione tramite il modulo di reportistica per ottenere i dati in vari formati a seconda delle esigenze.

Efficace: Per esportare un report in CSV: 1. Apri il report. 2. In alto a destra, fai clic su Esporta. 3. Scegli CSV e fai clic su Scarica. Il file apparirà nella cartella dei download e includerà tutte le colonne attualmente visibili nel report.

Inefficace: Passaggio 3: Configura le impostazioni di integrazione in modo appropriato e salva le modifiche.

Efficace: 3. Inserisci la chiave API del tuo sistema di contabilità. 4. Imposta la frequenza di sincronizzazione su Oraria. 5. Fai clic su Salva e prova. Dovresti vedere un'etichetta verde Connesso.

La prima versione è un unico passaggio che racchiude tre azioni diverse, senza possibilità di capire se ha funzionato. La seconda è composta da tre passaggi distinti con un risultato verificabile.

Titolo inefficace: Guida alla configurazione dell'integrazione

Titolo efficace: Come collegare il tuo sistema di contabilità

Introduzione inefficace: Questo articolo fornisce una panoramica delle funzionalità di esportazione disponibili all'interno della piattaforma.

Introduzione efficace: Questa guida spiega come esportare un report in formato CSV, Excel o PDF. È necessario l'accesso in visualizzazione al report. Richiede circa un minuto.

Tipologie di articoli di documentazione

Un articolo di guida è uno dei quattro tipi fondamentali; mescolarli è l'errore strutturale più comune nella documentazione.

L'errore tipico consiste nello spiegare concetti teorici all'interno di una guida pratica. Il lettore sta eseguendo l'azione e non desidera approfondimenti teorici in quel momento. Inserisci un link all'articolo concettuale e mantieni i passaggi operativi snelli.

L'errore opposto è un articolo concettuale con tre passaggi operativi nascosti nel mezzo, che nessuno troverà nel momento del bisogno.

Lunghezza dell'articolo

Più breve di quanto verrebbe istintivo fare. Un articolo di guida deve riguardare un'unica attività e concludersi lì.

Se supera i dieci passaggi, cerca una suddivisione naturale. "Come configurare X" è spesso in realtà composto da "Come creare X", "Come configurare X" e "Come invitare persone su X", ovvero tre articoli che possono essere trovati autonomamente e collegati in sequenza.

Gli articoli lunghi falliscono anche nella prima fase (il titolo), perché un singolo articolo che copre sei attività può avere un solo titolo, il che significa che cinque di queste attività risulteranno introvabili.

Formati

Word per la stesura e la revisione, poiché le revisioni tracciate e i commenti rendono gestibile il ciclo di feedback. È qui che la maggior parte degli articoli dovrebbe essere scritta prima di essere inserita in un sistema di pubblicazione.

PDF per tutto ciò che va stampato, distribuito durante la formazione o necessario offline. È anche il formato ideale per una guida da allegare a un'e-mail per un cliente.

PowerPoint quando una guida diventa materiale di formazione. Un passaggio per diapositiva, con relativo screenshot, funziona molto bene per una sessione dimostrativa.

Il tuo centro assistenza o knowledge base per qualsiasi contenuto rivolto al cliente che deve essere facilmente rintracciabile e indicizzato, cioè la maggior parte di essi. Word e PDF sono formati di redazione e distribuzione, non di pubblicazione definitiva.

Mantenere aggiornati gli articoli

La documentazione invecchia silenziosamente, e una documentazione obsoleta è peggiore di nessuna documentazione perché gli utenti la seguono e non ottengono il risultato.

Assegna un proprietario a ciascun articolo. Registra la versione del prodotto per cui è stato scritto. Rivedi l'articolo dopo ogni rilascio che interessa quella funzionalità e, in caso contrario, secondo un ciclo di tempo fisso.

Il segnale di manutenzione più affidabile è un ticket di supporto su un argomento già coperto dall'articolo. Ciò significa che l'articolo è errato oppure è corretto ma non è rintracciabile. Entrambi i problemi meritano di essere risolti, ma rimangono invisibili se nessuno li monitora.

Gli screenshot sono l'elemento che richiede più manutenzione in assoluto, aspetto da tenere in considerazione per decidere quanti usarne e come produrli.

Misurare l'efficacia

• Visualizzazioni, che indicano se l'articolo è facile da trovare.

• Ticket di supporto sullo stesso argomento dopo la pubblicazione. Dovrebbero diminuire. In caso contrario, l'articolo non è efficace o non è rintracciabile.

• Termini di ricerca senza risultati, che mostrano quali articoli mancano.

• Tempo sulla pagina, da interpretare con attenzione. Un tempo lungo può indicare un testo approfondito oppure un testo confuso.

• Feedback sull'articolo, se il tuo centro assistenza lo prevede, anche se i tassi di risposta sono solitamente bassi.

• Risoluzione autonoma (Deflection), ovvero gli utenti che hanno visualizzato l'articolo e non hanno poi contattato il supporto.

Il dato più utile in assoluto è il volume di supporto su quel tema prima e dopo la pubblicazione dell'articolo. Tutto il resto è un dato secondario.

Come scrivere un articolo di guida

1. Scopri cosa chiedono effettivamente gli utenti, analizzando i ticket di supporto e le ricerche sul sito. Non indovinare l'argomento a caso.

2. Scrivi prima il titolo, formulandolo come un'attività con le parole del lettore. Se non ci riesci, significa che l'obiettivo non è chiaro.

3. Esegui tu stesso l'attività mentre scrivi o osserva qualcuno che la esegue. Gli articoli scritti a memoria saltano passaggi fondamentali.

4. Elenca i prerequisiti man mano che li incontri.

5. Scrivi un'azione per passaggio, iniziando con il verbo, indicando le etichette esatte dell'interfaccia.

6. Acquisisci gli screenshot o registra mentre procedi, non a posteriori basandoti sulla memoria.

7. Indica il risultato atteso.

8. Aggiungi la risoluzione dei problemi basandoti su ticket reali.

9. Fai testare la guida a qualcuno che non conosce la procedura senza aiutarlo. Ogni domanda che farà rappresenta un punto da correggere.

10. Pubblica e monitora il volume di ticket di supporto su quell'argomento.

Il passaggio nove è l'unico vero test. Un articolo esaminato da qualcuno che conosce già l'attività sembrerà sempre chiaro.

Best practice

• Titoli basati sull'attività e formulati con il vocabolario del lettore.

• Prerequisiti sempre inseriti prima del passaggio uno.

• Un'azione per passaggio, con il verbo all'inizio.

• Etichette esatte dell'interfaccia, rispettando le maiuscole.

• Screenshot ritagliati e con poche e semplici annotazioni.

• Risultato atteso chiarito subito dopo l'ultimo passaggio.

• Risoluzione dei problemi basata su ticket reali.

• Un'attività per articolo, idealmente sotto i dieci passaggi.

• Concetti collegati tramite link, non incorporati direttamente.

• Testato da qualcuno che non ha mai eseguito l'attività.

Errori comuni

• Titoli incentrati sulle funzionalità del prodotto anziché sull'attività dell'utente.

• Prerequisiti scoperti solo al passaggio quattro.

• Passaggi che contengono tre azioni diverse ciascuno.

• Istruzioni vaghe come "configurare le impostazioni in modo appropriato".

• Etichette dell'interfaccia parafrasate anziché riportate fedelmente.

• Screenshot a schermo intero senza alcun ritaglio.

• Dati dei clienti visibili negli screenshot.

• Nessun risultato atteso indicato, per cui il lettore non sa se l'operazione ha avuto successo.

• Assenza di una sezione per la risoluzione dei problemi.

• Spiegazioni teoriche inserite all'interno dei passaggi operativi.

• Sei attività raggruppate in un solo articolo, rendendone cinque non rintracciabili.

• Stesura basata sulla memoria anziché sull'esecuzione reale del processo.

• Revisione effettuata solo da persone che conoscono già la procedura.

• Screenshot mai aggiornati dopo una modifica dell'interfaccia.

Registra l'attività invece di scriverla a memoria

Apri il modello in Trupeer AI, applica il tuo brand kit in modo che gli articoli siano coerenti con la tua documentazione e modifica direttamente qualsiasi sezione. La configurazione si trova nella guida del modello.

Due elementi rendono costosi gli articoli di guida. Scrivere a memoria fa saltare i passaggi che esegui in modo automatico, che sono proprio quelli in cui i lettori si bloccano. Inoltre, la produzione di screenshot richiede tempo ed essi diventano obsoleti a ogni modifica dell'interfaccia, motivo per cui molti articoli mostrano una versione del prodotto che non esiste più.

La registrazione risolve entrambi i problemi. Esegui l'attività una volta e Trupeer AI genererà l'articolo scritto con i passaggi nell'ordine esatto in cui sono avvenuti e con screenshot acquisiti automaticamente, oltre a un video tutorial narrato registrato nello stesso momento. Quando l'interfaccia cambia, è sufficiente registrare nuovamente anziché rifare tutti gli screenshot.

Traducilo in oltre 65 lingue e conserva la raccolta nella tua knowledge base dove i lettori potranno trovarla facilmente.

Registra. Personalizza con il tuo brand. Traduci. Usa Trupeer.

Domande Frequenti

Esiste un modello di articolo di guida gratuito in Word?

Sì. Word è il formato principale e il posto ideale per iniziare la stesura, poiché la revisione con le modifiche tracciate è molto più semplice rispetto a un sistema di pubblicazione. Include l'intera struttura con suggerimenti in ogni sezione. Download gratuito, senza registrazione, senza filigrana.

Esiste un modello di articolo in Word scaricabile gratuitamente?

Sì, e funziona per qualsiasi articolo informativo, non solo per quelli passo-passo. La struttura è valida, con piccoli adattamenti, anche per articoli concettuali, di riferimento e di risoluzione dei problemi.

Esiste un modello di articolo di guida gratuito in PDF?

Sì, come formato di guida stampabile adatto a dispense per la formazione, pacchetti di onboarding e qualsiasi documento di cui un cliente abbia bisogno offline.

Esiste un modello di articolo in PDF?

Sì, sia una versione vuota sia un esempio precompilato, così potrai vedere come si presenta un articolo di guida finito prima di iniziare a scrivere il tuo.

Esiste un modello di articolo di guida gratuito in PPT o PowerPoint?

Sì. La versione PowerPoint trasforma una guida in un percorso di formazione, con un passaggio per ogni diapositiva e spazio per uno screenshot su ciascuna di esse. Funziona bene per sessioni dal vivo, ma è meno indicata come materiale di consultazione successivo, per cui la maggior parte dei team ha bisogno anche della versione in Word.

Posso scaricare un modello di articolo di guida gratuito?

Sì, ogni formato è scaricabile gratuitamente senza necessità di creare un account e senza obbligo di attribuzione.

Qual è il miglior modello di articolo di guida gratuito?

Quello che include i prerequisiti e la risoluzione dei problemi. La maggior parte dei modelli fornisce solo un titolo e i passaggi numerati, che è la parte più semplice. I lettori rinunciano perché scoprono un prerequisito mancante al passaggio quattro o incontrano un problema che l'articolo non menziona; queste due sezioni servono proprio a evitare che ciò accada.

Che cos'è un articolo di guida (how-to)?

Un breve articolo di istruzioni che copre una specifica attività, scritto per qualcuno che sta cercando di portarla a termine in quel preciso momento. Si differenzia da un tutorial, che insegna una materia da zero, e da un articolo concettuale, che spiega il funzionamento teorico di qualcosa.

Cosa deve includere un articolo di guida?

Un titolo basato sull'attività, una sintesi di una frase, il pubblico di riferimento con le eventuali autorizzazioni necessarie, i prerequisiti prima del passaggio uno, il tempo richiesto, i passaggi numerati con una sola azione ciascuno, il risultato atteso, la risoluzione dei problemi per i tre o quattro intoppi più comuni, gli articoli correlati e i metadati con il proprietario e la data dell'ultima revisione.

Come si scrive un buon articolo di guida?

Scrivi il titolo come un'attività usando le parole del lettore, esegui tu stesso l'azione mentre scrivi invece di affidarti alla memoria, elenca i prerequisiti man mano che si presentano, descrivi una sola azione per passaggio con le etichette esatte dell'interfaccia, indica chiaramente quale deve essere il risultato finale e aggiungi soluzioni ai problemi basandoti su ticket reali. Infine, fai testare il documento a qualcuno che non conosce la procedura.

Quanto deve essere lungo un articolo di guida?

Dedicato a una sola attività, idealmente inferiore a dieci passaggi. Se è più lungo, solitamente si tratta di più attività che risulterebbero più facili da trovare come articoli separati collegati in sequenza. Gli articoli lunghi sono svantaggiati anche perché possono avere un solo titolo, rendendo le altre attività invisibili ai motori di ricerca.

Qual è la differenza tra una guida (how-to) e un tutorial?

Una guida serve a chi sa già cosa vuole fare e ha bisogno dei passaggi precisi per riuscirci. Un tutorial istruisce un principiante, di solito con un esempio pratico e spiegazioni più ampie. La differenza sta nello stato d'animo del lettore: l'utente della guida è impaziente e si trova nel bel mezzo dell'attività, l'utente del tutorial ha pianificato del tempo per imparare.

Gli articoli di guida devono includere screenshot?

Sì, per tutto ciò in cui l'interfaccia non è evidente, ritagliati sull'area di interesse e con annotazioni leggere. Non su ogni singolo passaggio, altrimenti l'articolo perde leggibilità. Tieni presente che gli screenshot sono l'elemento che richiede più manutenzione e diventano obsoleti a ogni modifica dell'interfaccia: è un aspetto da valutare prima di inserirne troppi.

Ogni quanto tempo vanno revisionati gli articoli di guida?

Dopo ogni rilascio che interessa quella determinata funzionalità, e secondo un ciclo fisso in caso contrario (di solito ogni sei-dodici mesi). Lo stimolo più utile per un aggiornamento è un ticket di supporto su qualcosa che l'articolo già tratta, il che significa che il testo è errato oppure non è facile da trovare.

Posso personalizzare questo modello di articolo di guida?

Sì, ogni versione è completamente modificabile. Adatta le sezioni agli standard della tua documentazione, anche se ti consigliamo di mantenere i prerequisiti e la risoluzione dei problemi, poiché affrontano i due punti critici in cui i lettori abbandonano più spesso la lettura.

Modelli correlati

• Modello di documentazione tecnica

• Modello di knowledge base

• Modelli di articoli per la knowledge base

• Modello di procedura operativa standard (SOP)

• Modelli di istruzioni di lavoro

• Modello di job aid

• Modello di guida per l'utente

• Modello di documentazione software

• Modello di pagina FAQ