Italiano Tecnico Semplificato: ITS®

di Gianni Angelini.

Scrivere bene... non basta per il “manuale perfetto”, ma è il primo passo.

Cosa serve per scrivere una buona documentazione tecnica?

L'argomento non è certo nuovo e le risposte abbondano.



Se guardiamo ai nostri colleghi americani, ma anche ai tedeschi, più vicini a noi, salta però all'occhio una differenza fondamentale rispetto alla generale situazione italiana: in quegli ambienti professionali si è affermata da tempo l'idea che anche la scrittura tecnica debba rispondere a metodi ben precisi.

Certo, anche noi comunicatori tecnici italiani sappiamo che... "bisogna essere chiari", "scrivere un manuale di istruzioni non è come scrivere un romanzo", magari "meglio non usare il gerundio"...

Ma cosa ci manca veramente per fare il salto di qualità e avvicinarci ai migliori standard dei paesi più avanzati nella nostra professione?

L'Associazione italiana di comunicazione tecnica (COM&TEC) si è posta questa domanda e la risposta è il progetto dell'Italiano Tecnico Semplificato (ITS®), nato nel 2013 e vicino alla prima
edizione pubblica.

Non siamo i soli. Almeno una grande azienda italiana lavora da tempo a questo tema, ed ha creato un suo sistema per riutilizzare frasi standard ottimizzate nella redazione dei manuali.

Il progetto di COM&TEC ha però caratteristiche completamente diverse, perché nasce direttamente dall'esperienza dei comunicatori tecnici e punta a fornire uno strumento pratico di lavoro per tutti i colleghi.

L'idea alla base del progetto è nata pensando al Simplified Technical English, che da tempo offre un modello molto interessante e complesso di linguaggio controllato per la comunicazione tecnica.

Rispetto a questo modello, ci siamo dati un obbiettivo più modesto, in base alle nostre forze, ma con in mente anzitutto l'efficacia pratica del progetto per la realtà professionale italiana.

Abbiamo perciò formato un gruppo di lavoro composto da comunicatori tecnici (redattori e traduttori), che rappresentano due punti di vista che si completano a vicenda:

• il punto di vista dei redattori, che vorrebbero scrivere manuali chiari e non ambigui, con testi corretti ed efficaci;

• il punto di vista dei traduttori, che si aspettano testi in italiano ben strutturati, perché questo è essenziale per tradurli bene.

Il cuore del progetto è costituito da una lista ragionata di regole.

Le regole riguardano la costruzione delle frasi, l'uso delle forme verbali e, più in generale, l'uso delle parole. Ci sono cose come:

• seguire l'ordine soggetto-verbo-oggetto;
• usare i verbi in forma attiva;
• indicare un oggetto specifico sempre con lo stesso nome;
• ecc...

Come è evidente a chiunque si intenda un po' di linguaggio, non è certo possibile scrivere regole troppo rigide. Il linguaggio è per natura multiforme e la redazione dei testi ha bisogno di un po' di elasticità.

Per questo, molte norme sono studiate nella forma di "consigli", che lasciano aperta la possibilità alle prevedibili eccezioni richieste dalla lingua italiana.

Insomma, l'ITS non vuole essere una cosa complicata, che fa perdere tempo e richiede troppo sforzo per applicarlo davvero nel lavoro di tutti i giorni. Le regole sono accompagnate da diversi esempi di testi prima e dopo il "restyling", in modo che sia immediato l'effetto dell'applicazione delle regole e sia facile ricordarle.

Oltre alle regole, abbiamo pensato di aggiungere qualche altro "aiuto": per esempio, criteri razionali nell'uso delle parole ambigue, a vantaggio della chiarezza ma anche per aiutare la traduzione assistita, e qualche indicazione su parole “vietate”, nel senso che, pur essendo frequenti nell'uso comune, è  meglio evitarle del tutto nel linguaggio tecnico, perché inutili.

