“Buona la prima” non è un concetto che può funzionare quando si tratta di scrivere un manuale d’uso.

Ogni manuale, che si riferisca ad un macchinario per uso civile o per uso industriale, è soggetto a una lunga serie di controlli, modifiche, aggiunte o specificazioni che rientrano nel processo di revisione del documento.

La revisione è un compito delicato, spesso lungo tanto quanto la stesura stessa del manuale d’istruzioni. È la prova del nove, lo step della redazione documentazione tecnica da cui si ottiene il documento definitivo, il quale si porta dietro una responsabilità importante per il produttore e per gli utilizzatori.

Non bisogna accelerare sul processo di revisione, perché ogni piccola svista potrebbe compromettere la qualità del manuale. Tuttavia si possono adottare strategie, tecniche e accorgimenti per rendere la fase della revisione più efficace, evitando così di allungare ulteriormente i tempi di consegna della versione finale del manuale.

Vediamo come si può intervenire per migliorare l’efficienza del processo di revisione.

Come funziona il processo di revisione

Nel caso della documentazione tecnica, ossia l’insieme di tutti i documenti che accompagnano un prodotto, possiamo parlare di tre tipi diversi di revisione, spesso contemporanei ed estemporanei – possono essere scoperti strada facendo, migliorando il testo mentre si scrive, o applicati in un secondo momento, a stesura finita.

Le tre tipologie di revisione si applicano ai tre differenti livelli che compongono qualsiasi tipo di documento: 

  • contenuti: il redattore tecnico ottiene informazioni sul prodotto dal suo produttore, dal team tecnico che ha progettato e creato il prodotto, dai test e dalle verifiche effettuate sul suo funzionamento. La revisione dei contenuti prende il nome di revisione tecnica.
  • struttura: riguarda la disposizione delle informazioni, la suddivisione in paragrafi, la presenza di tutti i dettagli dati a disposizione del redattore tecnico e la fruibilità che permette di ritrovare facilmente ogni informazione. Per facilitare questo tipo di revisione ci si affida alla Direttiva Macchine 2006 42 CE, che costituisce un buon punto di partenza per organizzare i contenuti della documentazione tecnica.
  • stile: il manuale d’uso deve rispecchiare le linee guida date dall’azienda, che a loro volta devono mantenersi coerenti a quanto dettato dalla Direttiva Macchine e dagli standard condivisi a livello europeo sulla struttura della documentazione tecnica. Questo check viene chiamato revisione redazionale.

A queste tre fasi delle revisione, che possono essere svolte contemporaneamente o secondariamente rispetto alla stesura, si accompagna ove richiesto la traduzione tecnica del manuale di istruzioni e la revisione della traduzione, seguendo gli stessi principi della revisione del manuale d’uso.

Edizione e indice di revisione di un documento

Di quante revisioni ha bisogno un manuale d’uso?

Non è possibile quantificare con certezza un numero, ma da qualche anno si è stabilito un tetto massimo per la revisione di una versione del documento: cinque.

Ciò non significa che dopo cinque revisioni il documento non può più essere modificato. Il numero massimo serve a definire quante volte un manuale d’uso può essere cambiato e aggiornato senza distaccarsi troppo dalla copia originale.

A ogni revisione viene assegnato un indice di revisione, un numero che identifica quante volte un documento è stato modificato e riapprovato. All’aumentare dell’indice di revisione aumenta, evidentemente, il distacco tra la versione ultima del manuale e quella originale.

Dopo la quinta revisione il manuale sarà decisamente cambiato; a questo punto si chiude con un gruppo di revisioni, che viene definito come una edizione del manuale, e dalla sesta revisione in poi si aprirà un altro gruppo, a sua volta un’altra edizione.

La differenziazione tra revisioni ed edizioni di un documento tecnico serve a tener traccia dei progressi e dei cambiamenti. Torna particolarmente utile in caso di macchinari di lunga vita, che subiscono variazioni e aggiornamenti nel corso degli anni.

Come velocizzare il processo di revisione

Fare la revisione di un documento scritto da sé stessi pone dei limiti importanti nell’efficacia del processo di revisione stesso: non sempre si è in grado di guardare criticamente ad ogni angolo del testo, a mettere sotto la lente di ingrandimento le informazioni, la struttura e lo stile adottato, finendo per trascurare punti critici che potrebbero invece essere migliorati.

Questo è il motivo per cui i redattori tecnici lavorano spesso in team, o si interfacciano con colleghi di reparto o altri redattori per scambiarsi le reciproche revisioni e migliorare la qualità dei testi prodotti.

Quando si lavora in team, tener conto del processo di revisione potrebbe non essere così semplice. Se il lavoro non è ben organizzato si può finire per confondere tempi e versioni, il lavoro può subire fastidiosi rallentamenti e le varie modifiche si sovrappongono rendendo difficoltoso risalire all’originale, per un confronto costruttivo.

Oggi esistono software gestionali specifici per la gestione documentazione tecnica, programmi per mezzo dei quali si può scrivere e revisionare un manuale tecnico in maniera ordinata. Attraverso i software per redattori tecnici è più semplice: 

  • tenere traccia dello stato di avanzamento della revisione;
  • definire i compiti da affidare a ciascun redattore che si occupa della revisione;
  • individuare chi lavora ad ogni paragrafo o capitolo, assegnando task ai collaboratori;
  • lavorare da remoto, con la condivisione dei documenti in cloud;
  • inserire feedback e correzioni all’interno del sistema gestionale, senza disperdere i suggerimenti tra file esterni, e-mail e messaggi di ogni genere;
  • salvare ogni revisione del documento e dare in automatico un indice di revisione che consente di ritrovare facilmente ogni versione.

Il lavoro in team può diventare tanto semplice quanto efficace per lavorare su uno o più manuali d’uso e garantire al cliente un risultato ottimo, in tempi rapidi; basta una buona gestione del flusso di lavoro per diventare efficienti nella redazione di manuali d’uso impeccabili.