Le guide pratiche (o come-fare) sono uno dei formati di contenuto più utili e più ricercati sul web. Con Trupeer, puoi risparmiare ore nella stesura delle guide pratiche partendo da un modello di guida gratuito, personalizzandolo con le tue linee guida del brand e trasformando ogni guida in un video tutorial accattivante.

Scrivere i singoli passaggi è la parte più semplice di una guida. La parte difficile è decidere cosa includere, in quale ordine e dove fermarsi.

Se sbagli queste tre cose, produrrai il classico fallimento: un documento di quaranta pagine che copre tutto, che nessuno legge, sostituito entro un mese da qualcuno che chiede informazioni a un collega.

Scarica il modello di guida pratica

Gratuito, modificabile, senza filigrana. Vale la pena utilizzare prima il file Excel, perché la definizione dell'ambito è la parte che determina il successo della guida.

Come personalizzare questo modello in Trupeer

Passo 1: Apri la sezione Modelli

Vai alla sezione Modelli dal menu di navigazione principale.

Passo 2: Seleziona e apri un modello

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

Passo 3: Espandi la visualizzazione del modello

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

Passo 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

Passo 5: Salva il tuo modello personalizzato

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

Passo 6: Visualizza in anteprima e perfeziona il modello

Quando vuoi vedere l'aspetto del tuo modello personalizzato, apri l'Anteprima.

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

Con un modello di guida pratica puoi:

• Risparmiare ore di scrittura: Evita la pagina bianca grazie a una struttura creata appositamente per le guide pratiche.

• Migliorare la SEO: Le guide pratiche ben strutturate si posizionano bene nei risultati di ricerca.

• Rimanere fedele al brand: Applica il tuo logo, font e colori utilizzando il kit del brand di Trupeer.

• Ridurre i ticket di supporto: Guide chiare aiutano gli utenti a risolvere i problemi in autonomia.

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

• Raggiungere lettori in tutto il mondo: Traduci le guide in oltre 65 lingue con un solo clic.

Guida o articolo?

Due documenti diversi: scegliere quello sbagliato vanifica gli sforzi.

Se qualcuno che cerca una singola attività finisce sulla tua guida, dovrà cercare la sua parte all'interno di essa, il che rappresenta un'esperienza peggiore rispetto a quella che gli avrebbe offerto un articolo.

L'approccio pratico per la maggior parte dei team prevede entrambi: una guida per inserire qualcuno in un'area e articoli separati per ogni attività, collegati tra loro. Utilizza il modello di articolo pratico per i singoli pezzi.

Definisci lo stato iniziale e lo stato finale

Prima di scrivere qualsiasi cosa, rispondi con precisione a due domande.

Da dove inizia il lettore? Cosa sa già, a quali accessi ha già diritto, cosa ha già fatto? Una guida scritta per qualcuno con più contesto rispetto al lettore reale fallisce nelle prime due pagine.

Dove finisce? Non "capiscono il sistema", ma qualcosa di osservabile. "Possono elaborare un rimborso dall'inizio alla fine, comprese le eccezioni" è uno stato finale. "Hanno familiarità con il modulo rimborsi" non lo è.

Tutto ciò che si trova nella guida deve servire a portare il lettore dal primo al secondo stato, altrimenti va rimosso. Questo singolo test elimina circa un terzo del contenuto dalla maggior parte delle prime bozze.

Definire l'ambito della guida

L'inventario delle attività nel file Excel serve a questo. Elenca ogni attività nell'area, quindi decidi per ognuna.

Tre possibili esiti per attività: includila, inserisci un link o lasciala fuori. Scrivere il motivo è ciò che impedisce all'ambito di espandersi di nuovo in seguito, perché qualcuno lo chiederà.

L'errore di definizione dell'ambito più comune è includere tutto ciò di cui chiunque potrebbe mai aver bisogno, il che produce una guida troppo lunga da leggere e quindi meno efficace per le attività principali rispetto a una più breve.

Ordinamento