Il progetto ITS sta coinvolgendo diversi soci di COM&TEC, che contribuiscono con la propria esperienza diretta.

Per tutelare i risultati del loro lavoro, a beneficio dell'intera categoria, l'associazione ha deciso di registrare il marchio ITS®. Questa mossa ha recentemente creato un po' di scompiglio nel (piccolo!) ambiente della comunicazione tecnica italiana. Qualcuno sta già tentando di sfruttare la situazione a proprio vantaggio, rilanciando il nome "Italiano tecnico semplificato" come proprio.

Al di là dell'evidente violazione dei diritti di COM&TEC, questo la dice comunque lunga sul fatto che il nostro ambiente professionale sia ormai maturo per introdurre metodi e regole su questi aspetti "di base" del nostro lavoro.

Da parte di COM&TEC non possiamo quindi che sentirci lusingati da queste, seppur improprie, attenzioni al nostro progetto.

 La nostra speranza è che l'ITS, una volta reso pubblico, sia davvero d'aiuto alla comunità dei colleghi comunicatori tecnici, e faccia avanzare di un passo la nostra comune professionalità.

Leggi questo articolo...

Il Foglietto Illustrativo dei medicinali

di Rossella Ferrari

Il foglietto illustrativo è il più diffuso documento tecnico in ambito farmaceutico.

E’ contenuto – per legge – in ogni farmaco, a esclusione dei  farmaci omeopatici e fitoterapici (integratori) ed è quindi un documento ufficiale. Oltre a questo, il foglietto illustrativo dovrebbe essere anche uno strumento comunicativo efficace perché riguarda l’impiego di prodotti riguardanti la salute, ossia un ambito delicato e difficile.


Purtroppo, non è sempre così. Soprattutto in Italia, il foglietto illustrativo (ancora oggi spesso chiamato “bugiardino”) è innanzitutto un documento redatto in base a precisi vincoli normativi e burocratici.

Ma questo approccio spesso si rivela disarmonico con l’idea che debba essere anche un mezzo di comunicazione efficace al corretto uso del farmaco, quindi con un’attenzione più focalizzata sulla capacità di comprensione dei contenuti da parte dell’utente che lo deve assumere.

In anni recenti, la European Medicines Agency (EMA) ha modificato il format dei foglietti illustrativi dei nuovi farmaci approvati a livello europeo.

Quindi oggi possiamo avere foglietti con lo schema europeo, formulato con criteri di leggibilità ben precisi e/o strutturato con “domande e risposte”, ma anche foglietti illustrativi di farmaci approvati e immessi in commercio da tempo, redatti con lo schema tradizionale, generalmente approvati solo per il territorio nazionale.

Oltre alle informazioni standard  richieste dalle autorità regolatorie, le case farmaceutiche possono aggiungere tutte le indicazioni che ritengono più opportune (inserite, comunque, nell’elenco delle caratteristiche per cui il prodotto è stato approvato).

Di conseguenza, i farmaci con lo stesso principio attivo ma prodotti da società diverse possono avere foglietti illustrativi con testi differenti e, a volte, con discrepanze di vario genere.

Dal punto di vista dei contenuti le informazioni sono numerose, a volte troppo “affollate” e, soprattutto, poco comprensibili.

Da alcuni sondaggi condotti sul pubblico, i principali ostacoli alla comprensione del foglietto illustrativo sono:

• eccessiva lunghezza
• linguaggio troppo tecnico
• carattere di stampa troppo piccolo
• mancanza di risalto delle principali avvertenze
• scarsa chiarezza sui rischi ed effetti indesiderati

Ad esempio:

• “interazione tra farmaci” è un'indicazione che risulta, di fatto, incomprensibile
• “posologia” potrebbe essere sostituito con “modalità di somministrazione”
• “evitare l’uso prolungato” è un concetto poco chiaro... prolungato quanto?

Il format realizzato dall’Agenzia Europea dei Medicinali ha rappresentato un passo avanti e, d’altra parte, integrare necessità burocratiche e necessità di comunicazione non è facile ma, sicuramente altri progressi sarebbero possibili. Leggi questo articolo...

