giovedì 24 febbraio 2011

Un altro ospite in Open Blog: Andrea Cargnelutti

Stasera vi presento Andrea Cargnelutti, uno dei miei lettori.

Vive ad Udine, dove lavora presso un'importante azienda operante nel settore dei computer miniaturizzati.

E' un Technical Writer che progetta e realizza la documentazione tecnica della sua azienda. In passato ha anche scritto per riviste specializzate di elettronica ed automazione industriale.



Frequenta il mio blog da un pezzo e, bontà sua, sostiene di averne tratto giovamento e indicazioni utili per il suo lavoro. Anche lui, come me, lavora per un'azienda che PRODUCE TECNOLOGIA (tipologia non comune, in Italia) e che quindi ha bisogno dell'apporto di un "comunicatore tecnico". A tal proposito vi segnalo due post abbastanza recenti sull'argomento:

Perchè un'azienda dovrebbe assumere un Technical Writer: prima parte

Perchè un'azienda dovrebbe assumere un Technical Writer: seconda parte

Prossimamente pubblicherò un post di Andrea sulle regole di Naming.
Spero che sia l'inizio di una bella collaborazione.

Benvenuto in Open Blog, Andrea!
:-)



OPEN BLOG GUESTS

Rossella Ferrari
Andrea Cargnelutti Leggi questo articolo...

mercoledì 23 febbraio 2011

Saper scrivere... l'Abstract: seconda parte

Nel post del 2 Febbraio 2011 vi ho introdotto alla realizzazione dell'Abstract, uno dei componimenti classici in ambito tecnico-scientifico. Di seguito vi propongo un esempio/template standard per la sua realizzazione.


In rete potete facilmente trovare altri esempi di questo tipo. Vi rammento che l'Abstract nasce tradizionalmente in ambito tecnico-scientifico e su supporto cartaceo. Per questo motivo si preferisce usare un font come il Times New Roman, cioè un font "con le grazie", che facilitano la lettura su carta.

Tuttavia, se dovete pubblicare un Abstract su Web, allora si può tentare di innovare la tradizione e usare un Arial o un Calibri, cioè un font "senza grazie", più leggibile sullo schermo di un computer.

Vi sconsiglio di ricorrere ad un "minestrone" di font diversi. Al massimo, potete pensare di differenziare il font con cui indicate gli Autori, mentre per il Titolo ed il Corpo è opportuno utilizzare un font uniforme.

Tenete presente che, in base al contesto in cui vi trovate ad operare, potreste poi dover adottare regole di composizione ed accorgimenti specifici di quel contesto.

Tuttavia, le linee-guida che vi ho indicato sono sempre valide nella grande maggioranza dei casi.

Se volete scaricare questo semplice Template, potete farlo via Scribd. Leggi questo articolo...

lunedì 14 febbraio 2011

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...

domenica 13 febbraio 2011

SE NON ORA... QUANDO?

Oggi, grazie alle centinaia di migliaia di donne e di uomini che sono nelle tante piazze di questo paese, NON MI VERGOGNO DI ESSERE ITALIANO... come purtoppo mi è capitato sovente, ultimamente.

Firmate anche voi sul sito:

http://senonoraquando13febbraio2011.wordpress.com/ Leggi questo articolo...

Saper scrivere... il Manuale di Collaudo: seconda parte

Vi ho già presentato due post relativi alla "filosofia" sulla quale basare la realizzazione di un Manuale di Collaudo:

- Saper scrivere... il Manuale di Collaudo
- Saper scrivere... il Manuale di Collaudo: prima parte

Con questo post vi presento un esempio ridotto ma concreto di come si "materializza" l'implementazione dello standard esposto nell'ultimo post.

Immaginiamo di dover collaudare un'applicazione software che implementa delle funzionalità di firma digitale.
L'albero che descrive lo spazio dei test è quello riportato di seguito:

I nodi evidenziati sono relativi alle tabelle che vengono riportare di seguito.
Nella prima tabella inquadriamo i 4 Test Design che coincidono con i nodi arancio:

Nella seconda tabella descriviamo lo scopo e la struttura del Test Design 01:

Nell'ultima riga sono indicati i Test Case di secondo livello (nodi blù).
In quella successiva, evidenziamo scopo e struttura del Test Case 01-03:

Ora siamo arrivati all'ultimo step (nodi rossi).
Non resta che definire le Test Procedure che descrivono ESATTAMENTE i passi da effettuare per testare le funzionalità elementari. Di seguito, potete esaminarne due:

Come vedete, completando interamente il processo di analisi dello spazio dei test, si arriva ad individuare delle sequenze ragionevolmente semplici (che ovviamente dipendono dalla complessità del sistema/processo che stiamo collaudando).

Se tutti i test definiti attraverso questa metodologia vanno a buon fine, potremo dire che il collaudo è riuscito.

E' evidente che in questa sede non è possibile mostrare l'intera struttura, in ogni particolare, di un Manuale di Collaudo, anche nel caso di una situazione abbastanza semplice come quella che ho focalizzato in questo esempio. Spero che gli elementi forniti siano stati sufficenti ad inquadrare le linee guida essenziali di questa metodologia. Se volete approfondire l'argomento... sapete dove trovarmi. Ciao.
;-)



