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

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

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

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 autosufficiente: software distribuiti on-premise, prodotti venduti in ambienti regolamentati, sistemi in esecuzione in reti senza accesso esterno e contratti in cui un manuale è un deliverable designato.

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 utente del software spiega come dovrebbe essere strutturata.

Il modello non è il manuale. Gli elenchi delle sezioni per i manuali sono ampiamente pubblicati e in gran parte 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 affrontano mai e quasi nessun modello prende in considerazione.

Il formato segue la consegna. Un file Word per un modello gratuito di manuale d'uso per software è il luogo in cui questi vengono scritti e revisionati. Un PDF per un modello gratuito di manuale d'uso per software è ciò che viene spedito, perché un manuale è un record fisso e un PDF è l'unico formato comune che si comporta come tale. Un layout PPT per un modello gratuito di manuale d'uso per software si adatta alla formazione derivata dal manuale, e un file Excel per un modello gratuito di manuale d'uso per software si adatta all'inventario dei contenuti che lo supportano piuttosto che al documento.

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

Un sito di supporto ha un'unica versione: quella corrente. 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 copia.

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

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

Questo è il problema decisivo di un manuale software ed è del tutto assente da un sito di supporto. Ogni decisione di progettazione descritta di seguito ne consegue.

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 qualsiasi modello con cui desideri lavorare per aprirlo.

Passaggio 3: Espandi la vista del modello

Se necessario, espandi la vista 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 l'anteprima e perfeziona il modello

Quando desideri 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 per software puoi:

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

• Ridurre i ticket di supporto: Manuali chiari aiutano gli utenti a fare 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 tutorial: Incorpora video per i 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 delle versioni e cosa fare al riguardo

Si verificano frequentemente tre tipi di errore, 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 ed effettua una ricerca al suo interno, come fanno di solito le persone, 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 stia 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 ne hanno idea.

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

Aggiungi un'ultima cosa, che non riguarda il lettore ma te. Mantieni ogni versione pubblicata del manuale disponibile sul tuo sito di supporto, anziché solo l'ultima. Un cliente su una versione precedente ha bisogno del manuale per quella specifica versione; 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 online per qualsiasi cosa di cui un lettore abbia realmente bisogno, perché potrebbe essere letto in un ambiente privo di accesso alla rete o dopo che la pagina collegata è stata spostata. Tutto l'essenziale deve essere all'interno del documento.

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

Compilato con un esempio reale anziché con 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 del software 11.2, revisione C, numero di pagina. Questa è la singola riga più utile del documento.

Come verificare la tua 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 alla voce 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. Vedere il capitolo nove. La rietichettatura dei campioni ha ottenuto un secondo passaggio di conferma nella versione 10.4.

Destinatari previsti. 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'inserimento locale. Non copre l'amministrazione del sistema, che si trova nel manuale dell'amministratore.

Guida introduttiva. Accesso, schermata principale e completamento della registrazione di un campione dall'inizio alla fine.

Capitoli dedicati alle attività. Organizzati in base a ciò che fanno le persone. Registrazione dei campioni. Registrazione dei risultati. Refertazione. Ricerca nei record storici. Archiviazione. Ogni pagina dell'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 compaiono 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 di supporto, ciascuna con sintomo, probabile causa e risoluzione.

Indice analitico. Reale, che copre sia i termini usati dagli utenti sia quelli utilizzati 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 contatto.

Copia fino a qui.

Esempio di manuale d'uso per software: 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 i propri programmi.

Il manuale contava duecentoquaranta pagine, prodotte in formato PDF e rilasciate 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 precedente a quella descritta dal manuale corrente. Diversi siti erano indietro di due versioni principali, il che non è insolito in quel settore, in cui 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 hanno letto il capitolo sull'archiviazione. C'era scritto che i record archiviati potevano essere ripristinati dalla scheda Archivio in qualsiasi momento.

Questo era vero a partire dalla versione 11.0 in poi. Sulla versione 8.4, l'archiviazione era permanente.

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

Nulla nel manuale era impreciso. 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.

Sono seguite tre modifiche e nessuna è stata costosa.

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 il capitolo sull'archiviazione ora specifica che il ripristino è disponibile a partire dalla versione 11.0 e che l'archiviazione è permanente sulle release precedenti.

La quarta modifica 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 con la versione 8.4 potesse trovare il manuale della versione 8.4.

I ticket di supporto attribuibili alla confusione tra le 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 per software in sei passaggi

1. Decidi se hai effettivamente bisogno di un manuale. Se i tuoi utenti hanno accesso alla rete e trovano la documentazione tramite ricerca, un sito di supporto li aiuterà meglio. I manuali sono per documenti spediti, fissi e completi.

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

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

4. Contrassegna 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 i problemi da risolvere dalla coda dei ticket di supporto. I tuoi ticket più comuni rappresentano il capitolo già prioritario.

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

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

Quando hai bisogno di un manuale piuttosto che di un sito di supporto

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

Software distribuito 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, essa deve essere fissa, provvista di versione e recuperabile. Gli ambienti validati richiedono spesso il manuale specifico per la versione validata. Qualsiasi manuale che faccia parte di una sottomissione 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 sia una voce designata in un contratto o in un programma di acquisto, i requisiti del contratto regolano il formato e il contenuto.

