Un ottimo manuale d'uso del software trasforma gli utenti confusi in utenti sicuri di sé. Con Trupeer, puoi risparmiare ore nella scrittura della documentazione software iniziando con un modello gratuito di manuale d'uso del software, personalizzandolo con le tue linee guida del brand e utilizzando il nostro creatore di manuali AI per trasformare le dimostrazioni di prodotto in video manuali rifiniti.

Che cos'è un modello gratuito di manuale d'uso del software?

Un modello gratuito di manuale d'uso del software è una struttura riutilizzabile per un documento completo e versionato che descrive come utilizzare un software, prodotto come deliverable piuttosto che come sito web dinamico.

Questa distinzione è il motivo per cui questo documento esiste ancora in un mondo di siti di supporto. I manuali vengono prodotti quando la documentazione deve essere completa, fissa e autonoma: software distribuiti on-premise, prodotti venduti in ambienti regolamentati, sistemi in esecuzione su reti senza accesso esterno e contratti in cui un manuale è un deliverable esplicitamente richiesto.

Se il tuo software è un prodotto in hosting e i tuoi utenti raggiungono la documentazione tramite un motore di ricerca o un link di aiuto all'interno del prodotto, desideri un sito di supporto piuttosto che un manuale, e la pagina della guida all'uso del software spiega come dovrebbe essere strutturata.

Il modello non è il manuale. Gli elenchi di sezioni per i manuali sono ampiamente pubblicati e ampiamente intercambiabili. Ciò che decide se un manuale funziona nella pratica è il modo in cui gestisce il problema descritto di seguito, che i siti di supporto non devono mai affrontare e che quasi nessun modello affronta.

Il formato segue la distribuzione. Un file Word modello di manuale d'uso del software gratuito è il luogo in cui questi vengono scritti e revisionati. Un file PDF modello di manuale d'uso del software gratuito è ciò che viene distribuito, perché un manuale è un record fisso e un PDF è l'unico formato comune che si comporta come tale. Per abbinarlo a una versione video, passa il PDF attraverso un convertitore da PDF a video. Un layout PPT modello di manuale d'uso del software gratuito è adatto alla formazione derivata dal manuale, e un file Excel modello di manuale d'uso del software gratuito è adatto all'inventario dei contenuti che sta dietro ad esso piuttosto che al documento stesso.

Un manuale è un'istantanea, un sito di supporto è un flusso

Un sito di supporto ha una sola versione: quella attuale. Quando il software cambia, la pagina cambia e ogni lettore vede la nuova pagina. Le vecchie versioni non persistono perché esiste sempre e solo una singola copia.

Un manuale si comporta in modo opposto. Lo produci, lo distribuisci e da quel momento le copie esistono indipendentemente da te. Si trovano sui file server dei clienti, in cartelle stampate, allegati a vecchie email e all'interno dei record di approvvigionamento. Non puoi aggiornarli e spesso non puoi sapere chi possiede quale versione.

Nel frattempo il software si evolve. Nel giro di un paio d'anni avrai una base clienti distribuita su molte release, che leggono tutti documenti prodotti in momenti diversi, e nessun modo affidabile per sapere quale documento stia leggendo un determinato lettore.

Questo è il problema fondamentale di un manuale software ed è del tutto assente in un sito di supporto. Ogni decisione di progettazione descritta di seguito deriva da questo.

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 vuoi vedere come appare il 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 manuale d'uso del software puoi:

• Risparmiare ore nella scrittura: Salta la pagina vuota con una struttura creata appositamente per la documentazione software.

• Ridurre i ticket di supporto: Manuali chiari aiutano gli utenti a trovare risposte da soli, riducendo significativamente i ticket.

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

• Migliorare l'adozione: Gli utenti che comprendono il tuo software lo usano di più e rimangono clienti più a lungo.

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

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

Il problema della versione e cosa fare al riguardo

Si verificano regolarmente tre tipi di errori, e tutti e tre sono facili da prevenire al momento della scrittura.