Come tradurre un manuale tecnico scritto in LaTeX

di Marco Cevoli.

Il procedimento per tradurre un manuale redatto in LaTeX mantenendo la formattazione originale non è così complicato come potrebbe sembrare.
Esistono vari strumenti gratuiti e open source che rendono la vita dei traduttori più agevole.

LaTeX è un linguaggio di markup usato per la preparazione di testi complessi, soprattutto in ambito matematico e scientifico, poiché consente un’estrema precisione nell’impaginazione.

È distribuito come software libero e si basa sul programma di tipografia digitale TEX, creato nel 1978 da Donald Knuth, un celebre studioso e professore d'informatica degli Stati Uniti.

Una curiosità: la pronuncia esatta è /latek/ e non /latecs/, perché poiché il nome TEX deriva dalla radice della parola greca τέχνη, (techne) che significa arte, tecnica, tecnologia. La X presente nel nome è dunque la lettera greca “chi” maiuscola (Χ) la cui grafia si confonde con quella della “ics” dell’alfabeto latino.

I file LaTeX sono file di testo semplice che seguono una formattazione particolare, con etichette e codici di controllo. A colpo d’occhio non è sempre facilissimo distinguere quali parti costituiscono il contenuto traducibile e quali no. Un’ulteriore difficoltà è rappresentata dal fatto che normalmente un manuale complesso non è formato da un solo file TEX, ma da una struttura di cartelle in cui sono annidati diversi file insieme alle corrispondenti illustrazioni.

L’opzione più immediata sarebbe quella di aprire i file che costituiscono il manuale con un editor di testo traducendoli uno per volta. Tuttavia con questa procedura è facile commettere errori, cancellando ad esempio parti di codice, oppure saltando elementi traducibili. Anche per questo motivo, nell’ambito della traduzione tecnica si è soliti usare strumenti di traduzione assistita, ovvero programmi che immagazzinano le frasi tradotte in un database allo scopo di riutilizzarle.

Ciò garantisce maggiore uniformità, consente di non tradurre due volte i testi ripetuti (sempre abbondanti nei manuali tecnici), permette di elaborare tutti i singoli file in un colpo solo e agevola il lavoro del traduttore perché gli presenta soltanto le parti traducibili del testo. Il problema è che il programma più usato nel settore, SDL Trados, non è in grado di aprire il formato LaTeX. Per meglio dire, è in grado di aprire file di testo, ma senza distinguere le parti traducibili dal resto. Fortunatamente esistono due strumenti gratuiti che vengono in aiuto dei traduttori:

• Tortoise Tagger

• OmegaT

La serie di macro di Microsoft Word chiamata Tortoise Tagger, sviluppata da Aleksandr Okunev nel 2004, consente di bloccare tutte le parti di codice LaTeX esponendo soltanto il testo effettivamente da tradurre.
In un secondo momento si può usare uno strumento di traduzione assistita in grado di elaborare file Word o RTF con etichette di Trados, come appunto SDL Trados, Wordfast o memoQ, solo per citarne alcuni fra i più noti.

In alternativa, si può usare OmegaT, un potente strumento di traduzione assistita gratuito e open source, che non ha nulla da invidiare ad altri programmi commerciali più blasonati. In questo caso, ha il vantaggio di leggere direttamente i file TEX, bloccando le parti di codice e quindi impedendo di fatto al traduttore di corrompere il contenuto del file TEX originale.

Dalla versione 2.3.0 OmegaT preserva anche le linee commentate all’interno del codice LaTeX, che spesso contengono informazioni utili a chi deve pubblicare il manuale. Il flusso di lavoro è quello standard di ogni progetto realizzato con OmegaT. Nella finestra dell’editor, verrà visualizzato solo il testo traducibile e tutto il codice sarà occulto.