L'ordine è più importante in una guida che in qualsiasi altro tipo di documento, perché il lettore la consulta in modo lineare.

• Prerequisiti e accesso per primi. Nessuno può seguire nulla finché non riesce ad accedere.

• Subito dopo, l'attività completa più semplice. Portare a termine una cosa dall'inizio alla fine fin da subito aumenta la fiducia e il contesto per tutto ciò che segue.

• Poi le varianti comuni, basandosi su ciò che ora sanno.

• Eccezioni e casi limite per ultimi. Hanno senso solo quando si è compreso il percorso normale.

• Materiale di riferimento in fondo, non sparso ovunque.

L'istinto di spiegare tutto prima di lasciare che qualcuno faccia qualcosa è l'errore di sequenziamento più comune. I lettori memorizzano di più quando fanno qualcosa per prima cosa.

La struttura della guida

La pagina dell'indice non è opzionale in una guida. È il modo in care un lettore che l'ha già letta una volta torna a cercare una singola cosa.

Anatomia della sezione

Ogni sezione della guida segue la stessa struttura, il che rende l'intero documento facile da consultare.

Titolo della sezione. L'attività, così come la descriverebbe il lettore.

Quando farlo. Una riga di contesto. Le guide si differenziano dagli articoli in questo senso: il lettore sta imparando, quindi un po' di inquadramento aiuta.

Passaggi. Numerati, un'azione ciascuno, verbo all'inizio, etichette esatte dell'interfaccia.

Cosa dovresti vedere. Il risultato atteso.

Attenzione a. Tutto ciò che è specifico di questa attività e che comunemente va storto.

La coerenza tra le sezioni conta più della struttura perfetta per ogni singola sezione. Un lettore che impara lo schema nella prima sezione navigherà nella settima più velocemente.

Un esempio pratico di struttura

Guida: Elaborazione rimborsi. Per: Nuovi agenti di supporto, prime due settimane. Stato finale: Può elaborare qualsiasi rimborso standard o parziale senza assistenza e sa quando inoltrare la richiesta a un livello superiore.

Nota la sezione 3. Copre solo ciò che differisce dalla sezione 2, anziché ripetere l'intero flusso. Le guide che ripetono ogni passaggio per ogni variante diventano lunghe, e la lunghezza è il motivo principale per cui rimangono non lette.

Scrivere i passaggi

Si applicano le stesse regole di qualsiasi scrittura didattica, trattate in modo più approfondito nel modello di articolo pratico.

Un'azione per passaggio. Verbo per primo. Etichette esatte dell'interfaccia con le stesse maiuscole. Indica dove prima del cosa. Numerali. Indica il risultato atteso alla fine.

L'unica differenza in una guida: puoi dare per scontato che il lettore abbia letto le sezioni precedenti. La sezione 6 non ha bisogno di spiegare come aprire la schermata dei rimborsi se la sezione 2 lo ha già fatto. Questa ipotesi è ciò che mantiene una guida più breve rispetto alla somma dei suoi articoli, ed è anche il motivo per cui una guida serve bene a un lettore lineare e male a un lettore che cerca.

Screenshot ed elementi visivi

• Di più in una guida rispetto a un articolo, perché il lettore sta imparando piuttosto che eseguendo e ha più attenzione a disposizione.

• Ritaglia da vicino e annota leggermente, con un solo riquadro o freccia.

• Mostra il risultato, non solo il pulsante, per tutto ciò in cui l'esito non è ovvio.

• Un diagramma per il flusso generale, una volta sola, all'inizio. Le guide beneficiano di una panoramica visiva completa in un modo in cui i singoli articoli non fanno.

• Considera la manutenzione. Ogni screenshot è un aggiornamento futuro. Una guida con quaranta screenshot rappresenta un impegno ricorrente notevole e gli screenshot obsoleti minano l'affidabilità dell'intero documento.

Dove dovrebbe fermarsi una guida

Tre confini naturali.

Al confine del ruolo. Se l'attività successiva spetta a qualcun altro, fermati e indica chi la esegue.