Il lettore non sa quale versione descriva il suo manuale. Quasi tutti i manuali riportano la versione sulla copertina e da nessun'altra parte. Un lettore che apre un PDF e cerca al suo interno, che è ciò che fa la gente, atterra a pagina novantaquattro e non vede mai la copertina. Inserisci la versione del software nel piè di pagina di ogni pagina. Costa un solo campo in un modello ed elimina la forma più comune del problema.

Il lettore non sa quale versione sta eseguendo. Spiega come verificarlo, nelle prime pagine, in una sola riga. La maggior parte dei manuali presume che il lettore lo sappia, ma molti utenti non lo sanno.

Il manuale non indica quando è apparsa una funzionalità. Un lettore su una versione precedente segue un'istruzione per qualcosa che non esiste ancora, conclude che il software è rotto e contatta il supporto. Contrassegna le funzionalità con la versione che le ha introdotte e contrassegna qualsiasi cosa il cui comportamento sia cambiato con la versione in cui è cambiato. Questo richiede più lavoro rispetto agli altri due punti, ma previene gli errori più costosi.

Aggiungi un'ultima cosa, che non riguarda il lettore ma te stesso. Mantieni disponibile sul tuo sito di supporto ogni versione pubblicata del manuale, invece di mostrare solo l'ultima. Un cliente su una versione precedente ha bisogno del manuale per quella specifica versione, e ospitare solo quella corrente garantisce che utilizzerà il documento sbagliato.

Cosa deve contenere un manuale d'uso del software

Dieci componenti. I primi due e gli ultimi due sono ciò che distingue un manuale da un sito di supporto.

Il requisito di completezza merita di essere enunciato esplicitamente. Un manuale non può rimandare a contenuti live per qualsiasi cosa di cui un lettore abbia realmente bisogno, perché potrebbe essere letto in un ambiente senza accesso alla rete o dopo che la pagina collegata è stata spostata. Tutto l'essenziale deve trovarsi all'interno del documento.

Modello gratuito di manuale d'uso del software: la struttura da copiare

Compilato con un esempio reale invece di segnaposto. Il software è un sistema informativo di laboratorio distribuito on-premise.

Copia da qui.

Copertina. Nome del prodotto. Versione software 11.2. Revisione del manuale C. Pubblicato il 14 marzo. Si applica solo alle versioni da 11.0 a 11.2.

Piè di pagina, su ogni pagina. Nome del prodotto, versione software 11.2, revisione C, numero di pagina. Questa è la riga più utile di tutto il documento.

Come verificare la versione. Seleziona Aiuto, poi Informazioni su. La versione appare come un numero del tipo 11.2.4. Se i tuoi primi due numeri non sono 11.2, questo manuale non descrive il tuo sistema, e il manuale corretto per la tua versione si trova sul sito di supporto sotto Archivio Documentazione.

Cosa è cambiato nella revisione C. L'archiviazione è diventata reversibile nella versione 11.0. Nelle versioni precedenti l'archiviazione è permanente e non può essere annullata dall'interno dell'applicazione. Vedi il capitolo nove. La rietichettatura dei campioni ha ottenuto un secondo passaggio di conferma nella versione 10.4.

Destinatari. Personale di laboratorio che esegue la gestione ordinaria dei campioni e la refertazione. Si presuppone che ti sia stato assegnato un account utente e che tu abbia completato l'addestramento locale. Non copre l'amministrazione del sistema, che si trova nel manuale dell'amministratore.

Guida rapida. Accesso, schermata principale e completamento di una registrazione di campione dall'inizio alla fine.

Capitoli sulle attività. Organizzati in base a ciò che fanno le persone. Registrazione dei campioni. Registrazione dei risultati. Refertazione. Ricerca nei record storici. Archiviazione. Ogni pagina di attività dichiara i propri prerequisiti e riporta l'applicabilità della versione nel piè di pagina.

Indicatori di disponibilità delle funzionalità. Utilizzati ovunque, sotto forma di: Disponibile dalla versione 10.4. Comportamento modificato nella versione 11.0. Questi appaiono accanto all'istruzione pertinente anziché in un'appendice.