Leggi questo articolo...

sabato 5 febbraio 2011

Proofreading everywhere!

Vi segnalo l'ultimo post di Rossella Ferrari sul suo blog, in cui si parla dell'importanza dell'attività di proofreading nell'ambito del Medical Writing. Ho scritto più volte in passato su questo argomento e in particolare:

- Febbraio 2010

- Dicembre 2009

Per me è una specie di fissazione, perdonatemi. Ma come dimostra Rossella, è un aspetto fondamentale per la qualità del processo di scrittura in ogni ambito. Leggi questo articolo...

mercoledì 2 febbraio 2011

Saper scrivere... l'Abstract: prima parte

Qual è quel componimento che si scrive per ultimo e si legge per primo?

Questo indovinello potrebbe vagamente assomigliare a quello che la perfida Turandot proponeva al principe Kalaf.

In questo caso la risposta è di gran lunga meno insidiosa: l'Abstract.

L'Abstract è una tipologia di testo che ricade nella categoria della "scrittura breve".

La scrittura breve ha iniziato ad essere analizzata da quando si è affermato il Web, si è rafforzata da quando abbiamo iniziato a chattare e si è esaltata da quando abbiamo preso confidenza con gli SMS. Ci siamo ormai abituati a scrivere e leggere velocemente, poche frasi e poche parole, massima sintesi.

Qualcuno sostiene che tale tendenza abbia portato ad un impoverimento della lingua scritta. In realtà si tratta semplicemente  di una nuova "tipologia" di comunicazione. Ma molto utile, perché un cervello allenato a condensare una comunicazione efficace in poco spazio può risultare particolarmente comodo nel mondo del lavoro, quando il tempo non è mai abbastanza ed i compiti a cui fare fronte sono sempre numerosi.

L'Abstract uno dei componimenti classici con i quali è molto probabile che ci si debba misurare, prima o poi.

Originariamente utilizzato in ambito accademico-scientifico, viene oggi utilizzato in ambiti molto diversi. Esso consiste nel riassunto del contenuto di un documento, una sintesi estremamente breve, chiara, incisiva e completa, in grado di offrire tutte le informazioni salienti in esso presenti. Indipendentemente dalla lunghezza del documento a cui si riferisce, l'Abstract non deve superare la mezza cartella di lunghezza (800 caratteri/200 parole circa), potendo estendersi ad una cartella intera solo in rari casi.

Un buon Abstract serve a “convincere” il lettore a proseguire nella lettura del documento integrale o magari a pagare una certa somma di denaro per scaricare l'articolo dal Web.

Ogni giorno, nell'ambito delle nostre ordinarie attività professionali, siamo chiamati a leggere e valutare una quantità crescente di testi e dati. La lettura di un Abstract esauriente e condensato, fedele al contenuto del documento associato, ci permette di filtrare quello che effettivamente ci interessa, riducendo notevolmente la mole di informazioni da vagliare.

Come possiamo scrivere un Abstract che riesca a “vendere” meglio il relativo articolo/saggio scientifico/convegno/documento tecnico?

La risposta a questa domanda non è univoca, ma intanto iniziamo a stabilire alcune regole di base che costituiranno la nostra "bussola".

CHI LEGGE L'ABSTRACT

Come dico sempre, in primo luogo dobbiamo focalizzare nella nostra mente il lettore "target" che dovrà leggerlo. L'Abstract viene generalmente letto da specialisti dell'argomento a cui si riferisce, quindi possiamo usare un linguaggio "per addetti ai lavori". Lo stile è asciutto, frasi brevi, sintassi accurata e lineare, il tempo verbale utilizzato di solito è l'indicativo presente.

LA STRUTTURA DELL'ABSTRACT

La prima frase deve indicare il tema. Si può usare una struttura classica, del tipo introduzione-corpo-conclusione che segua l'indice degli argomenti presentati nel documento. A partire dall'indice, è opportuno individuare una sequenza di concetti chiave e costruire una frase breve e completa in grado di delineare ogni concetto. Quindi, si dovrà integrare ogni frase così costruita in un testo fluido e coerente, ove le frasi risultino ben connesse tra loro e dove ogni passaggio logico risulti funzionale alla comprensione del tutto. Vanno banditi commenti, aggettivi e giudizi di merito sui contenuti. L'Abstract deve fornire una specie di "radiografia" del documento in oggetto,nulla di più. Nel caso classico di una ricerca scientifica, deve focalizzare l'argomento presentato nel documento/articolo,le ipotesi di partenza e le tesi finali, le metodologie utilizzate, i risultati ottenuti, le relative conclusioni.

CHI SCRIVE L'ABSTRACT

Dovrei dire, pro domo mia, un Technical Writer! E anche esperto.
In realtà, in questo caso il TW dovrebbe intervenire solo nella revisione formale e linguistica del testo.
In genere, possiamo considerare l'autore del documento stesso come la persona più indicata per sua la realizzazione.L'autore possiede in effetti la necessaria competenza per sintetizzare al meglio i concetti da lui stesso espressi all'interno del suo articolo/documento.

Il TW dovrebbe intervenire solo in seconda lettura, per risolvere qualche eventuale stortura lessicale.

Prossimamente vi proporrò un template ed un esempio. A presto. Leggi questo articolo...