La capacità di documentare e di revisionare

La capacità di documentare e di revisionare

Credo che l’iniziale mancanza di conoscenza del prodotto, per il lavoro che deve fare il redattore tecnico, sia un plus. Potersi interfacciare con il prodotto con occhi nuovi può dare molto in termini di uso previsto e uso sconsigliato e nell’inquadrare i “come fare a…” necessari. Poi il prodotto deve essere conosciuto per documentarlo.

Nel corso della nostra esperienza di redattori di istruzioni e quick guide, dove si scrive, si illustra, si movimenta (video) tutto il necessario, l’approccio all’uso di un prodotto parte “alla cieca”, poche volte abbiamo il prodotto disponibile ed i test sull’uso e il funzionamento sono virtuali, nel nostro cervello. Per le macchine industriali è possibile vedere lo schema elettrico e capire cosa implica la chiusura di un circuito ed in più ci rivolgiamo ad un utilizzatore professionale. Nei prodotti elettrici di largo consumo come gli elettrodomestici, grandi e piccoli, spesso non abbiamo lo schema elettrico anche perché abbiamo una scheda elettronica. Se il campione rimane in oriente allora abbiamo solo gli appunti sul progetto, il libretto in inglese fatto dal cinese, spesso non ci sono i 3D. In queste due condizioni appena descritte come incide la capacità di un redattore di documentare e revisionare?

La capacità di documentare

In origine c’erano gli editor di testo poi con i CMS ed oggi con i CCMS il lavoro di redazione tecnica si è fatto processo e prodotto esso stesso fino a far sfuggire la visione dell’insieme. Prima gli editor di testo ti obbligavano a ruotare la rotella del mouse e a passare più volte davanti alla medesima pagina (esistono gli stili titolo e le finestre di navigazione!) fino a non vedere più l’errore in quel paragrafo, neanche tanto nascosto. Un po’ quello che succede a chi la macchina o il prodotto lo ha fatto e visto crescere e poi, quando pronto, lo deve documentare: si omettono dati, fatti e spiegazioni che sarebbero utili all’utente che guarda il prodotto con un occhio nuovo e attento.

Utilizzare un CCMS in generale comporta due capacità: una per chi gestisce la struttura l’altra per chi scrive i contenuti. Il primo deve dedicare molto tempo alla tassonomia e taggare tutti i contenuti con varianti, modelli, tipi e parole chiave. “Macchina” e “impianto” nel testo hanno genere opposto, il singolare o plurale se si parla di macchine in una linea, caldaia ad acqua o caldaia a vapore se si parla di elettrodomestici per caffè o stiro, tasti o pulsanti e così via. La pubblicazione della struttura di contenuti deve essere certa se vogliamo che il redattore lavori solo sui nuovi contenuti.

Al redattore non spetta solo il compito di organizzare le procedure e semplificare le informazioni. Il redattore, deve sapersi collegare ai contenuti standardizzati e bloccati e scrivere i nuovi con cognizione logica: dovrà mantenere la terminologia e preoccuparsi che quanto scritto nelle nuove informazioni sia allineato con il contenuto delle vecchie informazioni. Questo legame con “l’uso del prodotto in un modo sicuro” deve essere mantenuto per tutta la pubblicazione. A volte si capiscono le funzioni di un gruppo solo alla fine della redazione. Occorre avere l’attenzione giusta per porsi la domanda “ma allora cosa avevo scritto prima?” e la capacità logica di cercare e correggere e uniformare i contenuti. In un CCMS spesso non si vedono in sequenza i contenuti e il “montaggio” degli stessi a favore della pubblicazione di un tipo di documento può alla lunga risultare un disastro. Ecco che interviene il revisore.

La capacità di revisionare

Eccola… lei con la penna rossa… sempre a puntualizzare… mamma mia che pignola! Riflessione: se le donne sono quelle che trovano sempre le cose o meglio se gli uomini sono quelli che non vedono mai dove stanno le cose allora le donne sono coloro che meglio interpretano questa professione!
Ma se non ci fosse la revisione quante pubblicazioni con errori ci sarebbero? Quanto tempo occorrerebbe per sistemare tutte le pubblicazioni? Fra varianti, modelli e traduzioni? Parliamo di errori di concetto tipo: premere il tasto +/- per impostare il tempo di cottura quando invece con il campione in casa e scheda elettronica nuova ci accorgiamo che i tasti sono spie e il tempo di cottura si imposta con la rotazione della manopola. In questo caso è fondamentale l’attenzione del revisore. Se troviamo il termine “tasto” e ad un certo punto si parla di spie dobbiamo chiedere quale delle due versioni è corretta per poi segnalare la sostituzione di tutte le occorrenze. Non stiamo parlando di errori ortografici ma di capire se la modifica impatta su altri contenuti.

Questo movimento celebrale non è da tutti! mantenere la connessione fra ciò che si è letto a pagina 20 con quanto riportato nella procedura a pagina 153 occorrono capacità logiche, profondità e cognizione di causa/effetti. Il revisore conosce il prodotto per la prima volta leggendo la descrizione e l’uso previsto. Non centra niente la familiarità con il prodotto. Il revisore deve capire cosa legge e verificare l’intera pubblicazione in modo che abbia consistenza cioè che sia uniforme e coerente.

I CCMS chiedono i revisori, le machine translation più che mai… il revisore sarà una delle professioni più richieste e visto che ci vuole passione per leggere, intelletto oltre che conoscenza mi sa che scarseggeranno visti i trend mondiali sulla capacità di leggere e capire un testo scritto.

Internamente facciamo sempre revisione l’uno all’altro, per la qualità, per allenamento, per (de)formazione. Voi avete bisogno di revisionare?

Potrebbe interessarti anche

Alessandro Pratelli

Perito aeronautico, calsse '72. Lavora come redattore tecnico dal 1995 poi fonda AP Publishing. Appassionato di Direttive e norme tecniche. La frase che preferisce? "Se non alzi mai gli occhi, ti sembrerà di essere nel punto più in alto".