Riferimento. Definizioni dei campi, codici di stato, messaggi di errore con relativi significati, scorciatoie da tastiera.

Risoluzione dei problemi. Dodici voci tratte dalla coda del supporto, ciascuna con sintomo, causa probabile e risoluzione.

Indice analitico. Reale, che copre sia i termini usati dagli utenti sia quelli usati dall'interfaccia, in modo che un lettore che cerca "rimborso" trovi la pagina della nota di credito.

Supporto. Telefono, portale, orari e quali informazioni tenere pronte. Incluso perché un utente che legge questo documento potrebbe non avere altre vie di comunicazione.

Copia fino a qui.

Esempio di manuale d'uso del software: il sessantuno percento su una versione diversa

Denholm Clinical Systems, un'azienda di circa centoventi persone, fornisce un sistema informativo di laboratorio a ospedali e laboratori privati. Il software è installato presso le sedi dei clienti e i clienti effettuano gli aggiornamenti secondo le proprie pianificazioni.

Il manuale contava duecentoquaranta pagine, prodotte come PDF ed emesse con ogni release. Era ben scritto e completo.

Il sito di supporto ospitava un solo manuale: l'ultimo.

Il sessantuno percento della base installata eseguiva una versione più vecchia di quella descritta nel manuale corrente. Diversi siti erano indietro di due versioni principali, il che non è insolito in quel settore, dove gli aggiornamenti richiedono una validazione.

Un laboratorio che eseguiva la versione 8.4 doveva archiviare quattordici mesi di record storici. Hanno aperto il manuale corrente, revisione per la versione 11.2, e letto il capitolo sull'archiviazione. Vi era indicato che i record archiviati potevano essere ripristinati dalla scheda Archivio in qualsiasi momento.

Ciò era vero a partire dalla versione 11.0. Sulla 8.4, l'archiviazione era permanente.

Hanno archiviato quattordici mesi di record. Non c'era alcun ripristino. Il recupero ha richiesto il ripristino da un backup, operazione che ha comportato tre giorni di inattività del laboratorio e l'intervento sul posto di un tecnico del fornitore, per un costo di circa quarantaseimila sterline tra il lavoro di recupero e l'interruzione del servizio. Ne è seguito un reclamo formale, ed era giustificato.

Nulla nel manuale era inesatto. Ogni affermazione contenuta era vera per la versione 11.2. La copertina indicava 11.2. Il lettore aveva effettuato una ricerca nel PDF, era atterrato a pagina centoquarantuno e aveva letto un'istruzione corretta per un software che non stava eseguendo.

Ne sono seguiti tre cambiamenti, nessuno dei quali costoso.

La versione è stata inserita nel piè di pagina di ogni pagina. Un'istruzione di una sola riga su come verificare la propria versione è stata inserita vicino all'inizio. Le funzionalità e i comportamenti hanno ottenuto indicatori di disponibilità, per cui ora il capitolo sull'archiviazione specifica che il ripristino è disponibile a partire dalla versione 11.0 e che l'archiviazione è permanente sulle release precedenti.

Il quarto cambiamento ha riguardato l'hosting. Ogni revisione del manuale pubblicata è stata inserita nel sito di supporto all'interno di un archivio di documentazione, in modo che un cliente sulla 8.4 potesse trovare il manuale della 8.4.

I ticket di supporto attribuibili alla confusione sulle versioni sono passati da circa ventitré al mese a quattro.

Il lettore non aveva fatto nulla di male. Aveva utilizzato l'unico manuale reso disponibile dal fornitore.

Come scrivere un manuale d'uso del software in sei passaggi

1. Decidi se hai effettivamente bisogno di un manuale. Se i tuoi utenti hanno accesso alla rete e raggiungono la documentazione tramite ricerca, un sito di supporto li serve meglio. I manuali servono per documenti distribuiti, fissi e completi.