Al confine della frequenza. Qualsiasi cosa venga fatta meno di qualche volta all'anno appartiene a un articolo separato piuttosto che alla guida, perché comunque non verrebbe memorizzata e ne aumenterebbe inutilmente la lunghezza.

Al confine del riferimento. Elenchi di valori, codici, limiti e opzioni sono elementi di consultazione, non di apprendimento. Mettili sul retro o in un documento di riferimento separato.

Una guida che va oltre questi tre limiti diventa un manuale, che è un documento legittimo ma diverso, con un lettore diverso.

Guida, manuale, SOP o istruzioni di lavoro

La sovrapposizione tra una guida e un manuale è reale, e la differenza pratica è se è progettata per essere letta per intero. Una guida lo è. Un manuale è un riferimento da consultare all'occorrenza. Se il tuo documento deve svolgere entrambi i compiti, dividilo, poiché la struttura adatta a uno è errata per l'altro.

Per gli altri: modello di manuale di formazione, modello SOP, modelli di istruzioni di lavoro.

Formati

Word per la scrittura e la revisione, poiché una guida è soggetta a più revisioni rispetto a un articolo e i commenti sono importanti.

PDF per la distribuzione, in particolare quando la guida viene consegnata a qualcuno durante l'inserimento o utilizzata lontano da uno schermo.

PowerPoint quando la guida viene utilizzata anche per la formazione. Una sezione per gruppo di diapositive, e il documento della guida diventa il materiale da lasciare ai partecipanti.

Il tuo centro assistenza se deve essere trovabile tramite ricerca, anche se una guida lunga in un centro assistenza è solitamente meglio suddivisa in articoli con una pagina di indice che li colleghi.

Excel per l'inventario delle attività, prima di iniziare a scrivere.

Testare la guida

Il passaggio che le persone saltano, e l'unico che la migliora in modo affidabile.

Consegna la bozza a qualcuno che corrisponde allo stato iniziale, ovvero un vero principiante nell'area piuttosto che un collega esperto. Chiedigli di seguirla senza aiuto. Siediti con lui e non dire nulla.

Ogni domanda che fa è un difetto. Ogni esitazione segna un passaggio poco chiaro. Ogni punto in cui torna indietro indica un problema di sequenziamento. Prendi nota di tutto invece di rispondere.

Un test con una persona realmente nuova migliorerà una guida più di tre cicli di revisione da parte di persone che già conoscono la materia, perché i revisori che conoscono l'attività non possono vedere ciò che manca.

Gestione della manutenzione

Le guide invecchiano più velocemente di quanto sembri, perché coprono diverse attività e il cambiamento di una sola di esse rende errata una parte della guida.

Assegna un responsabile. Registra la versione del prodotto. Effettua una revisione dopo ogni rilascio che interessa l'area e, in caso contrario, secondo un ciclo fisso.

Se puoi, dividi le versioni per sezione, in modo che la modifica a un'attività non richieda la riedizione dell'intero documento. E tieni una nota delle modifiche all'inizio, poiché chi ha letto la guida tre mesi fa ha bisogno di sapere cosa è cambiato.

Il segnale che una guida è diventata obsoleta è quando le persone fanno domande su argomenti che essa copre. Monitora questo aspetto, poiché significa che il contenuto è errato o che la guida non viene fornita alle persone che ne hanno bisogno.

Best practice

• Definisci lo stato iniziale e finale prima di scrivere.

• Definisci l'ambito con un inventario delle attività, registrando il motivo per cui ciascuna attività è inclusa o esclusa.

• Attività completa più semplice all'inizio, eccezioni alla fine.

• Le varianti coprono solo ciò che differisce dal percorso principale.

• Pagina dell'indice, sempre.

• Struttura coerente tra le sezioni.

• Materiale di riferimento in fondo, non sparso.

• Fermati ai confini del ruolo, della frequenza e del riferimento.

• Fai un test con qualcuno che corrisponde realmente allo stato iniziale.

