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 utilizzare il termine Product Marketing come nuova definizione per la comunicazione tecnica. Personalmente non amo creare nuovi termini per quello che già c’è e tantomeno un altro inglesismo. Wikipedia riporta un’atra definizione.
Proviamo a 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 è stato attribuito nel corso degli anni, nell’ambiente dei Fabbricanti e fra le Direttive e norme tecniche in primis.
Noi di AP Publishing siamo orientati alla soddisfazione delle richieste di informazioni e risoluzione di problemi legati all’uso in sicurezza dei prodotti. Vediamo di parlare di:
- comunicazione tecnica
- documentazione tecnica
- informazioni di prodotto
- contenuti
- struttura delle informazioni
- metadati
Comunicazione tecnica
Partiamo subito dalla norma ISO/DIS 24183:2022 dove troviamo la definizione: “Technical communication is the process of defining and creating information for use to be delivered as information products for the safe, effective and efficient use of supported products throughout its life cycle.” La norma tende ad aiutare a prevenire la possibilità di fraintendimenti e discussioni fra acquirenti e fornitori di servizi di informazioni di prodotto e di conseguenza fra Fabbricanti e utilizzatori. La Comunicazione Tecnica è tutta la comunicazione che sta dietro e davanti al prodotto per quei prodotti che sono dispositivi medici, macchine o impianti, elettrodomestici o qualsiasi altro apparecchio elettrico o un servizio. Il nostro lavoro in AP Publishing è comunicare verso l’esterno, al cliente, o all’interno dell’azienda del Fabbricante (importatore o distributore) o fornitore di servizi, tutto ciò che sta “dentro” al prodotto o servizio.
Documentazione tecnica
La Documentazione Tecnica è un insieme di informazioni di prodotto fornite dal Fabbricante del prodotto o servizio. La documentazione tecnica la associamo più al materiale stampabile. La documentazione tecnica dobbiamo intenderla come un insieme di informazioni in cui sono riportati numeri, disegni, dati, testi immagini e procedure finalizzate alla rappresentazione, descrizione, uso in sicurezza, manutenibilità e smaltimento, di un prodotto o servizio.
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. Un portale web per il service è documentazione tecnica. Il prodotto e l’utente sono al centro della documentazione tecnica.
Informazioni di prodotto
Le informazioni di prodotto, messe insieme in modo organizzato e strutturato, compongono la documentazione tecnica (stampa o web). 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, può anche avere molti gruppi funzionali ma li tiene nascosti al pubblico generico, perché lavorano dietro una carrozzeria. In un impianto invece tutti i gruppi funzionali sono a vista, protetti, pericolosi ed è facile trovare la documentazione suddivisa in gruppi.
I libretti di istruzioni degli elettrodomestici sono completi di dichiarazione CE, possono avere un manuale di uso con sole immagini, un paio di fogli stampati per le avvertenze di sicurezza e il libretto completo sul sito del Fabbricante. Per un impianto le informazioni spaziano dai disegni delle fondazioni al layout, dal manuale di istruzioni al manuale del software della macchina, i certificati di taratura, quelli dei materiali etc…
Nella definizione dell’informazione occorre tenere conto dello scopo che si vuole raggiungere. A seconda della complessità del prodotto occorre strutturare tutta una serie di informazioni di supporto all’utente dove il titolo dell’informazione è lo scopo dell’informazione. Dobbiamo supportare la ricerca di informazioni generiche e al tempo stesso dare la possibilità all’utente esperto di approfondire.
Contenuti
I contenuti sono legati al prodotto, alle funzioni, alla sicurezza, al mercato, al tipo di utente. Sono il testo di una procedura, un video, le avvertenze di sicurezza, 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. Ai contenuti è possibile associare metadati che ne descrivono l’utilità, il tipo di contenuto (immagine, testo, video…), il tipo di prodotto, il mercato, il target. I contenuti 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 preparare qualsiasi tipo di informazione per rispondere ai cambiamenti richiesti dal mercato globale e digitale.
Potremmo sempre manipolare i contenuti come vogliamo ed estrarre un’informazione usabile solo 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?
Struttura dell’informazione
I modelli sono la struttura dell’informazione e supportano la creazione dell’informazione per favorire la presentazione e la comprensione. Proprio come avviene per alcuni standard internazionali come DITA, S1000D, DocBook o iiRDS, in cui sono stati definiti i tipi di informazione (task, procedure, concept per esempio) e tutti i relativi tag e metadati. Per aiutare il team di redattori a compilare le informazioni con i contenuti corretti e necessari è possibile predisporre più modelli di informazione composti da contenuti ben definiti per quella specifica informazione. Ad esempio un’informazione dedicata alla manutenzione potrebbe essere così composta:
- titolo (testo)
- paragrafo_contesto o paragrafo_descrittivo (testo)
- stato_prodotto (testo)
- avvertenze/divieti (messaggio di sicurezza)
- attrezzatura_necessaria (testo, immagini)
- procedura_video o procedura_immagini+testo (video, immagini, testo)
- paragrafo_verifica (video, immagini, testo)
Questo modello aiuta il redattore. Lo scopo è quello di avere tutte le informazioni uguali nella struttura oltre che complete.
Metadati
La norma ISO/DIS 24183:2022 riporta il termine metadata due volte: la prima quando parla di document management e l’atra in terminology management system. Nei due casi si fa riferimento alla trovabilità dei documenti o dei termini entrambi archiviati in un database. 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_gruppo, tabella-dati_gruppo, immagine_gruppo, immagine_macchina). 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 o CCMS.
Dunque se proprio dovete redigere i contenuti fatelo in modo minimale in linea con lo scopo dell’informazione e usate la terminologia. Usate la scrittura semantica e inserite frasi complete, simili a quelle che immette l’utente nel motore di ricerca di Google che ha il suo Bard. Rafforzate l’informazione con un titolo che è una promessa di risoluzione, utilizzate termini omogenei e validati e magari confrontateli con i termini utilizzati dall’utente finale. Con i buoni contenuti, ricchi di metadati potete comporre informazioni utili e pertinenti basate su modelli di informazione. Avrete così la possibilità di comporre tutta la documentazione tecnica di supporto alla comunicazione tecnica della vostra azienda.
