Realizzare manuali istruzioni è semplice e pure divertente

Non ci credete? .... Fate bene! È un lavoro importante che richiede conoscenza ed esperienza. Un po’ come tutti i lavori però ... e quindi perché nella maggior parte dei casi è considerato un incubo? Quello che spesso manca è un metodo che consenta un approccio guidato alla redazione. In questo articolo vorrei condividere alcuni elementi del mio, sperando che possano essere utile anche ad altri. Eccoli:

Comprensione del prodotto.

Trovo fondamentale capire il prodotto: quali sono “i perché” che stanno dietro alla sua ideazione, e i processi che hanno portato alla realizzazione. Per fare questo intervisto le persone che hanno maggiormente contribuito al progetto: il responsabile del prodotto, quindi area Marketing e il progettista. Ultimamente riprendo le interviste con una piccola videocamera che lascio sempre accesa; la posiziono su un cavalletto in modo da poterla tenere in disparte in modo che non interferisca con la naturalezza delle persone, i video poi mi servono come appunti che tornano utili nella stesura del documento. La videocamera non registra solo le informazioni ma anche le emozioni che le persone trasmettono quando parlano del loro prodotto, un punto fondamentale, che mi permette di creare un collegamento quasi “empatico” con l’apparecchio.

Mappatura dell’informazione tecnica

Nella fase successiva estraggo l’informazione tecnica generalmente da un manuale prodotto dall’azienda per un apparecchio simile, ricostruendo lo schema a livelli di dove è collocata. Per farlo uso un’applicazione di mappe mentali SimpleMind ma ce ne sono molte altre disponibili che fanno la stessa cosa, questo mi permette di creare una sorta di punto 0, una fotografia della situazione attuale sulla quale andare poi a fare analisi e ragionamenti insieme al cliente.

Questo è un esempio della mappatura di un intero manuale

Alcuni dettagli: i colori identificano i diversi livelli del documento e i tipi di informazione tecnica

Strutturazione dell’informazione tecnica

Adesso viene il lavoro vero. A questo punto elaboro l’informazione tecnica tenendo come guida le Norme UNI che uso come riferimento: la UNI 10653 e la UNI 10893. La prima, da indicazioni su come garantire la qualità dell’informazione tecnica; la seconda, sull’articolazione e l’ordine espositivo dei contenuti. In pratica prendo la mappa mentale e la riorganizzo secondo la struttura che mi da la normativa, integrandola con le informazioni acquisite durante l’audit utilizzando i video.

Dematerializzazione dell’informazione tecnica

Questo passaggio mi permette di “confezionare” l’informazione tecnica in modo da poter essere utilizzata trasversalmente su più documenti possibile. Lo faccio sulle frasi rendendole neutre e spezzandole fino ad ottenere una frase per ogni azione. Per esempio “svitare le 4 viti di fissaggio utilizzando un cacciavite e rimuovere il pannello di accesso” diventa:

“utilizzare un cacciavite” 

“svitare le viti di fissaggio” 

“rimuovere il pannello d’accesso”

Quindi frasi che possono essere riutilizzate in qualsiasi contesto, e composte un po’ come i mattoncini LEGO, questo permette di mantenere una coerenza linguistica tra i documenti e di riutilizzare frasi che magari si portano dietro traduzioni in diverse lingue.

Le immagini invece rimangono personalizzate sul prodotto, di fatto delego proprio a loro la contestualizzazione delle frasi. L’unica avvertenza è quella di “deletterizzarle” vale a dire togliere le frasi integrate nell’immagine per portarle in legenda, in questo modo è possibile utilizzare la stessa immagine per tutte le lingue.

Assegnazione degli stili all’informazione tecnica

Ogni tipo di informazione tecnica deve essere immediatamente riconoscibile dal lettore; per questo motivo è fondamentale individuarle ed applicare degli stili grafici differenti. Per esempio io uso questi:

• I testi descrittivi sono in testo piano

• Lo scopo dell’azione in Neretto

• Le istruzioni hanno un -

• I feedback della macchina sono in Italic

• Le avvertenze hanno un simbolo grafico triangolare con punto esclamativo

• I divieti hanno un simbolo grafico simile al cartello stradale

Poi applico uno schema nella stesura che è sempre lo stesso:

• Ogni capitolo comincia con delle Avvertenze preliminari

• Una immagine che spiega il contesto dell’istruzione

• Lo scopo dell’istruzione

• Le istruzioni in forma attiva

• Eventuali avvertenze/divieti specifici per l’azione che si sta compiendo

Ecco un semplice esempio:

Per accedere:

• Utilizzare un cacciavite

• Svitare le viti di fissaggio

• Rimuovere il pannello d’accesso

Avvertenza: Utilizzare dispositivi di protezione individuale.

Chiaramente non finisce qui…..

Ci sono altri elementi di cui occorre tener conto: le traduzioni e soprattutto il lavoro preparatorio con i traduttori, gli strumenti di impaginazione (personalmente uso un sistema di impaginazione automatica da database), quelli per realizzare le immagini che servono nei documenti (Inventor o Composer), il lavoro di verifica del documento sul prodotto passo importantissimo e spesso tralasciato.

Queste sono alcune delle cose che hanno funzionato per me, e non è detto che funzionino anche per altri ma credo che in ogni caso sia importante strutturare le esperienze in modelli ripetibili per crearsi il proprio metodo di lavoro … non aiuterà a rendere il lavoro più divertente ma forse più facile sì.