• Un solo proprietario, un ciclo di revisione, versione annotata.

Errori comuni

• Nessuno stato finale definito, quindi la guida non ha un punto di arresto naturale.

• Tutto incluso, producendo un documento che nessuno legge.

• Tutta la teoria prima della pratica.

• Ogni variante scritta per intero, triplicando la lunghezza.

• Nessun indice, quindi non può essere usata come riferimento in seguito.

• Tabelle di riferimento sparse tra le sezioni.

• Scritto per qualcuno con più contesto rispetto al lettore reale.

• Testato solo da persone che conoscono già l'attività.

• Screenshot ovunque, che poi non vengono mai aggiornati.

• Una guida usata dove era necessario un articolo, così chi cerca finisce all'interno di un documento di quaranta pagine.

• Nessun proprietario designato, quindi decade in silenzio.

Registra il lavoro una volta e ottieni la guida da esso

Apri il modello in Trupeer AI, applica il tuo brand kit in modo che le guide corrispondano all'altra tua documentazione e modifica direttamente qualsiasi sezione. La configurazione è nella guida del modello.

Le due parti costose di una guida sono gli screenshot e il fatto che sia stata scritta a memoria. Scrivere a memoria fa saltare i passaggi che l'autore esegue automaticamente, che sono esattamente quelli in cui un nuovo lettore si ferma. E una guida che copre sei attività richiede abbastanza screenshot che aggiornarli dopo una modifica dell'interfaccia diventa un intero progetto.

Registra ogni attività una volta e Trupeer AI produce i passaggi scritti con gli screenshot acquisiti automaticamente, oltre a una video guida narrata dallo stesso passaggio. Questo ti fornisce il materiale grezzo per ogni sezione, nell'ordine in cui il lavoro avviene effettivamente, e registrare nuovamente dopo una modifica è più veloce che rifare gli screenshot.

Traducila in oltre 65 lingue e conserva il set nella tua base di conoscenza in modo che la guida e le singole video guide vivano insieme. Utile per l'onboarding e la formazione, dove viene utilizzata la maggior parte delle guide.

Registrala. Personalizzala con il brand. Traducila. Usa Trupeer.

Domande frequenti

Esiste un modello di guida pratica gratuito in Word?

Sì. Word è il formato principale, con l'indice, la struttura delle sezioni e la formattazione dei passaggi già impostati. Download gratuito, nessuna registrazione, nessuna filigrana.

Esiste un modello di guida passo-passo gratuito in Word?

Sì, è lo stesso modello. Include il formato dei passaggi numerati con spazio per screenshot, risultati attesi e una nota di attenzione per sezione.

Esiste un modello di guida passo-passo gratuito?

Sì, in Word, PDF, PowerPoint ed Excel. Se hai bisogno solo di una singola attività piuttosto che di una guida completa, il modello di articolo pratico è la soluzione più breve.

Esiste un modello gratuito di guida per l'utente passo-passo in Word?

Sì. Una guida per l'utente è una guida pratica rivolta all'utente finale di un prodotto, quindi si applica la stessa struttura. Aggiungi una sezione panoramica del prodotto all'inizio e tieni il materiale di riferimento, ovvero impostazioni, limiti e opzioni, alla fine anziché mescolato tra le attività.

Esiste un modello di guida pratica gratuito in PDF?

Sì, come formato di distribuzione e come esempio completo in modo da poter vedere una guida finita prima di scrivere la tua.

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

Sì. La versione PowerPoint serve per presentare la guida come formazione, con un gruppo di diapositive per sezione. La maggior parte dei team ha bisogno anche della versione Word, poiché una presentazione è un pessimo materiale di consultazione in seguito.

Esiste un modello di guida pratica gratuito in Excel?

Sì, sebbene Excel contenga l'inventario delle attività piuttosto che la guida vera e propria. Elenchi ogni attività nell'area, contrassegni ciascuna come inclusa, collegata o esclusa e registri il motivo. La definizione dell'ambito determina se la guida funziona e farlo in un foglio di calcolo prima di scrivere evita di dover riscrivere in seguito.