Per conoscere i due procedimenti dettagliati s’invita alla lettura della versione estesa di questo articolo:
Come tradurre un manuale scritto in LaTeX, pubblicata sul sito di Qabiria.

Per saperne di più su OmegaT si consiglia la lettura del primo libro in italiano sull’argomento:
Guida completa a OmegaT: tecniche, trucchi e consigli per traduttori e PM, disponibile sia in formato paperback che come e-book. Leggi questo articolo...

Un esempio di Regola di Naming

 di Andrea Cargnelutti.


La prima cosa che un bravo Technical Writer dovrebbe fare, ancora prima di iniziare a scrivere, è quella di riflettere attentamente sui nomi da assegnare ai propri documenti e ai file che li contengono.

Purtroppo molto spesso nelle aziende regna la più totale anarchia su tale questione.



In mancanza di regole, ogni utente si sente libero di chiamare i file nel modo che gli è più congeniale, ricorrendo a nomi di fantasia o a misteriosi codici numerici, poco o per nulla informativi.

Questa anarchia rende anche molto difficile, se non addirittura impossibile, sia l’archiviazione che la rintracciabilità dei file.

Io mi sono dato delle regole che sembrano funzionare e che vorrei condividere con voi.

Innanzitutto ho iniziato considerando lo scopo che ha il nome di un documento/file. Il nome dovrebbe permettere l’identificazione univoca del documento/file in mezzo agli altri, associandolo al suo contenuto,  come il codice fiscale che corrisponde univocamente alla nostra identità.

Il nome poi dovrebbe essere facilmente decodificabile per permettere anche agli altri di capire il nostro codice e quindi l’identità del file.

Queste considerazioni mi hanno portato a stabilire la regola seguente:

Acronimo prodotto_Codice documento_Codice lingua_Versione documento

Acronimo prodotto è il nome del prodotto (es. CPU12345).

Codice documento identifica il tipo di documento. Ho definito questo codice perché l’esperienza mi ha insegnato che è meglio mantenere il nome del file il più corto possibile. Nomi troppo lunghi potrebbero infatti creare problemi al sistema operativo, ad esempio durante le operazioni di backup. “InstMan” è meglio di “Installation Manual”.

Codice lingua indica la lingua utilizzata.

Versione documento è l’indice di revisione del documento (es. 1.0). L’ho inserito all'estrema destra del nome del file subito prima dell’estensione .docx perché così mi sembrava più veloce individuarlo, anziché disperderlo all'interno del nome.

Nella seguente tabella, ecco un paio di esempi:


Nella tabella successiva, la convenzione linguistica:

Come vedete, la regola è semplice e flessibile.
Ora ... basterà rispettarla!

---------------------------------------------------------------------------

Su questo argomento, potete leggere anche:
Regole di Naming per la documentazione.

Leggi questo articolo...

Medical Writing e Marketing: attenzione, rigore ed efficacia sono un obbligo

di Rossella Ferrari.


Ci sono situazioni professionali in cui ci si deve muovere con la stessa perizia che ci imponiamo quando visitiamo una cristalleria di Murano.
E credo che il paragone possa reggere, quando si parla di una delle aree più interessanti in cui può operare il Medical Writer, cioè quella dell’attività di Marketing delle imprese farmaceutiche (intesa come attività di base per l’informazione sui farmaci).


Tale attività riveste un ruolo critico, periodicamente al centro di corposi servizi giornalistici.
In Italia esistono diverse leggi che normano anche questa materia. In primo luogo, un Decreto Legislativo del 2006 che recepisce la Direttiva Europea del 2001; in più, esistono anche Delibere Regionali (per alcune regioni italiane), emesse dal 2001 al 2007 che regolano ulteriormente l’attività promozionale ai medici e, quindi, tutti i relativi testi scritti.

I testi scritti utilizzati per la promozione di “farmaci etici” (ossia, i farmaci che si hanno in farmacia solo presentando la ricetta di un medico) devono – di regola – essere tutti redatti riferendosi a fonti bibliografiche chiaramente indicate nel testo stesso.

