Un ottimo manuale è una delle risorse a più alto rendimento che un'azienda possa produrre: consente di diffondere la conoscenza a chiunque ne abbia bisogno. Con Trupeer, puoi risparmiare ore nella stesura dei manuali partendo da modelli di manuale gratuiti, personalizzandoli con le tue linee guida del brand e utilizzando il nostro creatore di manuali AI per trasformare qualsiasi manuale in una presentazione video.

Cos'è un modello di manuale e di quale hai bisogno?

Un manuale è un documento che qualcuno consulta per fare qualcosa correttamente: azionare una macchina, utilizzare un software, seguire un processo o imparare un lavoro. Un modello di manuale è la struttura riutilizzabile che vi sta dietro, che copre le sezioni, le pagine introduttive e le convenzioni che rendono un manuale simile al successivo.

La domanda più difficile è quale manuale stai scrivendo, perché questo termine copre almeno otto documenti diversi con lettori diversi, cicli di vita diversi e peso legale diverso. Un manuale utente per un'applicazione web e un manuale operativo per apparecchiature industriali non hanno quasi nulla in comune oltre al nome.

Sbagliare questa scelta è costoso in un modo specifico. Non produce un cattivo documento. Produce un documento che cerca di essere quattro, che è la modalità di fallimento descritta di seguito.

Un manuale con due firmatari non è un unico manuale

Ecco il test, e richiede circa un minuto.

Elenca tutti coloro che dovrebbero approvare una modifica al tuo manuale. Non esaminarla. Approvarla, nel senso che il documento non può essere ripubblicato senza di loro.

Se quell'elenco ha un solo nome, hai un solo manuale. Se ne ha quattro, hai quattro manuali che qualcuno ha rilegato insieme, e la rilegatura è il motivo per cui nessuno di essi sarà mantenuto aggiornato.

Il meccanismo è semplice e vanifica completamente le buone intenzioni. I contenuti di proprietà di persone diverse cambiano a ritmi diversi. Le dichiarazioni di sicurezza cambiano raramente e necessitano di conformità. Le istruzioni operative cambiano a ogni rilascio e necessitano del prodotto. La risoluzione dei problemi cambia settimanalmente e necessita del team di assistenza. Rilegali in un unico documento e la modifica più semplice possibile erediterà il percorso di approvazione più lento possibile, così la correzione di nove pagine attende la revisione di duecento pagine.

Tutti i soggetti coinvolti si comportano in modo ragionevole in ogni fase e, ciononostante, il manuale diventa comunque obsoleto. Questo è ciò che rende questo fallimento così comune: nessuno fa nulla di male.

Quindi la prima decisione in qualsiasi progetto di manuale non riguarda il modello. Riguarda il numero di manuali presenti, e la risposta corrisponde al numero di firmatari.

Come personalizzare questo modello in Trupeer

Passaggio 1: Apri la sezione Modelli

Vai alla sezione Modelli dalla navigazione principale.

Passaggio 2: Seleziona e apri un modello

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

Passaggio 3: Espandi la visualizzazione 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 modificare 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 in anteprima e perfeziona il modello

Quando desideri 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 i modelli di manuale di Trupeer puoi:

• Risparmiare ore di scrittura: Evita la pagina bianca grazie a strutture collaudate per qualsiasi tipo di manuale.

• Coprire ogni caso d'uso: Modelli per manuali utente, formazione, operazioni, istruzioni e politiche aziendali.

• Rimanere in linea con il brand: Applica il tuo logo, font e colori utilizzando il kit del brand di Trupeer.

• Ridurre il carico di supporto: Manuali chiari aiutano gli utenti ad autogestirsi, riducendo i ticket e i lavori di rifacimento.

• Aggiungere video tutorial: Incorpora video per i passaggi difficili da spiegare con il testo.

• Raggiungere utenti globali: Traduci i manuali in oltre 65 lingue con un solo clic.

I tipi di manuale, chi firma ciascuno e con quale frequenza cambiano

Leggi la colonna delle approvazioni. Quasi ogni organizzazione che pensa di avere un problema con un manuale, in realtà ne ha tre o quattro fusi insieme.