Posso scaricare un modello di guida pratica gratuito?

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

Cos'è una guida pratica (how-to guide)?

Un documento che porta un lettore dal non sapere come fare qualcosa all'essere in grado di farlo, coprendo diverse attività correlate in sequenza. Si differenzia da un articolo, che copre un'attività per qualcuno che è già a metà del lavoro, e da un manuale, che è materiale di riferimento piuttosto che qualcosa da leggere per intero.

Cosa dovrebbe includere una guida pratica?

Un titolo che indichi cosa sarà in grado di fare il lettore, a chi è rivolta e quali conoscenze si presumono, lo stato finale come competenze, prerequisiti, un indice, sezioni che coprono un'attività ciascuna, risoluzione dei problemi consolidata, materiale di riferimento in fondo, una fonte di aiuto indicata e dettagli su versione e proprietario.

Come si scrive una guida passo-passo?

Definisci da dove inizia e dove finisce il lettore, crea un inventario delle attività e decidi cosa includere o escludere, ordina dall'attività completa più semplice alle eccezioni, scrivi un'azione per passaggio con etichette esatte dell'interfaccia, aggiungi i risultati attesi, quindi provala con qualcuno che corrisponda realmente allo stato iniziale e correggi tutto ciò su cui inciampa.

Quanto dovrebbe essere lunga una guida pratica?

Il tempo necessario per raggiungere lo stato finale e non oltre. La disciplina sta nella definizione dell'ambito piuttosto che nel conteggio delle parole: ogni sezione deve far avanzare il lettore verso la capacità finale definita e tutto ciò che non lo fa deve essere rimosso. La maggior parte delle prime bozze perde circa un terzo del contenuto con questo test.

Qual è la differenza tra una guida e un manuale?

Una guida è progettata per essere letta per intero e rende qualcuno competente. Un manuale è materiale di riferimento che copre tutto ciò che riguarda un prodotto, consultato all'occorrenza anziché letto da cima a fondo. Se il tuo documento sta cercando di fare entrambe le cose, dividilo, perché la struttura adatta alla lettura sequenziale è errata per la ricerca di informazioni.

Qual è la differenza tra una guida pratica e una SOP?

Una guida insegna a qualcuno un'area di lavoro e include alcune motivazioni. Una SOP standardizza il modo in cui viene eseguita una procedura specifica, viene seguita anziché appresa e di solito include responsabili, approvazione e un ciclo di revisione. Una guida potrebbe fare riferimento a diverse SOP.

Come si testa una guida pratica?

Dala a qualcuno che corrisponde realmente alle conoscenze iniziali presunte, chiedigli di eseguirla senza assistenza e osserva senza aiutare. Ogni domanda è un difetto e ogni esitazione indica un passaggio non chiaro. I revisori che conoscono già l'attività non possono vedere cosa manca, motivo per cui un test con un principiante è preferibile a diversi cicli di revisione da parte di esperti.

Ogni quanto tempo deve essere aggiornata una guida pratica?

Dopo qualsiasi modifica che influisca sulle attività che copre e, in caso contrario, secondo un ciclo fisso, in genere ogni sei-dodici mesi. Dividi le versioni per sezione, ove possibile, in modo che la modifica di un'attività non richieda la riemissione dell'intera guida.

Posso personalizzare questo modello di guida pratica?

Sì, ogni versione è completamente modificabile. Vale la pena mantenere coerente la struttura delle sezioni anche se ne cambi il contenuto, poiché una struttura prevedibile è ciò che rende navigabile una guida con più sezioni.

Modelli correlati

• Modello di articolo pratico

• Modello di manuale di formazione

• Modello SOP

• Modelli di istruzioni di lavoro

• Modello di aiuto sul lavoro

• Modello di documentazione tecnica

• Modello di base di conoscenza

• Modello di documentazione dei processi

• Modello di guida all'inserimento dei nuovi assunti