2. Fissa prima di tutto lo schema delle versioni. Quali versioni del software copre questo manuale e qual è la numerazione delle revisioni del manuale stesso. Entrambe vanno nel piè di pagina.

3. Struttura per attività, non per menu. La struttura dei menu del prodotto descrive come è stato costruito. Gli utenti arrivano con qualcosa che stanno cercando di fare.

4. Segna la disponibilità mentre scrivi. Notare che una funzionalità è arrivata in una particolare versione è banale durante la scrittura e quasi impossibile da ricostruire in seguito.

5. Prendi la risoluzione dei problemi dalla coda del supporto. I tuoi ticket più comuni sono il capitolo già prioritizzato.

6. Costruisci un vero indice analitico. Includendo le parole usate dagli utenti, non solo quelle usate dall'interfaccia. In un documento distribuito, l'indice funge da funzione di ricerca.

Il passaggio quattro è quello che viene rimandato ed è quello che previene gli errori che costano denaro.

Quando serve un manuale piuttosto che un sito di supporto

Cinque situazioni in cui un manuale è la risposta corretta, al di fuori delle quali un sito di supporto di solito vince.

Software installato on-premise, aggiornato secondo la pianificazione del cliente. I tuoi utenti sono distribuiti su varie versioni e non possono essere serviti tutti da un'unica pagina corrente.

Ambienti senza accesso alla rete esterna. Strutture protette, sistemi di controllo industriale, dispositivi medici, difesa. La documentazione deve essere presente localmente e completa.

Prodotti regolamentati. Laddove la documentazione fa parte di ciò che è stato valutato o certificato, deve essere fissa, versionata e recuperabile. Gli ambienti validati richiedono spesso specificamente il manuale per la versione validata. Qualsiasi manuale che faccia parte di una presentazione normativa o di un prodotto certificato deve essere esaminato rispetto allo standard applicabile da una persona qualificata, e nulla in questa pagina sostituisce tale verifica.

Deliverable contrattuali. Laddove un manuale è una voce esplicitamente menzionata in un contratto o in un piano di approvvigionamento, i requisiti del contratto regolano il formato e il contenuto.

Prodotti in cui l'utente non ha canali di supporto. Distribuzione fisica, vendite spot, apparecchiature a lungo ciclo di vita. Il manuale è tutto ciò che avranno a disposizione.

Il miglior modello gratuito di manuale d'uso del software per ognuno di questi casi è quello che sopravvive all'essere ripubblicato quattro volte all'anno. Se nessuno di questi casi è applicabile, la risposta onesta è che stai producendo un manuale per abitudine, e un sito di supporto servirebbe meglio i tuoi utenti costando meno in termini di manutenzione.

Manuale d'uso del software, guida all'uso o manuale d'istruzioni?

Tre termini con utilizzi sovrapposti, e differenze che vale la pena conoscere quando si sceglie una struttura.

Un manuale d'uso del software è completo, versionato e distribuito. Presuppone che il lettore possa non avere altre risorse e nessun modo per fare domande.

Una guida all'uso del software è lo stesso contenuto nella tradizione online continuamente aggiornata, accessibile tramite ricerca e gestita pagina per pagina. Si applicano regole strutturali diverse, trattate nella pagina della guida all'uso del software.

Un manuale d'istruzioni di solito accompagna apparecchiature fisiche, dove si applicano contenuti di sicurezza, posizionamento delle avvertenze e obblighi di legge che la documentazione del software non comporta. La pagina del manuale d'istruzioni tratta questa tradizione.

In pratica, i team hanno spesso bisogno sia di un manuale sia di un sito di supporto, con il manuale generato dallo stesso contenuto sorgente al momento del rilascio. Questa è la soluzione a cui mirare, perché mantenere due set indipendenti di documentazione produce due set che non concordano tra loro.

Cosa non può risolvere un modello gratuito di manuale d'uso del software

Un solo manuale per molte versioni. Nessuna struttura risolve questo problema. Solo pubblicare un manuale per versione e mantenere l'archivio lo fa.

