Redazione, revisione e qualità
13/03/2023
in Comunicazione Tecnica, Formazione per comunicatori tecnici, Standard di scrittura tecnica
Siamo immersi nella revisione, quella fase del lavoro indispensabile per coloro che vogliono assicurare una certa qualità al proprio prodotto. Dall’elettricista all’impaginatore, dal fornaio al carpentiere, dal maestro d’ascia al collaudatore, lo stesso per il redattore tecnico con la sua documentazione tecnica.
In questo articolo abbiamo parlato degli aspetti strutturali. Oggi ci riferiamo al redattore tecnico che tesse la trama dei contenuti dedicati al prodotto e al revisore che deve controllare che nella pubblicazione (pdf o html) tutto torni. Il lavoro aumenta, le cose da fare aumentano, i clienti, le tipologie di prodotto su cui siamo chiamati a lavorare si diversificano. ed ecco che la revisione si manifesta come indispensabile, sempre, non solo per le nuove leve o i nuovi prodotti.
Nella redazione tecnica la revisione è sia nella forma grammaticale e ortografica sia terminologica e soprattutto a favore della comunicazione efficace. Efficace dal punto di vista della comprensione, della sicurezza, del funzionamento del prodotto e pertinenza delle informazioni redatte. Vediamo di elencare alcuni aspetti della revisione:
- grammaticale e ortografica
- terminologica sia per il nome dei componenti, versi di rotazione, lato di azione dell’operatore, posizione delle zone pericolose fino ai codici dei ricambi consigliati
- concettuale ossia prima di smontare il distanziale devo rimuovere la ghiera, quando smonto un gruppo devo prima sorreggerlo con cinghie e paranco, se spengo la macchina non posso accedere alle pagine del pannello operatore
- per la sicurezza. Ti racconto solo “come fare a…” per le cose che il Fabbricante vuole che tu faccia. Ti dico quello che non puoi fare tu operatore, ma deve fare il personale specializzato.
- risoluzione di ambiguità: a pagina 25 ho scritto X e a pagina 90 ho scritto Y o una frase sembra dire il contrario o non si capisce chi sia il soggetto.
- efficacia della comunicazione e dell’informazione. Cerco come fare a smontare la guarnizione del cuscinetto del rullo a lame, la trovo e il testo risolve perfettamente la manutenzione in maniera inequivocabile.
- L’aspetto grammaticale e ortografico si può tenere a bada con strumenti e metodi di scrittura. L’uso di un sistema di gestione dei contenuti (CMS o CCMS) blocca i contenuti standard e favorisce la revisione e successiva correzione dei soli contenuti nuovi. Se il redattore non conosce bene cosa c’è scritto nei contenuti standard potrebbe contrariarsi nei contenuti specifici.
- La terminologia si usa affiancando un database terminologico alla redazione e si controlla con i CAT Tool. Anche il database terminologico è revisionato e manutenuto!
- La revisione concettuale richiede di capire l’ordine di esecuzione delle azioni, capire i comportamenti sicuri che deve avere l’operatore, capire come funziona il gruppo e dove si trova il componente.
- La revisione ai fini della sicurezza richiede la conoscenza di come devono essere scritte le avvertenze di sicurezza e dove devono essere posizionate, cosa è un pericolo, un divieto o un obbligo.
- L’ambiguità si scioglie se ci focalizziamo sul soggetto, se usiamo convenzioni per indicare verso di rotazione o direzioni, se usiamo la terminologia.
- l’efficacia si raggiunge adottando metodi di scrittura e con la pertinenza dell’informazione. Quello che scrivo appartiene all’informazione che voglio comunicare? I componenti sono richiamati nella descrizione? i termini che ho usato sono quelli riportati nella descrizione? Si capisce chi è il soggetto dell’azione?
Per dare un contenuto di qualità occorre revisionare, rileggere, concentrarsi e sapersi immedesimare con l’utente per capire cause e conseguenze delle procedure descritte.
Come spiego ai miei nuovi colleghi: imparate a scrivere, sappiate cosa scrivere, sappiate farvi le domande giuste per ogni informazione che siete chiamati a scrivere, imparate a leggere subito quello che avete scritto. Spesso le informazioni di partenza sono ambigue, nascoste, sono indizi. Il prodotto non è disponibile e neanche la terminologia è fissata.
Spesso chi non legge o non ha attitudine alla lettura difficilmente potrà mantenere una visione complessiva e una capacità di redazione e revisione. Oggi i ragazzi non sono abituati a leggere, tantomeno sanno scrivere ed ecco che il lavoro di revisione aumenta. Si può trovare un bravo tecnico, più difficile un buon scrittore tecnico, difficilmente entrambe raramente un buon revisore. È sempre molto valida la domanda: è più facile insegnare a scrivere ad un tecnico o insegnare come si smonta un cuscinetto ad un linguista?
Spesso la conoscenza del prodotto è racchiusa in un “bauletto” confezionato dal progettista o azienda: un set di disegni, una scheda tecnica, un ex-manuale, lo schema elettrico, un insieme di pagine sul sito internet, un pdf o nella sua mente. Le fonti racchiudono descrizione, funzionamento, sicurezza, manutenibilità, prestazioni.
Il manuale di istruzioni di un prodotto è scritto in un’ottica di uso in sicurezza, dalla movimentazione allo smantellamento, dall’uso alla manutenzione. Tenere il focus sulla sicurezza e parlare di manutenzione dopo aver parlato di zone di lavoro del manutentore, di rischi residui e dispositivi di protezione o mezzi e modi di sollevamento del gruppo non è cosa semplice da architettare. Occorre avere ben chiara la funzione del manuale istruzioni e dei singoli capitoli e paragrafi richiesti dalla Direttiva di prodotto. Meglio conoscere il concetto di pericolo, rischio, zona pericolosa, evitabilità e probabilità di accadimento. É utile sapere bene come deve essere composta una procedura. Si deve sapere come movimentare quel gruppo per doverlo indicare o richiamare nella manutenzione se dobbiamo smontarlo per raggiungere una zona inaccessibile. Questo è il lavoro del redattore tecnico.
Il revisore ha meno tempo da dedicare alla commessa, diciamo 1/10 del tempo? Il lavoro del revisore non è per tutti ma se il redattore tecnico ha precisione e pignoleria è sicuramente più fluido. Non si sta parlando di scoprire una virgola di troppo o la mancanza di un punto a fine frase. Si sta parlando di concetto, di azioni da compiere in sicurezza, di immedesimarsi con l’utente, di servire e aiutare gli utenti ad un uso del prodotto in sicurezza. Occorre capire se il focus dell’informazione è stato raggiunto con il testo e l’immagine realizzata. Ecco che il revisore forma poi a ritroso i redattori per eliminare gli errori più comuni.
Si sa che queste attività sembrano superflue e appesantiscono il processo dal punto di vista anche dei costi ma tu faresti uscire una macchina non collaudata?
