Nell’era in cui tutto è online, un dubbi condiviso dalla maggior parte di coloro che possiedono un’azienda riguarda la tipologia di mezzo che deve essere utilizzata per diffondere la propria documentazione tecnica.
La scelta riguarda: il formato PDF e le guide in linea.
Perciò se anche tu devi realizzare la documentazione tecnica per la tua azienda e hai dei dubbi a proposito del mezzo da utilizzare, stai leggendo l’articolo giusto.
Di seguito ti spiego quali sono le differenze tra i formati a disposizione, per aiutarti a fare una scelta consapevole e adatta a soddisfare le tue esigenze specifiche.
Manuali cartacei: le origini
Prima ancora del formato PDF e delle guide online, la documentazione tecnica veniva realizzata nella maggior parte dei casi in formato cartaceo.
Tutto ciò che poteva essere di aiuto al cliente veniva stampato: manuali di installazione, manuali di manutenzione, istruzioni, fascicoli tecnici e tanto altro.
La documentazione tecnica oggi: PDF e guide online
Oggi la maggior parte dei manuali di documentazione tecnica sono stampati in formato PDF e può essere consultata online, soprattutto perché in questo modo è possibile evitare di sostenere tutte le spese che una documentazione cartacea prevede.
I progressi in ambito informatico e tecnologico permettono oggi di arricchire le guide online con video 3D interattivi, per aiutare il cliente durante le fasi di montaggio.
Un manuale PDF consultabile online è caratterizzato da:
- Un layout fisso;
- Le immagini hanno una sola risoluzione sia nel caso in cui vengano stampate sia nel caso in cui vengano consultate in rete;
- Il numero di pagine tra formato cartaceo e formato online è sempre lo steso;
- La consultazione avviene senza interruzioni;
- La struttura del documento non può essere modificata, quindi è difficile comunicare agli utenti quali sono gli argomenti che richiedono una maggiore attenzione.
Le guide in linea sono nate per essere consultate online e, almeno all’inizio, venivano utilizzate soprattutto per le applicazioni software.
Le principali caratteristiche di questo formato sono:
- Formato HTML: il formato dei caratteri ed il layout possono essere modificati, la portabilità è maggiore etc.
- Risoluzione delle immagini migliore;
- Personalizzazione: la guida può essere adattata in base alle caratteristiche di chi la consulta;
- Navigazione facilitata, per aiutare l’utente a non perdere il “filo del discorso”.
La guida in linea permette inoltre di: fornire le informazioni in modo graduale all’utente, nascondendo alcuni contenuti e facendo in modo che siano visibili solo se attivati; scaricare il contenuto più aggiornato dal server aziendale; contenere al suo interno altre piccole guide.
Quale formato scegliere?
Dopo tutte queste informazioni ti starai chiedendo quale formato è meglio scegliere.
Io ti consiglio di prendere in considerazione sempre il destinatario della documentazione tecnica e l’uso che ne deve essere fatto.
Successivamente potrai decidere: lo strumento di redazione, come organizzare le stampe, quali regole redazionali seguire, quali elementi grafici inserire, le modalità di scrittura, le varie convenzioni e molto altro.
Se possiedi documenti in formato pdf, valuta sempre quali possono essere gli effetti di un passaggio al formato guida online sul tuo destinatario: in questo modo non commetterai errori.
Ti consiglio infine di distribuire sempre documenti tecnici semplici da consultare, dal momento che questi sono senza dubbio i più efficaci.
Buona fortuna!