Un manuale che nessuno riesce a trovare. Ospitare solo l'ultima revisione garantisce che i clienti sulle vecchie versioni leggano il documento sbagliato.

Schermate di una release precedente. Ogni immagine in un manuale è legata a una versione, il che è un argomento a favore del contrassegnarle e dell'approccio di produzione descritto di seguito.

Informazioni sulla versione che un modello non ha mai richiesto. Nessun download gratuito di modello di manuale d'uso del software e nessun download gratuito di modello di manuale d'uso generico contiene un campo di applicabilità della versione, perché i modelli di manuale sono stati progettati per prodotti che non cambiano.

Un documento assemblato da un sito di supporto senza adattamenti. Le pagine online presuppongono che i link funzionino e che il contenuto sia aggiornato. Esportando in un documento fisso, entrambi i presupposti vengono meno e il risultato sembra un sito web stampato su carta, perché di fatto lo è.

Mostra il software anziché descriverlo

I manuali comportano un carico visivo maggiore rispetto a qualsiasi altro formato di documentazione, per un motivo specifico legato al modo in cui vengono distribuiti.

Una pagina di supporto può contenere un link a un video. Un manuale spesso non può farlo, perché potrebbe essere letto offline, in un ambiente sicuro o anni dopo che il link ha smesso di funzionare. Quindi tutto ciò di cui il lettore ha bisogno deve essere all'interno del documento, il che significa immagini anziché link, e un manuale di duecento pagine può contenerne diverse centinaia.

A ciò si aggiunge l'effetto moltiplicatore del problema della versione. Ogni immagine è legata alla release su cui è stata catturata, quindi una nuova versione principale significa catturare nuovamente l'intero set. Questo è il motivo per cui i manuali vengono così spesso distribuiti con immagini obsolete di due release, e perché i lettori smettono di fidarsi di essi.

L'AI di Trupeer cambia le regole del gioco. Qualcuno esegue l'attività una volta, sulla versione documentata, durante la registrazione, e l'output è una guida passo passo scritta con immagini già catturate, annotate e posizionate, insieme a un video, con il tuo branding. Produrre il set di immagini per una nuova release significa registrare nuovamente l'attività anziché scattare nuovamente screenshot di centinaia di schermate.

Registra. Personalizza il brand. Traduci. Usa Trupeer.

Altri due punti sono importanti nello specifico per i manuali. La versione video può accompagnare il manuale sul sito di supporto per i clienti che hanno accesso alla rete, in modo che la stessa produzione serva entrambi i canali di distribuzione senza raddoppiare il lavoro. E laddove un prodotto venga distribuito a livello internazionale, la stessa registrazione produce lo stesso contenuto del manuale in ciascuna lingua, il che è più importante qui rispetto a un sito di supporto, poiché un manuale distribuito nella lingua sbagliata non può essere corretto silenziosamente in un secondo momento.

Il materiale risiede nella tua knowledge base e funge anche da formazione per il personale di supporto e i team di implementazione. Le procedure operative per chiunque esegua il software appartengono al runbook. La coerenza tra i tuoi documenti è solo questione di impostare il brand kit una volta, e la configurazione è trattata nella guida alla configurazione dei modelli di documento.

Domande Frequenti

Esiste una versione Word del modello gratuito di manuale d'uso del software?

Word è lo strumento in cui i manuali vengono scritti, revisionati e corretti, e gestisce le cose di cui i manuali hanno bisogno: un vero sommario, un indice analitico, riferimenti incrociati, numerazione delle pagine e piè di pagina.

Il piè di pagina è l'impostazione che vale la pena configurare correttamente. Inserisci la versione del software e la revisione del manuale prima ancora di scrivere qualsiasi cosa, in modo che ogni pagina le contenga. Un file Word modello di manuale d'uso del software gratuito senza informazioni sulla versione nel piè di pagina produrrà il problema descritto in questa pagina.

Esiste una versione Word del modello di manuale d'uso per uso generale?