Le due righe che più spesso vengono erroneamente fuse sono il manuale di formazione e il manuale utente. Hanno lettori diversi che fanno cose diverse: uno sta imparando lontano dall'attività, l'altro ci si trova proprio nel mezzo. Un documento che serve a entrambi è troppo lungo da consultare e troppo superficiale da cui imparare.

Modello di manuale gratuito: la struttura condivisa da ogni manuale

Qualunque sia il tipo che stai scrivendo, la parte introduttiva è la stessa ed è la parte che la maggior parte delle bozze salta. Copia da qui.

Titolo e cosa copre. Il prodotto, la versione o il processo a cui si applica, indicati con precisione sufficiente affinché un lettore che ne possiede uno leggermente diverso sappia di doversi fermare.

A chi è rivolto. Il ruolo e le conoscenze iniziali presupposte. "Per operatori addestrati" e "per un utente alle prime armi" producono documenti molto diversi e il lettore dovrebbe essere in grado di capire in cinque secondi quale ha in mano.

Proprietario e approvatore. Un nome per ciascuno. Se si tratta di persone diverse, segnalalo, perché questa differenza è ciò che governa la velocità con cui questo documento può essere modificato.

Versione e data. Numero di versione, data di emissione e cosa è cambiato rispetto all'ultima, in un'unica riga.

Sicurezza e limitazioni. Solo dove il lavoro comporta dei rischi, e posizionato prima delle istruzioni piuttosto che in un'appendice.

Come utilizzare questo manuale. Due o tre righe: va letto per intero o consultato al bisogno, dove si trova l'indice, cosa fare se non copre il tuo caso.

Corpo del testo. La parte specifica per tipo, strutturata in base alla riga scelta sopra.

Cosa fare se questo non aiuta. Un percorso nominato, non un indirizzo di supporto generale.

Copia fino a qui. La riga della versione e i due nomi sono i campi che separano un manuale da un documento generico, e sono le prime cose che vengono tagliate quando qualcuno va di fretta.

Come suddividere un manuale che è già stato scritto

La maggior parte delle persone arriva su questa pagina con un documento esistente in mano piuttosto che con una pagina bianca, quindi questo aspetto conta più del modello.

Stampalo o apri la pagina dei contenuti. Accanto a ogni sezione scrivi un nome: chi deve approvare una modifica a questa sezione. Non chi l'ha scritta.

Raggruppa le sezioni in base a quel nome. Quei gruppi sono i tuoi manuali. In pratica troverai di solito tre o quattro gruppi e una sezione orfana che nessuno vuole possedere, e l'orfana è normalmente già obsoleta.

Suddividi nell'ordine che fa più male, che è quasi sempre quello del contenuto che cambia più spesso pur trovandosi dietro l'approvatore più lento. È lì che si trova il valore ed è solitamente il contenuto operativo o di risoluzione dei problemi intrappolato dietro la conformità.

Non riscrivere durante la suddivisione. Sposta il testo invariato, ripubblica e correggi il contenuto in un secondo momento. Suddividere e riscrivere allo stesso tempo è il modo in cui questi progetti si bloccano al quaranta percento e vengono abbandonati.

Lascia un riferimento incrociato in ogni documento che rimandi agli altri, perché il tuo lettore lo considererà comunque come un unico manuale e lo farà sempre.

Il manuale che è costato undici settimane per modificare nove pagine

Kilnmore Systems produce attrezzature per lavanderie commerciali per hotel e ospedali. Ogni macchina veniva spedita con un Manuale di Uso e Manutenzione di ben centoquarantotto pagine.

Conteneva istruzioni di installazione approvate dall'ingegneria, avvertenze di sicurezza e dichiarazioni di conformità approvate dall'ufficio conformità, istruzioni operative scritte dal team di prodotto, programmi di pulizia anch'essi dal team di prodotto, risoluzione dei problemi dal team di assistenza, un elenco di parti di ricambio dalla catena di fornitura e termini di garanzia dall'ufficio legale. Sette contributori, quattro approvatori, un solo PDF.

Nel 2024, una versione del firmware ha modificato il menu operativo. Circa nove pagine del manuale sono diventate errate.

Aggiornare quelle nove pagine significava riemettere il documento, e riemettere il documento ha innescato una revisione completa della conformità, poiché le dichiarazioni di conformità erano vincolate nello stesso file. Quella revisione ha richiesto undici settimane.

