Quali competenze servono per realizzare un buon manuale?

È davvero necessario conoscere una macchina per poterla descrivere attraverso un manuale d’uso? 

L’ovvia risposta a questa domanda è sì, ma necessita di qualche spiegazione in più per capire chi può scrivere un manuale di istruzioni e di quali informazioni preliminari devi tener conto.

Partiamo proprio dall’assunto: conoscere una macchina. Qualsiasi sia il prodotto in questione, per uso professionale o privato, dobbiamo considerare innumerevoli componenti e funzionalità che probabilmente nessuno conosce per intero.

Chi ha costruito la macchina saprà indicare correttamente ogni principio elettronico su cui si basa il suo funzionamento, ma avrà poche informazioni circa il design esterno dei pulsanti.

Il customer service sarà pronto a risolvere ogni problema di funzionalità, ma non avrà le competenze necessarie per i guasti tecnici che richiedono l’intervento di un manutentore specializzato.

Conoscere il macchinario per intero è davvero difficile, ma non impossibile. È a questo che serve proprio il manuale di istruzioni, che raccoglie tutte le informazioni tecniche e funzionali di un prodotto e le rende fruibili agli operatori che ne faranno uso.

A questo punto un dubbio sorge spontaneo: 

chi dovrebbe scrivere un manuale di istruzioni? 

L’azienda può avvalersi di tre soluzioni: 

• un ufficio interno dedicato alla redazione dei manuali d’uso, solitamente presente nelle multinazionali e nelle grosse aziende che hanno un corposo catalogo di prodotti;
• affidare la stesura del manuale all’ufficio tecnico, che normalmente fa parte dell’organigramma aziendale e ha il compito di studiare i macchinari e la loro realizzazione, dallo schema tecnico al collaudo;
• commissionare la realizzazione del manuale di istruzioni a una figura esterna all’azienda, specializzata proprio nella redazione di manuali di manutenzione.

Questa figura ha un nome specifico: il technical writer.

Redattore manuali d’uso: come sceglierlo

Il technical writer è uno scrittore – o, per meglio dire, redattore -, con competenza in materia tecnica e industriale, che si occupa di redigere manuali d’uso e manuali di manutenzione per i prodotti di altre aziende.

Il suo background di conoscenze comprende principi di meccanica, elettronica e tecnica, con studi specifici che gli permettono di capire subito il funzionamento di un determinato macchinario e di poterlo esprimere nero su bianco in maniera chiara e precisa.

Dal momento che il mondo della tecnologia e della meccanica è davvero vasto, ogni technical writer tende a specializzarsi in un settore peculiare. Così, è possibile trovare redattori di software, di macchinari di movimentazione, di elettrodomestici, di macchinari per uso agricolo e molto altro.

Questa suddivisione diventa garanzia di sicurezza, nel momento in cui un imprenditore vuole commissionare la redazione di un manuale d’uso ed essere comunque sicuro di ciò che il manuale andrà a contenere, delle informazioni e dei dettagli forniti nelle pagine del libretto di istruzioni.

Il technical writer professionista deve rispondere a queste esigenze:

• confrontarsi con i tecnici dell’azienda produttrice, per ricevere tutta la documentazione e le spiegazioni relative all’uso del prodotto, alle sue funzionalità, ai pericoli che derivano da un utilizzo non corretto, garantendo sempre un canale di dialogo aperto per lo scambio di informazioni;
• avere familiarità con i software di automation, che includono sia gli elaboratori di testi e di calcolo (i classici Word e Office, ad esempio), sia programmi di impaginazione automatica, in caso la tua azienda ne utilizzi uno per lo svolgimento delle proprie attività di analisi e ricerca;
• presentare una strategia di lavoro, ossia una pianificazione di contenuti e di tempistiche che serve ad entrambi per portare avanti il progetto senza tralasciare informazioni o ritardare sui tempi di consegna di ogni fase;
• collaborare attivamente con il grafico, o proporre un grafico di fiducia che possa completare il lavoro di impaginazione e di strutturazione delle informazioni; 
• utilizzare strumenti di condivisione per tenerti aggiornato sullo stato dei lavori e per scambiare velocemente le informazioni. Esistono diversi software e applicazioni che facilitano l’accesso ai dati da parte di entrambi, condividendo in un server sicuro (in cloud) i documenti necessari per portare avanti la stesura del manuale d’uso.

Non tralasciamo un altro dettaglio fondamentale: il redattore di manuali d’uso non deve soltanto dimostrare di apprendere e capire il funzionamento di un macchinario, ma anche di conoscere la Direttiva Macchine 2006 42 CE, ossia la norma vigente che dà indicazioni su come compilare un manuale d’uso in maniera corretta.

I nostri redattori utilizzano i modelli manuale, dei prototipi di libretti di istruzioni che contengono già le indicazioni su tutte le voci da inserire per realizzare un manuale d’uso a norma di legge.

Il modello manuale contiene sia il sommario con tutte le caratteristiche da includere secondo la Direttiva Macchine sopracitata, sia suggerimenti ed esempi pratici che facilitano la compilazione del manuale da parte del redattore e riducono i tempi di elaborazione.

Nella fase di revisione della bozza che ti fornirà il technical writer, abbi cura di verificare che siano presenti tutte queste voci:

• intestazione sociale del fabbricante;
• designazione della macchina, con il numero di modello e il marchio;
• dichiarazione CE di conformità;
• descrizione generale della macchina;
• iconografie, descrizioni e spiegazioni necessari per l’uso, la manutenzione e la riparazione della macchina;
• descrizione dei posti di lavoro per gli operatori;
• descrizione dell’uso previsto della macchina;
• avvertenze su come la macchina non deve essere usata;
• istruzioni sull’installazione e il montaggio;
• istruzioni per la messa in moto e l’uso della macchina;
• informazioni in merito ai rischi che potrebbero verificarsi malgrado siano state adottate le misure di protezione della macchina;
• istruzioni sulle misure di protezione che devono essere prese dall’operatore;
• caratteristiche essenziali degli attrezzi opzionali che possono essere montati sulla macchina;
• condizioni in cui la macchina si può muovere con stabilità;
• istruzioni per le operazioni di trasporto, movimentazione e stoccaggio;
• cosa fare in caso di infortunio, blocco o avaria;
• descrizione delle operazioni di manutenzione preventiva;
• istruzioni per la regolazione e manutenzione;
• specifiche dei pezzi di ricambio;
• livello di rumore aereo emesso dalla macchina;
• possibilità di emettere radiazioni che potrebbero nuocere alle persone.