Sì, e quelli per uso generale sono ampiamente disponibili. Un file Word modello di manuale d'uso ti fornirà in genere una copertina, i contenuti, i capitoli, la risoluzione dei problemi e un indice analitico, che rappresenta una discreta struttura di base.

Due aggiunte sono necessarie nello specifico per il software. L'applicabilità della versione nel piè di pagina e un modo per contrassegnare quando è apparsa una funzionalità. Nessuna delle due è presente nei modelli generici perché nessuna delle due è importante per un documento che descrive qualcosa che non cambia.

Esiste un PDF modello gratuito di manuale d'uso del software?

Il PDF è ciò che viene distribuito. Scrivi in un documento, quindi esporta un PDF modello di manuale d'uso del software gratuito per la consegna, con la versione e la revisione visibili su ogni pagina anziché solo sulla copertina.

Due dettagli di produzione. Genera segnalibri reali dalle intestazioni, poiché i lettori navigano nei PDF lunghi in questo modo. E assicurati che il testo sia ricercabile anziché essere un'immagine, cosa che a volte accade quando i manuali vengono assemblati con strumenti di progettazione grafica.

Dove posso scaricare gratuitamente un modello di manuale d'uso?

Sono ampiamente disponibili, anche presso enti di standardizzazione e agenzie pubbliche, le cui versioni tendono a essere strutturate meglio rispetto ai siti di modelli commerciali perché sono state scritte per essere effettivamente utilizzate.

Qualunque sia il download gratuito del modello di manuale d'uso da cui parti, la prima modifica riguarda il piè di pagina. La seconda consiste nell'aggiungere una breve sezione vicino all'inizio che spieghi al lettore come verificare quale versione del software sta eseguendo, cosa che quasi nessun modello include e che previene la categoria più comune di contatti di supporto legati ai manuali.

Esiste una versione PPT del modello gratuito di manuale d'uso del software?

Le diapositive sono adatte alla formazione creata a partire da un manuale, piuttosto che al manuale stesso. Una presentazione PPT modello di manuale d'uso del software gratuita funziona per una sessione di onboarding o una giornata di formazione per i clienti.

Non sostituisce il documento. Un manuale esiste per essere completo e ricercabile da parte di chi non ha altre risorse, e una presentazione non è né l'uno né l'altra.

Esiste una versione Excel del modello gratuito di manuale d'uso del software?

Excel è adatto all'inventario che sta dietro al manuale, piuttosto che al manuale stesso. Un file Excel modello di manuale d'uso del software gratuito funziona bene come registro dei contenuti: una riga per sezione, con il relativo proprietario, la versione rispetto alla quale è stata verificata l'ultima volta, se le immagini sono aggiornate e a quali versioni del prodotto si applica.

Quel registro è ciò che rende gestibile l'aggiornamento di una release. Senza di esso, aggiornare un manuale di duecento pagine per una nuova versione significa rileggerlo interamente.

Esiste un download gratuito di un modello di manuale d'uso del software che valga la pena utilizzare?

L'elenco delle sezioni richiede mezz'ora per essere creato e la maggior parte dei modelli pubblicati sono quasi identici, quindi un download gratuito di un modello di manuale d'uso del software non fa risparmiare molto tempo.

Giudicali tutti in base a una sola domanda. C'è spazio per l'applicabilità della versione sulla pagina e non solo sulla copertina? Praticamente nessuno lo prevede, perché la maggior parte dei modelli di manuali è stata progettata per prodotti che non cambiano, mentre il software cambia.

Qual è il miglior modello gratuito di manuale d'uso del software?

Il miglior modello gratuito di manuale d'uso del software è quello in cui puoi inserire un piè di pagina con la versione e mantenerlo aggiornato tra una release e l'altra, il che in pratica significa un documento di testo semplice piuttosto che uno con una grafica complessa.

I modelli con una grafica complessa hanno un aspetto migliore ma sono notevolmente più difficili da aggiornare, e un manuale difficile da aggiornare è un manuale che viene distribuito descrivendo la release precedente. Per un documento ripubblicato diverse volte all'anno, la facilità di manutenzione batte l'aspetto estetico.