Prodotti per i quali l'utente non dispone di supporto. Distribuzione fisica, vendite una tantum, apparecchiature a lungo ciclo di vita. Il manuale è tutto ciò che avranno mai a disposizione.

Il miglior modello gratuito di manuale d'uso per software per uno qualsiasi 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 che un sito di supporto servirebbe meglio i tuoi utenti costandoti meno in manutenzione.

Manuale d'uso per software, guida utente o manuale di istruzioni?

Tre termini con utilizzi sovrapposti, di cui è utile conoscere le differenze quando si sceglie una struttura.

Un manuale d'uso per software è completo, provvisto di versione e consegnato. Presuppone che il lettore possa non avere altre risorse e nessun modo per fare una domanda.

Una guida utente per software presenta lo stesso contenuto nella tradizione online, continuamente aggiornato, a cui si accede tramite ricerca e che viene mantenuto pagina per pagina. Si applicano regole strutturali diverse, trattate nella pagina della guida utente per software.

Un manuale di 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 di istruzioni copre 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 di origine al momento del rilascio. Questa è la soluzione a cui puntare, 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 per software

Un unico 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 con versioni precedenti leggano il documento sbagliato.

Screenshot di una versione precedente. Ogni immagine in un manuale è legata a una versione, il che è un argomento a favore della loro marcatura e dell'approccio di produzione descritto di seguito.

Informazioni sulla versione che un modello non ha mai richiesto. Nessun download gratuito di modelli di manuale d'uso per software o di modelli di manuale d'uso generici 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 presumono che i link funzionino e che il contenuto sia aggiornato. Esportati 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 consegnati.

Una pagina di aiuto può contenere un link a un video. Un manuale spesso non può farlo, perché potrebbe essere letto offline, in un ambiente protetto 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.

Inoltre, il problema delle versioni moltiplica questo aspetto. Ogni immagine è legata alla versione in cui è stata acquisita, quindi una nuova versione principale significa dover acquisire nuovamente l'intero set. Ecco perché i manuali vengono così spesso spediti con immagini non aggiornate rispetto alle ultime due versioni e perché i lettori smettono di fidarsi di essi.

L'intelligenza artificiale di Trupeer cambia questa logica. Qualcuno esegue l'attività una volta, sulla versione documentata, durante la registrazione, e l'output è una guida passo passo scritta con immagini già acquisite, annotate e posizionate, insieme a un video, con il branding della tua azienda. Produrre il set di immagini per una nuova release significa registrare di nuovo anziché dover scattare nuovamente screenshot di centinaia di schermate.

Registra. Personalizza con 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 dispongono di accesso alla rete, in modo che la stessa produzione serva entrambi i canali di consegna 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 spedito nella lingua sbagliata non può essere corretto silenziosamente in un secondo momento.

Il materiale si trova 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 documenti è una questione di impostazione del kit del brand una sola volta, e la configurazione è trattata nella guida alla configurazione del modello di documento.

Domande frequenti

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

Word è lo strumento in cui i manuali vengono scritti, rivisti e revisionati, 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 merita di essere curata con attenzione. Inserisci la versione del software e la revisione del manuale prima di scrivere qualsiasi cosa, in modo che ogni pagina le riporti. Un file Word di modello gratuito di manuale d'uso per software senza informazioni sulla versione nel piè di pagina produrrà il problema descritto in questa pagina.

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

Sì, e quelli per uso generale sono ampiamente disponibili. Un file Word di modello di manuale d'uso in genere ti fornirà una copertina, l'indice dei contenuti, i capitoli, la risoluzione dei problemi e un indice analitico, il che costituisce uno scheletro ragionevole.

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

Esiste un modello gratuito di manuale d'uso per software in formato PDF?

Il formato PDF è quello che viene spedito. Scrivi in un documento, quindi esporta un PDF del modello gratuito di manuale d'uso per software 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 in PDF lunghi in questo modo. E assicurati che il testo sia ricercabile anziché un'immagine, cosa che a volte accade quando i manuali vengono assemblati a partire da 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 da fare riguarda il piè di pagina. La seconda consiste nell'aggiungere una breve sezione 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 per software?

Le diapositive si adattano alla formazione creata a partire da un manuale, piuttosto che al manuale stesso. Una presentazione PPT di un modello gratuito di manuale d'uso per software funziona bene 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 di diapositive non è né l'una né l'altra cosa.

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

Excel si adatta all'inventario che sta dietro al manuale piuttosto che al manuale stesso. Un file Excel di un modello gratuito di manuale d'uso per software 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 doverlo rileggere tutto da capo.

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

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

Giudica ognuno di essi in base a una sola domanda. Prevede uno spazio per l'applicabilità della versione sulla pagina anziché solo sulla copertina? Sostanzialmente nessuno lo fa, perché la maggior parte dei modelli di manuale è stata progettata per prodotti che non cambiano, a differenza del software.

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

Il miglior modello gratuito di manuale d'uso per software è quello in cui è possibile inserire un piè di pagina con la versione e mantenerlo tra le varie release, il che in pratica significa un documento di testo semplice piuttosto che uno con un design complesso.

I modelli dal design molto elaborato hanno un aspetto migliore ma sono notevolmente più difficili da aggiornare, e un manuale faticoso da aggiornare è un manuale che viene spedito descrivendo la versione precedente. Per un documento ripubblicato più volte all'anno, la facilità di manutenzione supera l'aspetto estetico.