Durante quelle undici settimane, circa trecentoquaranta macchine sono state spedite con un manuale la cui sezione operativa non corrispondeva alla macchina. Le chiamate di assistenza relative al menu sono passate da circa quattro al mese a circa trenta, e sono rimaste a quel livello per due trimestri. Si tratta di circa centosessanta chiamate evitabili a circa ottantacinque sterline l'una, ovvero poco meno di quattordicimila sterline, senza contare l'impatto sul lancio.

Nulla nel manuale era scritto male. Il documento era accurato, completo e ben prodotto. Semplicemente non poteva essere modificato a basso costo, e un documento che non può essere modificato a basso costo sarà errato per la maggior parte della sua vita.

La soluzione è stata strutturale. Quattro documenti suddivisi per approvatore: installazione e sicurezza sotto conformità, la guida operativa sotto prodotto, assistenza e risoluzione dei problemi sotto il team di assistenza, parti e garanzia sotto catena di fornitura e legale. Riferimenti incrociati tra di loro e una singola copertina che li elenca tutti e quattro.

Al successivo rilascio del firmware, la guida operativa è stata aggiornata e ripubblicata in quattro giorni. Il documento di conformità non è stato toccato, perché nulla al suo interno era cambiato.

Come scrivere un manuale che le persone apriranno davvero

Scrivi prima l'indice dei contenuti e mostralo a qualcuno che userà il manuale. La metà degli errori strutturali emerge in quella conversazione, prima che sia stato sprecato del tempo a scrivere.

Scrivi prima la sezione di cui un lettore ha più probabilmente bisogno, non la sezione che viene prima logicamente. Nella maggior parte dei manuali queste sono diverse, e l'ordine che segue l'architettura del prodotto non è quasi mai l'ordine che segue il problema del lettore.

Usa le parole del lettore per i titoli. Le persone cercano in un manuale la cosa che sta accadendo a loro, non il nome del sottosistema responsabile.

Numera i passaggi solo dove l'ordine è veramente importante. Un elenco numerato implica una sequenza, e i lettori seguono le sequenze implicite anche quando sono errate.

Inserisci ogni avvertenza immediatamente prima del passaggio a cui si applica. Un capitolo di avvertenze all'inizio è un artefatto legale, non un'istruzione, e viene letto una volta sola e mai più.

Scoprilo guardando una persona che lo usa senza aiutarla. Ogni esitazione è un difetto. Questo richiede quaranta minuti e rivela più di tre cicli di revisione.

Cosa dovrebbe essere incluso in un modello di manuale?

Al minimo: cosa copre, a chi è rivolto, un proprietario e un approvatore, una versione con data, un corpo del testo strutturato per la situazione del lettore e una via designata per quando il manuale non risponde alla domanda.

Tutto il resto è specifico per tipo. Un manuale utente di un software ha bisogno di screenshot e di una struttura adatta alla ricerca. Un manuale operativo ha bisogno di avvertenze inserite nel testo, un programma di manutenzione e informazioni sulla conformità. Un manuale di formazione ha bisogno di obiettivi e di un modo per verificare che il lettore abbia capito, cose di cui gli altri non hanno affatto bisogno.

Il campo che le persone tralasciano e non dovrebbero è il nome dell'approvatore, per il motivo di cui tratta l'intera pagina.

Modelli di manuale utente per software e applicazioni web

I manuali del software hanno una proprietà che gli altri non hanno: il prodotto cambia continuamente sotto il documento, quindi tutto ciò che scrivi è in declino dal giorno in cui viene distribuito.

Ciò depone a favore di tre cose. Struttura per attività piuttosto che per menu, perché i menu vengono riorganizzati e le attività no. Mantieni ogni argomento abbastanza breve da poter essere aggiornato singolarmente, il che significa un insieme di articoli ricercabili piuttosto che un documento rilegato. E non fare screenshot di cose che cambiano spesso, nominando invece il comando invece di mostrare dove si trova.

Per un'applicazione web in particolare, il manuale è stato ampiamente sostituito da un aiuto all'interno del prodotto e da un centro assistenza ricercabile, e considerarlo come un PDF scaricabile è solitamente un errore. Le strutture per questo tipo di soluzione risiedono nei nostri modelli di articoli della base di conoscenza, che gestiscono il problema del controllo delle versioni meglio di quanto possa fare un modello di manuale.

