Manuali, guide, presentazioni … cosa significa scrivere per comunicare bene del valore tecnologico? Basta elencare le caratteristiche del prodotto o servizio, le procedure d’installazione, i dati tecnici, la risoluzione problemi? Proviamo a ripercorrere brevemente l’intero percorso che porta a trasmettere al meglio il valore del nostro prodotto o servizio attraverso dei contenuti scritti.
L’importanza
Riflettiamo prima di tutto sull’importanza del contenuto da scrivere o far scrivere. Ci sono contratti e normative che richiedono un manuale, ad esempio la direttiva macchine CE, ma più in generale, se va un documento scritto, perché non farne un punto di forza? Con istruzioni ben scritte, in modo chiaro ed efficace, si riducono le richieste di supporto, i reclami, i rischi di danni, i malfunzionamenti. Ne beneficia l’immagine del prodotto e dell’azienda. Si abbassano i costi di formazione e di assistenza.
I destinatari
Conoscerli bene, in termini di profili (personas), è fondamentale. Si scrive per lui o per loro e questo va sempre tenuto bene a mente. A chi ci rivolgiamo? Che preparazione e competenze ci aspettiamo abbiano? Quali obiettivi si pongono utilizzando il nostro prodotto o servizio? Un tipico rischio è quello di inserire troppi dettagli descrittivi non utili per i destinatari e mancare invece di prevedere tutte le istruzioni necessarie a raggiungere i loro reali obiettivi.
Il prodotto (o servizio)
Tutti i dati e gli elementi del prodotto o servizio in oggetto vanno dominati a pieno, naturalmente, attraverso le necessarie competenze tecniche e applicative, in genere distribuite su più esperti. Scrivere dei contenuti tecnici significa costruire un ponte di informazioni tra questi esperti e il destinatario. Il redattore lo costruisce diventando il primo a percorrerlo.
Il modello
Ovviamente mai partire da zero. A seconda del documento o formato, utilizzare il modello che definisce la migliore struttura e il formato aziendale, assicurando completezza e aderenza a eventuali norme. Molte parti saranno comuni e ripetute in altri documenti. Questo finisce per essere complesso da gestire ogni volta manualmente ed esistono strumenti per ottimizzare il riutilizzo di parti comuni (i sistemi CCMS, che sta per Component Content Management System).
La scrittura
Va sempre ricordato che stiamo scrivendo dei contenuti tecnici per un preciso destinatario che ha obiettivi pratici e concreti. Dovremo quindi utilizzare uno stile di scrittura adeguato a questo scopo. In estrema sintesi, ecco le qualità da considerare:
- Essenzialità: visto che leggere costa tempo e fatica, andiamo ogni volta dritti al punto in modo diretto e conciso.
- Chiarezza: farsi capire è ovviamente fondamentale. Abbiamo riflettuto, riletto e poi fatto verificare?
- Coerenza terminologica: evitare sinonimi inutili e attenersi al (necessario!) glossario tecnico.
- Strutturazione grafica: strutturare il testo in sezioni con titoli, sottotitoli e liste.
- Semplicità: utilizzare un registro di scrittura semplice. Fare utile riferimento (con buon senso) agli standard di linguaggio tecnico [1]. Possono essere utili delle guide di stile per raccogliere regole linguistiche generali e norme aziendali.
- Accuratezza: in ogni dettaglio tecnico e in particolare nelle cifre, nelle unità di misura (adattate al mercato di destinazione), nei riferimenti tecnici e normativi e soprattutto nelle norme di sicurezza.
- Logica: seguire scrupolosamente l’ordine logico delle istruzioni di lavoro e dei loro singoli passi, collegando opportunamente le istruzioni per raggiungere tutti i previsti obiettivi.
- Illustrazioni: curare la chiarezza e l’efficacia delle figure e degli elementi multimediali. Non dimenticare gli aspetti di traducibilità.
- Strutturazione: organizzazione di sezioni e moduli [2], in particolare procedure di istruzione, tabelle di riferimento, informazioni per la ricerca e risoluzione guasti.
- Un occhio al futuro: in particolare agli strumenti di intelligenza artificiale.
La verifica
Ogni dato o istruzione tecnica sarà preciso solo se verificato e sperimentato concretamente, tipicamente con l’aiuto di un esperto tecnico. Verifichiamo quindi con scrupolo i nostri contenuti attraverso revisioni formalizzate in modo adeguato al processo aziendale in vigore. Il metodo principe nella tematica di progettazione con costante verifica è quello della User Experience (UX).
La traduzione
Norme e opportunità di mercato rendono spesso necessario tradurre la documentazione nella lingua di destinazione del paese che acquista. La traduzione non va sottovalutata e va ben gestita per evitare cattivi risultati e costi aggiuntivi. Ecco una utile checklist:
- Tradurre una versione finale e stabile dei contenuti. Ci si può arrivare anche con due o più o passi se occorre partire prima della finalizzazione.
- Prevedere sempre un glossario tecnico con la terminologia aziendale e di prodotto.
- Utilizzare strumenti avanzati di traduzione assistita e automatica [3], senza delegare la memoria di traduzione e verificando sempre i risultati con dei lingua-madre.
La manutenzione
Una volta scritto e verificato, il contenuto tecnico può essere sfruttato per ogni possibile utilizzo (è un prezioso asset aziendale). Deve poi essere aggiornato nel tempo per correzioni, messe a punto ed evoluzioni del prodotto (varianti, versioni). Anche in questo caso, l’utilizzo di strumenti più evoluti di Word consente di gestire al meglio la manutenzione.
Se ti può interessare questo tema, contattaci per un approfondimento libero da impegni.
Note
- Ecco i principali standard di linguaggio tecnico. Contengono regole generali e dizionari. Vanno usati con buon senso perché possono risultare troppo rigidi o non del tutto aggiornati.
- ASD-STE100, o Simplified Technical English.
- Italiano Tecnico Semplificato (ITS), a cura della Associazione Italiana per la Comunicazione Tecnica.
- Español Técnico Simplificado (ETS).
- Français Rationalisé (FR).
- Esistono formati standard per la documentazione strutturata, il più affermato è il DITA (Darwin Information Typing Architecture). Per il materiale di formazione, esiste SCORM e per il settore della difesa e aerospaziale, S1000D.
- La traduzione assistita dal computer (CAT o Computer-Assisted Translation, ) utilizza programmi specializzati per facilitare la traduzione manuale e tenere memoria delle frasi tradotte (TM o Translation Memory). La memoria permette di ottimizzare successivi aggiornamenti di una parte della traduzione originaria.
La traduzione automatica (in inglese MT, machine translation) è gestita completamente da strumenti di intelligenza artificiale, che può aiutare ma non sostituire completamente (ancora) l’attività umana, quantomeno per una attenta verifica dei risultati.
