Comunicazione tecnica o documentazione tecnica? Contenuti o informazioni? Parliamo di terminologia legata alla comunicazione tecnica

Comunicazione tecnica o documentazione tecnica? Contenuti o informazioni? Parliamo di terminologia legata alla comunicazione tecnica

Il titolo è chiaramente una provocazione che vuole portare il lettore a fare alcune considerazioni sulla terminologia legata alla comunicazione tecnica.

Pochi giorni fa ho visto il termine Product Marketing come nuova definizione per la comunicazione tecnica. La comunicazione non è forse anche quella per il marketing? Personalmente non amo creare nuovi termini per quello che già c’è e tantomeno un altro inglesismo.

Cerchiamo di mettere in ordine alcuni termini che girano intorno a chi deve produrre documentazione tecnica ogni giorno. Noi usiamo ancora ‘documentazione tecnica‘, un vecchio termine che trovo attualissimo e pienamente usabile per il significato che gli abbiamo voluto attribuire nel corso degli anni, nella nostra professione.

Noi infatti preferiamo parlare di tecnica più che di marketing. Per la nostra esperienza in AP Publishing siamo più tecnici e linguisti, e siamo meno orientati al marketing, alle performance del prodotto. Certamente siamo orientati alla soddisfazione delle richieste di risoluzione di problemi legati all’uso e alla sicurezza dei prodotti.

Per noi la Comunicazione Tecnica è tutta la comunicazione che sta dietro e davanti al prodotto, per quei prodotti che sono macchine, impianti, elettrodomestici, o qualsiasi altro apparecchio elettrico (non di un flacone di crema). Ci interessa portar fuori tutto ciò che sta dentro: dal progetto al disegno, all’etichettatura, alla confezione, con i pittogrammi, la scheda tecnica, la procedura di manutenzione sul sito, fino all’immagine tecnica per il roll-up.

Documentazione tecnica

La Documentazione Tecnica è una parte della Comunicazione Tecnica: quella fisica che è organizzata in insiemi di informazioni, quella che fa saltare da una pagina all’altra mentre navighiamo appunto online o quando si tocca con mano, i documenti stampati e i manuali in PDF stampati, le guide e le schede tecniche, i certificati di taratura.
Un manuale di istruzioni è un tipo di documento come lo è un manuale di installazione o una procedura di montaggio attaccata con lo scotch alla struttura della stazione automatica di un impianto di produzione. Un sottoinsieme della documentazione tecnica sono i tipi di documento. Compresa la documentazione di progetto, un insieme di rendering per il catalogo dei prodotti o l’insieme delle foto professionali per la scheda tecnica. Il prodotto e l’utente sono al centro della documentazione tecnica.

Informazioni della comunicazione tecnica

Le informazioni, messe insieme in modo organizzato e strutturato, compongono i vari documenti. Possiamo creare le informazioni giuste per ogni tipo di documento. Le informazioni contenute in una guida rapida non sono le stesse di quelle del libretto di istruzioni e più un impianto è complesso e automatico più le informazioni sono tecniche e dedicate a personale specializzato. Facciamo un esempio: un prodotto apparentemente semplice come un elettrodomestico e dedicato ad un pubblico di massa, che pure ha molti gruppi funzionali li tiene nascosti al pubblico generico perchè lavorano dietro una carrozzeria. I loro libretti di istruzioni sono dunque completi, con dichiarazione CE e schema elettrico comprese le frasi di sicurezza dettate dalle norme tecniche. In un impianto invece tutti i gruppi funzionali sono a vista ed è facile trovare la documentazione suddivisa in gruppi.
Nella definizione dell’informazione occorre tenere conto dello scopo che si vuole raggiungere e a seconda della complessità del prodotto, strutturare tutta una serie di informazioni di supporto all’utente, non a completamento poiché lo scopo dettato dall’informazione deve essere raggiunto e l’informazione deve contenere tutte le istruzioni per raggiungere lo scopo. Dobbiamo supportare la ricerca di informazioni generiche e al tempo stesso dare la possibilità all’utente esperto di approfondire.

Contenuti della comunicazione tecnica

I contenuti sono legati al prodotto, alle funzioni, alla sicurezza. Sono il testo di una procedura, un video, la tabella di dati tecnici, il paragrafo descrittivo, la foto per la copertina, l’immagine
per la procedura. I contenuti sono legati al gruppo funzionale e possono essere associati metadati che ne descrivono l’utilità, il tipo di contenuto (immagine, testo, video…). Sono i mattoni che compongono la singola informazione. Ritengo sia fondamentale avere contenuti buoni. La sicurezza dei contenuti, accettati e validati con uno specifico scopo, è la vera ricchezza dell’azienda e permette al reparto dedicato alla documentazione tecnica di rispondere ai cambiamenti richiesti dal mercato globale e digitali.
Potremmo sempre manipolare i contenuti come vogliamo ed estrarre un’informazione usabile se i contenuti sono specifici e risolutivi. Se i contenuti sono superficiali, lo sarà anche l’informazione singola e di conseguenza tutta la documentazione sarà scadente. Potrò comunque mixare i contenuti per ottenere qualcosa…ma sempre qualcosa di superficiale. Vale la pena sprecare energie per creare una documentazione superficiale? Vale la pena passare al formato HTML pur avendo contenuti superficiali?

Modelli della comunicazione tecnica

I modelli sono la struttura dell’informazione (non la strutturazione, che è semantica) e supportano la creazione dell’informazione. Proprio come avviene per alcuni standard internazionali come DITA, S1000D o INFOMAPPING, in cui sono stati definiti i tipi di contenuto che formano una informazione (task, procedure, concept per esempio). Per aiutare il team di redattori a compilare le informazioni con i contenuti corretti e necessari, è possibile predisporre più modelli di informazione, specificando i vari tipi di contenuti per quella specifica informazione. Ad esempio un’informazione dedicata alla manutenzione potrebbe essere così composta:

  • titolo
  • paragrafo_contesto
  • paragrafo_descrittivo
  • attrezzatura_necessaria
  • avvertenze/divieti
  • procedura_video o procedura_immagini+testo
  • paragrafo_verifica.

Metadati della comunicazione tecnica

Ci sono vari tipi di metadati: quelli che si possono attribuire al contenuto e quelli che si attribuiscono all’informazione. I metadati per il contenuto possono descrivere la funzione del contenuto
(descrizione_gruppo1, tabella-dati_gruppo1, immagine_gruppo1, immagine_macchina1). I metadati dell’informazione servono per trovare o raggruppare le informazioni. Si possono collegare tutte le informazioni con il medesimo metadato (come sul web, in fondo ad un articolo ci sono i collegamenti ad articoli simili per esempio “può interessarti anche:”).
Di sicuro un’informazione strutturata senza metadati non ha alcuna usabilità per la composizione automatica di documentazione o per la sua gestione in un CMS. La scrittura tecnica è l’altro mattone del contenuto ma ne parleremo in un altro post.
Dunque se proprio dobbiamo scrivere facciamolo in modo minimale, pur in linea con la terminologia aziendale. Usiamo la scrittura semantica cercando di inserire frasi complete, simili a quelle che immette l’utente nel motore di ricerca di Google. Rafforziamo l’informazione con un titolo che è una promessa di risoluzione, utilizziamo termini omogenei, validati dal confronto con le parole utilizzate dall’utente finale. Se il 70% degli utenti arriva all’informazione attraverso l’uso di un termine specifico perché ci dobbiamo ostinare ad usare il termine aziendale?

Potrebbe interessarti anche

Alessandro Pratelli
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".

No Comments

Post A Comment