Laddove sia realmente necessario un unico documento, per gli acquisti, la conformità dell'accessibilità o per un cliente aziendale che lo richiede, generali a partire dagli articoli anziché gestirlo separatamente.

Modelli di manuale di formazione e in cosa differiscono dai manuali utente

Un manuale di formazione viene letto una volta, in ordine, lontano dal lavoro, da qualcuno che non sa ancora svolgere l'attività. Un manuale utente viene consultato al bisogno, sul luogo di lavoro, da qualcuno che per lo più sa già come fare.

Quella singola differenza cambia quasi tutto. I manuali di formazione hanno bisogno di contesto, esempi pratici e un modo per verificare la comprensione. I manuali utente hanno bisogno di rintracciabilità e brevità, e il contesto al loro interno è solo rumore di fondo.

La conseguenza pratica è che non si può creare un manuale di formazione aggiungendo un'introduzione a un manuale utente, che è ciò a cui si riduce la maggior parte dei tentativi. Scrivi prima il manuale utente, poi scrivi il manuale di formazione attorno ad esso, facendo riferimento all'esterno anziché ripetere.

Il nostro modello di manuale di formazione per l'assistenza clienti copre in dettaglio l'aspetto della formazione per una specifica funzione, e la stessa struttura si adatta ad altre.

Modelli di manuale operativo per apparecchiature e lavori regolamentati

I manuali operativi hanno un peso che gli altri non hanno. Quando le apparecchiature sono coperte da normative su macchine, pressione, dispositivi elettrici o medici, il manuale fa parte della conformità del prodotto, non è solo documentazione su di esso. Il contenuto, la lingua, la conservazione e le informazioni di conformità che trasporta possono essere tutti specificati.

Conseguenze pratiche che vale la pena conoscere prima di iniziare. Il manuale deve essere solitamente fornito nella lingua del paese di utilizzo, il che rende la traduzione una questione di conformità piuttosto che una cosa gradita. Le avvertenze devono risiedere insieme al passaggio e la loro formulazione può essere prescritta. I record di quale versione è stata spedita con quale numero di serie potrebbero dover essere conservati per anni. E qualsiasi modifica all'apparecchiatura potrebbe richiedere la riemissione e la rivalutazione del manuale.

Niente di tutto questo costituisce una consulenza legale e i requisiti variano in base alla giurisdizione e alla classe del prodotto. Fai confermare dal tuo ufficio conformità o da uno specialista esterno cosa si applica prima della pubblicazione e conserva il contenuto approvato per la conformità nel proprio documento, in modo che una modifica operativa di routine non lo trascini nuovamente in fase di revisione.

Posso ottenere un modello di manuale in Word, Canva o Google Docs?

Word è adatto per manuali di lungo formato che verranno stampati o spediti come PDF, poiché gestisce sezioni numerate, riferimenti incrociati e un indice generato automaticamente, che sono le tre cose che diventano problematiche oltre le trenta pagine circa.

Google Docs è adatto per manuali scritti in modo collaborativo e consultati online, e i thread dei commenti sono davvero utili durante la revisione. Diventa scomodo alla lunga, quindi si adatta meglio ai manuali di formazione e alle brevi guide utente rispetto a un manuale operativo di duecento pagine.

Canva è adatto per manuali in cui l'aspetto visivo trasporta parte del significato: guide rapide, istruzioni operative su un singolo foglio, qualsiasi cosa da appendere a una parete. È lo strumento sbagliato per un documento con cento riferimenti incrociati.

Scegli in base alla lunghezza e alla destinazione piuttosto che per preferenza. E qualunque cosa tu scelga, conserva il contenuto approvato per la conformità ovunque il tuo approvatore possa firmarlo, che di solito non è lo stesso posto del resto.

Come mantenere aggiornato un manuale senza un progetto di riscrittura

Suddividere il documento risolve il problema delle approvazioni. Non risolve il problema della scrittura, ovvero che aggiornare un manuale significa che qualcuno deve fare screenshot, ritagliare e riscrivere passaggi che conosce già, e quel lavoro non vince mai contro qualsiasi cosa sia urgente.

