Verifica il tuo manuale in 7 punti
Il tuo manuale è in regola? Ho identificato 7 punti chiave che puoi verificare in autonomia.
Hai definito chiaramente in copertina di che tipo di documento si tratta? Es. se si tratta di un “Manuale d’installazione o d’uso” o se ha più funzioni tipo “d’uso e manutenzione” ecc. A volte vengono usati termini troppo generici tipo "Manuale tecnico" che non identificano chiaramente il documento.
Le informazioni inserite sono coerenti con il tipo di documento che hai indicato? A volte capita che in copertina sia scritto Manuale d'uso ma che all'interno ci siano anche informazioni per l'installazione.
Hai un paragrafo che descrive le caratteristiche dei diversi destinatari? Chi è per te l’utente, l’installatore o il manutentore, il livello di formazione o di esperienza, le competenze, se sono necessarie certificazioni, ecc.. A volte queste informazioni mancano o sono sparse per il documento mentre è importante radunarle in un paragrafo ben identificato.
Nel caso di convivenza di più destinatari nello stesso documento, hai diviso il documento in sezioni dedicate a ciascun destinatario o hai identificato in altro modo univoco il destinatario per ciascuna informazione? È importante correlare chiaramente informazione e destinatario per evitare di autorizzare indirettamente operazioni pericolose ad utenti non esperti.
Sei stato coerente nell’utilizzo della definizione del destinatario? A volte si chiama lo stesso destinatario con nomi diversi Es. l'Utilizzatore, Utente, Operatore, ecc.. mantenere sempre lo stesso nome aiuta il lettore a identificare chiaramente a chi si sta parlando.
Hai previsto un paragrafo che descrive i simboli, gli stili grafici e il loro significato che hai usato nel manuale? Per Avvertenze, Divieti, Note di solito la legenda è prevista ma spesso manca un’indicazione per l’identificazione di: testi descrittivi, azioni richieste (es. “- premere il tasto ON”, risposte attese “> il display si accende” il simbolo - identifica l’azione il simbolo > la risposta)
Sei stato coerente nell’utilizzo dei simboli? Es. Le avvertenze sono identificate sempre nello stesso modo o al contrario per la stessa avvertenza hai usato una simbologia differente.
Chiaramente i punti da controllare sarebbero molti di più ma questi sono quelli che considero l’ABC per partire con il piede giusto.
