Alla base di una buona documentazione tecnica, ricca di dettagli sulle caratteristiche e l’uso di un macchinario, risiede una ricerca molto accurata che riguarda non solo cosa scrivere, ma anche come scrivere.

Come ogni contenuto testuale o verbale, redatto per qualsiasi tipo di utilizzo (istituzioni, marketing, informativo ecc…), anche la documentazione tecnica segue delle sue regole per quanto riguarda la stesura di manuali d’uso, manuali di manutenzione, cataloghi e altri documenti legati a un prodotto.

Queste regole rientrano nel campo della comunicazione tecnica, ben nota ai redattori tecnici che seguono direttive, metodi e modus operandi specifici.

Comunicazione tecnica: caratteristiche

Soffermiamoci su quest’ultimo concetto: la comunicazione tecnica fa sì che le informazioni presenti all’interno della documentazione tecnica siano precise, prive di ambiguità, ben organizzate e fruibili.

Questo lavoro ha un obiettivo finale ben preciso, quello di rendere un concetto complesso facile da capire per chi legge.

Prendiamo ad esempio un comune manuale d’uso per un macchinario industriale. I destinatari di questo libretto di istruzioni saranno i tecnici e gli operai che utilizzeranno ogni giorno il macchinario in fabbrica o in azienda, e avranno bisogno di informazioni precise su come accedere a tutte le sue funzioni e cosa fare in caso di guasto o malfunzionamento.

Il linguaggio di un manuale del genere è di tipo tecnico, per quanto però calibrato sulle conoscenze degli operatori di macchina e sulle informazioni che occorre loro sapere. 

Sarebbe un errore riportare delle informazioni con un linguaggio diverso, ad esempio quello degli ingegneri che hanno ideato il macchinario: all’operatore non serve sapere il dettaglio dei codici, dell’impostazione dei circuiti, del progetto iniziale.

Ciò giustifica e spiega l’assunto iniziale: la comunicazione tecnica deve essere facile da comprendere per il destinatario dei documenti in cui viene applicata.

Come si ottiene questo risultato? Attraverso una lunga preparazione del testo, una vera e propria opera di ingegneria del linguaggio.

 

Come scrivere, cosa scrivere, in che modo scriverlo

La comunicazione tecnica adotta un approccio ingegneristico nei confronti della lingua: a differenza della comunicazione letteraria, valida per romanzi, poesie, racconti, la comunicazione di tipo tecnico si basa sulla raccolta e sull’analisi di dati (le informazioni utili), organizzati in modo tale da creare una struttura logica, comprensibile e fruibile.

Questo atteggiamento nei confronti del testo fa sì che i concetti possano diventare immediatamente comprensibili per i lettori, senza però cadere in un’eccessiva semplificazione che rischia di omettere dettagli importantii, creando ambiguità e incertezze.

La comunicazione tecnica deve rispettare quattro principi fondamentali: 

  • deve essere chiara, sia nel linguaggio che nell’organizzazione delle informazioni;
  • deve essere completa e presentare tutte le nozioni utili al destinatario del documento;
  • deve essere concisa, evitando di dilungarsi in dettagli non rilevanti e digressioni, avendo sempre l’accortezza di verificare che le informazioni importanti siano tutte presenti;
  • deve riportare informazioni corrette e verificabili.

Se gli ultimi tre punti possono essere rivisti e controllati mano a mano che si procede con la stesura del documento, l’organizzazione delle informazioni resta invece una fase preliminare da affrontare prima di iniziare a scrivere, per garantire a chi legge la massima fruibilità del testo.

Comunicazione tecnica e fruibilità: l’accesso alle informazioni

Fruibilità significa usabilità. All’interno di un documento, la fruibilità si distingue se è facile reperire i dettagli che interessano il lettore, senza dover leggere l’intero testo per trovare solo le informazioni utili in un determinato momento.

La possibilità di trovare facilmente un argomento o delle indicazioni specifiche all’interno di un manuale di istruzioni è una necessità talmente rilevante da essere regolamentata all’interno di una norma standardizzata a livello internazionale, la ISO 82079-1:2012.

Al settimo capitolo della norma ISO 82079-1:2012 si parla proprio di usabilità delle istruzioni d’uso, valutate in base a test di verifica che testimoniano quanto sia più o meno facile trovare un determinato argomento nel testo complessivo.

Per effettuare tale controllo ci si affida a test di adeguatezza, definiti su prerequisiti inseriti nella norma ISO stessa, in tre differenti allegati:

  • l’allegato A indica i criteri secondo cui deve avvenire la valutazione da parte degli esperti: 
  • l’allegato B indica quali sono gli elementi di contenuto e i tipi di informazione da inserire nel manuale di istruzioni; 
  • l’allegato C valuta l’efficacia del manuale rispetto alla capacità di trasmettere tali informazioni, dando quindi indicazioni su come devono essere scritte. Dal momento che la comprensibilità ha un valore altamente soggettivo, questi test vengono affidati a persone esterne che leggono il manuale e possono così muovere critiche costruttive per migliorare il testo.

Il modello manuale aiuta a gestire le informazioni

Organizzare, strutturare, scrivere, verificare: scrivere un manuale d’uso significa seguire questo processo, così riassunto ma estremamente più complesso, al fine di dare informazioni complete, chiare e fruibili.

L’adozione di un modello manuale permette ai redattori tecnici di avere uno schema preimpostato già corretto e verificato, che rispetta la normativa della Direttiva Macchine e la norma ISO 82079-1:2012 in merito alla qualità delle informazioni fornite.

Una volta che la struttura del manuale d’uso è già fornita, il redattore del manuale sarà agevolato nell’inserimento delle informazioni e nella revisione del manuale stesso; la stesura sarà inoltre più rapida e meno soggetta a errori, così da accelerare anche i tempi di consegna.

Scopri di più sul nostro modello manuale e sul metodo IRIDE, i nostri nove (più due) step per la realizzazione di ogni manuale.