Inoltre, su alcuni tipi di mezzi promozionali come, per esempio, i visual aid per il medico, i testi scritti devono essere un fedele “riporto” dalle fonti indicate.

Quindi, il punto critico spesso è la bontà delle fonti bibliografiche. Di solito, sono utilizzate pubblicazioni scientifiche il cui livello viene misurato con indici internazionali basati, a loro volta, su parametri di qualità specifici.

Prima della loro produzione, i mezzi promozionali dei farmaci etici seguono un iter di controllo e approvazione interno all’azienda farmaceutica (dipartimento medico e regolatorio interno) prima di passare all’invio per approvazione al Ministero della Salute.

Trascorso un periodo di tempo dopo il quale vale la regola del “silenzio-assenso”, il materiale può essere stampato e utilizzato dagli informatori medico-scientifici.

Ma al di là delle norme, credo che la vera sfida sia distinguere il confine tra pubblicità, informazione e comunicazione.

L’attività che le aziende svolgono sui prodotti di automedicazione (senza obbligo di ricetta medica) è prevalentemente commerciale, quindi, pubblicità.

La diffusione di conoscenza circa alcune patologie può essere considerata informazione e la comunicazione (sia sui prodotti etici che di automedicazione), permettendo di comprendere, elaborare e sintetizzare le informazioni, le può trasformare in fattori di decisione su azioni da intraprendere.

Il punto cruciale è tenere sempre presente la necessità assoluta di realizzare una comunicazione sui farmaci sempre corretta e davvero efficace.

Il blog di Rossella Leggi questo articolo...

Scrittura tecnica in ambito medico-scientifico: il Medical Writing

di Rossella Ferrari.



La locuzione Medical Writing definisce e comprende un’ampia gamma di attività inerenti alla comunicazione medico-scientifica e alla produzione di documentazione di informazione medica.

I testi che un Medical Writer scrive possono riguardare diverse aree tematiche:

• Documentazione tecnica: dossier di tecnica farmaceutica, resoconti di prove di laboratorio o di studi clinici che attestano lo sviluppo della conoscenza su un nuovo farmaco.

• Documentazione per gli enti di controllo: dossier da sottoporre ad agenzie governative come, per esempio, l’Agenzia Italiana del Farmaco, Ente pubblico che opera sotto la direzione del Ministero della salute.

• Testi per aggiornamento medico: resoconti di studi clinici da pubblicare su riviste scientifiche, report di congressi, presentazioni per corsi di formazione.

• Attività di marketing delle imprese farmaceutiche: materiali illustrativi del farmaco per medici generici e specialisti (su supporti cartacei o multimediali), opuscoli per pazienti, testi per siti web delle aziende stesse o di associazioni di medici o di pazienti.

• Giornalismo medico-scientifico: articoli per riviste di settore e/o per stampa rivolta al pubblico, testi per la televisione.

• Salute pubblica: campagne d’informazioni sulle vaccinazioni o sugli stili di vita.

• Documentazione per richieste di sovvenzioni/contributi da parte di gruppi di ricerca: rivolte alla Comunità europea, ad enti nazionali e non, agenzie governative, società di Venture Capital (soprattutto nel caso di imprese biotecnologiche).

In genere un MW riesce a specializzarsi in una sola area e, sempre più spesso, vengono richiesti particolari sottospecializzazioni. Inoltre, sta aumentando anche la richiesta  di competenze in specifiche aree terapeutiche come, per esempio, l’oncologia.

La grande delicatezza delle tematiche medico-scientifiche che vengono trattate, legate alla salute umana, richiedono al MW una notevole professionalità e doti di sintesi e chiarezza che assumono una prevalente valenza qualitativa ai fini del risultato finale.

Prossimamente proverò a fornire qualche elemento di conoscenza specifica su questa professione, nel tentativo di farne comprendere, almeno a grandi linee, la complessità e il campo d’azione.


Il blog di Rossella. Leggi questo articolo...