Trupeer AI elimina la maggior parte di quel costo. Chiunque conosca il processo attuale si registra mentre lo esegue una volta, e l'output è una sezione di manuale formattata con i passaggi e le immagini già al loro posto, pronta per essere modificata anziché scritta da zero. Una modifica operativa di nove pagine diventa un lavoro di un pomeriggio.

Registralo. Personalizzalo con il brand. Traducilo. Trasformalo con Trupeer.

Il creatore di manuali è progettato esattamente per questo, e la stessa registrazione produce un video per la formazione e un documento per la tua base di conoscenza con un branding coerente. La traduzione qui conta più che nella maggior parte dei documenti, perché per le apparecchiature vendute oltre i confini nazionali la versione nella lingua locale è spesso un requisito piuttosto che una cortesia. Le istruzioni di configurazione si trovano nella guida alla configurazione del modello di documento.

Domande frequenti

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

La struttura delle pagine introduttive sopra descritta si incolla in Word e funziona come schema di base per qualsiasi tipo di manuale. Per il corpo di una guida passo-passo, limita ogni passaggio a un'unica azione con il risultato previsto e fermati a circa nove passaggi prima di suddividere in un secondo argomento. Non c'è alcun download protetto e nessun modulo da compilare.

Esiste un modello di manuale di formazione gratuito in Word?

Usa la stessa introduzione, quindi struttura il corpo del testo attorno a ciò che il lettore sarà in grado di fare, piuttosto che attorno alle caratteristiche del prodotto. Obiettivi, poi un esempio pratico, poi la pratica, infine una verifica. Word si adatta bene a questo perché i manuali di formazione vengono solitamente letti in ordine e spesso stampati.

Esiste un modello di manuale utente per Canva?

Canva funziona bene per brevi manuali visivi: fogli di avvio rapido, istruzioni operative su una sola pagina, tutto ciò che verrà appeso. Prendi i campi introduttivi da questa pagina e disponili lì. Per qualsiasi documento abbastanza lungo da richiedere un indice o riferimenti incrociati, usa invece Word o Google Docs.

Esiste un modello di manuale utente per Google Docs?

Copia la struttura sopra indicata in un Google Doc e salvala nel drive del tuo team come modello. Si adatta alla stesura collaborativa e alla lettura online, e i commenti di revisione sono un vero vantaggio. Attenzione alla lunghezza, poiché Docs diventa lento e poco maneggevole con manuali molto lunghi.

Qual è la differenza tra un manuale, una guida e una SOP?

Un manuale è completo e copre un intero prodotto o lavoro. Una guida copre un'attività dall'inizio alla fine. Una SOP (Procedura Operativa Standard) è la procedura autorevole su come la tua organizzazione fa qualcosa, scritta per la conformità interna piuttosto che per un lettore che sta imparando. I manuali contengono spesso guide. Le SOP si affiancano piuttosto che trovarsi all'interno, perché hanno un approvatore diverso.

Quanto dovrebbe essere lungo un manuale?

Tanto quanto richiesto dal suo tipo, il che non è una risposta utile, quindi ecco un test migliore. Qualsiasi manuale che non riesci ad aggiornare in meno di una settimana è troppo lungo, perché non verrà aggiornato. Questo è solitamente un segnale per suddividerlo piuttosto che per tagliare i contenuti.

Chi dovrebbe scrivere il manuale?

Chiunque svolga il lavoro, con la revisione di chi è proprietario del documento. I manuali scritti interamente da una funzione di documentazione a partire da interviste tendono ad essere ben strutturati e leggermente errati nei dettagli, mentre i manuali scritti interamente da professionisti tendono ad essere precisi ma inutilizzabili. La combinazione delle due cose è ciò che funziona.

Con quale frequenza dovrebbe essere rivisto un manuale?

In base a eventi scatenanti piuttosto che a una pianificazione temporale. Quando la cosa che descrive cambia, quando un modello di supporto o assistenza suggerisce che il manuale sta fallendo, quando cambia una normativa e quando il suo proprietario lascia l'azienda. Una revisione pianificata sul calendario arriva quando non è cambiato nulla e manca il momento in cui qualcosa è cambiato.