user-friendly

Creazione di contenuti tecnici “User Friendly”

Quando si parla di documentazione tecnica, in particolare di manuali di uso e manutenzione, gli aspetti da considerare sono davvero molti. Spesso ci si ritrova a parlare degli aspetti legali, ovvero della necessità di produrre un manuale “a norma”. Ma non c’è solo questo: proviamo a vedere la cosa anche da un’altra prospettiva.

Problema…

La vostra azienda produce condizionatori d’aria per uso industriale. L’estate è alle porte, e con essa il periodo che tipicamente vede un buon incremento delle ordinazioni.

Vi rendete però conto che il vostro reparto di assistenza non riesce più a star dietro alle richieste dei clienti, e il problema sembra via via peggiorare, di pari passo con l’aumento delle vendite.

Causa

Alcuni messaggi di errore, che scaturiscono da situazioni piuttosto comuni, forzano l’arresto degli impianti di condizionamento installati. La risoluzione di questi problemi dovrebbe essere un’operazione semplice, quasi di routine, ma sul manuale di istruzioni non è presente la procedura..

Oppure ancora: le istruzioni ci sono, ma sono difficili da trovare / difficili da capire.

Tutto questo non è una semplice seccatura (e non da poco). È nella migliore delle ipotesi una perdita di immagine, oltre che di tempo.

Si perché, per legge, un manuale d’uso incompleto (tale da non consentire un corretto utilizzo della macchina / del prodotto) costituisce un difetto di qualità, che potrebbe addirittura comportare la richiesta di rettifica o sostituzione, il recesso dal contratto d’acquisto o una riduzione del prezzo d’acquisto stesso.

Ma come si può fare? Tempi stretti, modelli di prodotto che cambiano continuamente, customizzazioni, personale interno super indaffarato e poco predisposto a rivestire i panni del “redattore tecnico”., ecc..

Qualche consiglio

L’obbiettivo è di produrre una documentazione semplice da consultare e da capire.

Un buon punto di partenza è individuare alcuni elementi chiave necessari, e valutarli individualmente:

  • Semplicità e concisione: le frasi troppo lunghe sono spesso macchinose e difficili da capire. Potrebbero addirittura generare errori di comprensione. Meglio stare sotto le 20-25 parole a frase, ed esprimere solo un concetto per volta. Potrebbe essere di aiuto l’utilizzo di un elenco verticale.
  • Struttura e organizzazione: è importante che i contenuti seguano un filo logico semplice ed intuitivo. Provare a pensare: se mi servissero delle informazioni su questo argomento, dove lo andrei a cercare nel manuale? Potrebbe aiutare impostare una mappa dei contenuti.
  • Elementi grafici: meglio di mille parole. Le procedura operativa e le descrizioni, se correlate da risorse grafiche adeguate, sono molto più facili da capire (senza contare il risparmio di tempo: più immagini = meno testi da scrivere). Vi sarà capitato di vedere manuali completamente fatti di immagini, senza nessun testo: è il caso, per esempio, di una nota catena di mobili…

Certo, in tutto questo è anche importante determinare il livello di conoscenza delle persone a cui il manuale che stiamo creando è rivolto: tecnici specializzati? Operatori di macchina? Grande pubblico (privati e famiglie)?

E per le traduzioni?

Va da se che se una documentazione più snella, semplice e ben strutturata è meno costosa da tradurre.

Non solo: a conti fatti, il traduttore è il primo dei tanti lettori del documento, proprio come se fosse un utente finale. Se il traduttore ha una buona comprensione del testo, di conseguenza l’output tradotto sarà migliore. Viceversa si rischiano errori e incomprensioni a cascata.

Pensiamo anche al futuro

In conclusione, vorrei introdurre anche un altro aspetto della fruibilità dei contenuti.

Finora abbiamo parlato di come sia importante riuscire a creare contenuti facilmente comprensibili così da trasmettere le informazioni efficacemente.

Fondamentale però è anche pensare a come possiamo raggiungere i lettori.

Manuale stampato su carta? Pdf inviato su CD o chiavetta USB?

Sicuramente queste sono delle possibilità. Ma un documento stampato, (carta o pdf che sia), è un documento “morto”, che non si aggiorna, che non si corregge in caso di errori.

Una documentazione “viva” è quella che viene richiesta on-demand, accessibile da ogni piattaforma digitale, che è sempre aggiornata per rispecchiare lo stato dell’arte della macchine / del prodotto a cui si riferisce.

Di questo avremo sicuramente modo di parlarne più nel dettaglio prossimamente.

Leggi anche gli altri blog della categoria “redazione manuali”:

https://www.because-italy.com/category/redazione-manuali/

Da Claudio Damarco Responsabile uff. tecnico del team di because Italy

Share this post

Condividi su facebook
Condividi su twitter
Condividi su linkedin
Condividi su print
Condividi su email