Guide · 02
Come si scrive e come si legge un manuale di istruzioni.
Per chi scrive: tre esempi di riscrittura e sei fasi di lavoro, secondo il Regolamento Macchine e la EN IEC/IEEE 82079-1. Per chi legge: cosa controllare prima di usare la macchina, dalla revisione del manuale alle avvertenze.
Un manuale non si legge dall’inizio alla fine: si consulta con la macchina davanti, spesso con le mani occupate.
Per questo contano tre cose prima dello stile: un’azione per passo, l’avvertenza nel punto in cui il rischio si presenta, un nome solo per ogni pezzo.
Il contenuto minimo lo fissa il Regolamento Macchine, nell’allegato III. Il resto è metodo: le norme EN IEC/IEEE 82079-1 ed EN ISO 20607 lo descrivono.
Scrivere un manuale di istruzioni significa trasformare una descrizione in azioni da eseguire. Tre esempi mostrano la stessa istruzione prima e dopo.
Dal paragrafo al passo.
Sbagliato
Prima di effettuare qualsiasi operazione di manutenzione è necessario assicurarsi che la macchina sia stata scollegata dall’alimentazione e che tutte le parti in movimento si siano fermate completamente, dopodiché si può procedere con l’apertura del riparo.
Corretto
- 1.Portare l’interruttore generale su 0.
- 2.Bloccare l’interruttore con il lucchetto.
- 3.Attendere l’arresto completo del mandrino.
- 4.Aprire il riparo mobile A.
Una frase lunga nasconde quattro azioni e il loro ordine. Divise in passi, si eseguono e si controllano una alla volta.
Prima di effettuare qualsiasi operazione di manutenzione è necessario assicurarsi che la macchina sia stata scollegata dall’alimentazione e che tutte le parti in movimento si siano fermate completamente, dopodiché si può procedere con l’apertura del riparo.
- Portare l’interruttore generale su 0.
- Bloccare l’interruttore con il lucchetto.
- Attendere l’arresto completo del mandrino.
- Aprire il riparo mobile A.
Una frase lunga nasconde quattro azioni e il loro ordine. Divise in passi, si eseguono e si controllano una alla volta.
Capitolo 2, Sicurezza: è vietato introdurre le mani nella zona di taglio. […] Capitolo 7: sostituire la lama svitando le quattro viti di fissaggio.
- AVVERTENZA · Lama tagliente: usare guanti di protezione.
- Svitare le quattro viti di fissaggio.
- Sostituire la lama.
Chi sostituisce la lama legge il capitolo 7, non il capitolo 2. L’avvertenza va nel punto in cui il rischio si presenta.
Aprire il carter anteriore, controllare lo sportello laterale e richiudere la protezione.
- Aprire il riparo mobile A.
- Controllare il riparo mobile B.
- Richiudere il riparo mobile A.
Carter, sportello e protezione possono essere lo stesso pezzo o tre pezzi diversi. Chi legge non lo sa, e chi traduce nemmeno.
La scrittura arriva solo al quinto passaggio: prima vengono le fonti, i destinatari, la struttura del manuale e le avvertenze di sicurezza.
Sei passaggi, in quest’ordine.
- 01
Raccolta delle fonti
Disegni, schemi, analisi dei rischi, manuali dei componenti.
- 02
Destinatari
Operatori, manutentori, installatori, utilizzatori non professionali: chi legge decide il linguaggio.
- 03
Struttura
Capitoli nell’ordine della vita della macchina, dal trasporto alla manutenzione.
- 04
Avvertenze
I rischi residui dell’analisi, portati nel punto in cui si presentano.
- 05
Scrittura
Frasi brevi, un’azione per passo, termini sempre uguali, figure dove il testo non basta.
- 06
Verifica e pubblicazione
Completezza, traduzioni, uscita su carta o in digitale.
Dall’altra parte del manuale c’è chi usa la macchina. Quattro controlli, da fare prima del primo avviamento.
Come si legge un manuale di istruzioni.
- 01
Macchina e revisione
Designazione e modello sul frontespizio si confrontano con quelli riportati sulla macchina, poi si controlla la revisione del manuale.
- 02
La sicurezza, per intero
Prima del primo utilizzo si legge tutto il capitolo sulla sicurezza: uso previsto, usi da evitare, rischi residui, dispositivi di protezione.
- 03
Le parole delle avvertenze
PERICOLO, AVVERTENZA e ATTENZIONE indicano tre livelli di rischio, dal più alto al più basso.
- 04
Dall’indice alla procedura
I capitoli seguono la vita della macchina, dal trasporto alla manutenzione. Trovata l’operazione, la procedura si legge fino in fondo prima di eseguire il primo passo.
Software per scrivere e consultareun manuale di istruzioni.
- Visita la pagina di DocuTech(si apre in una nuova scheda)
DocuTech
Il software Netcom per scrivere e mantenere la documentazione per componenti.
Per chi scrive. Le sei fasi diventano un flusso solo, dalla struttura alla pubblicazione.
Si parte da una struttura
Il manuale nasce da una struttura master o da elementi già in archivio.
Termini sempre uguali
Le frasi approvate si richiamano e i termini fuori glossario si segnalano.
Verifiche all’uscita
Traduzioni mancanti, rimandi interrotti e marcatori aperti si vedono prima di esportare.
- Visita la pagina di DocuBot(si apre in una nuova scheda)
DocuBot
L’assistente AI di Netcom per interrogare manuali e procedure: ogni risposta porta file e pagina.
Per chi legge. La domanda si fa a parole e la risposta arriva con la pagina del manuale.
Dalla domanda alla pagina
Ogni risposta indica file e pagina, e un clic apre il passaggio.
Revisioni a confronto
Cosa cambia tra due revisioni dello stesso manuale, e in quale pagina.
Procedure in punti
Un documento lungo si riduce a punti operativi, con i riferimenti.
Le domande più frequenti.
Il manuale può essere scritto dall’ufficio tecnico?
Sì: la responsabilità è del fabbricante, non di chi scrive. Conta che il manuale sia completo, comprensibile e allineato alla macchina.
Serve una norma per scrivere il manuale?
Le norme tecniche sono volontarie, ma la EN IEC/IEEE 82079-1 e la EN ISO 20607 descrivono come preparare istruzioni coerenti con i requisiti di legge.
Dove si mettono le avvertenze di sicurezza?
Nel punto in cui il rischio si presenta, oltre al capitolo dedicato: un’avvertenza lontana dall’operazione perde efficacia.
Come si trova un’informazione in un manuale lungo?
Dall’indice, cercando l’operazione da svolgere, o con la ricerca nel file se il manuale è digitale. Su un archivio di manuali, DocuBot risponde alle domande indicando file e pagina.
Un manuale da scrivere
Richiesta