Che cosa preferiscono i miei lettori?

Poco più di due anni di blog e ad un certo punto mi viene la curiosità di capire cosa preferiscono i miei lettori.
Ed ecco la classifica dei 15 post più letti, tratti direttamente dalle evidenze di Google Analytics:

1 - Lettera di Presentazione: qualche esempio

2 - Saper scrivere... la Lettera di Referenze

3 - Proteggere i nostri documenti con una password

4 - Saper scrivere... la Lettera di Presentazione

5 - L'uso dell'accento: regole sui monosillabi

6 - Saper scrivere... il Curriculm Vitae

7 - Saper scrivere... la Lettera d'Incarico: un primo esempio

8 - Saper scrivere... un Tutorial

9 - Esempi di Tutorial

10 - Proofreading everywhere!

11 - Saper scrivere una e-mail: 15 regole da ricordare

12 - Aggiungiamo le note al nostro Template

13 - Recuperiamo i doc danneggiati

14 - Come approcciare gli esercizi di riscrittura

15 - Gli 8 errori da evitare in un White Paper: seconda parte

Cosa possiamo dedurre da questo elenco?
Intanto che esiste una notevole sensibilità sul tema del lavoro e di questi tempi non è un dato sorprendente.Tutte le tipologie di documentazione che sono correlate a questo tema (saper scrivere il CV, la lettera di Presentazione, la lettera di Referenze) sono ai primissimi posti della classifica.

Più in generale, c'è un notevole interesse sul "saper scrivere" le più comuni composizioni che si possono incontrare in qualsiasi ambito professionale.Ma anche le problematiche più intricate della lingua italiana sono molto gettonate, a dimostrazione del fatto che esse siano effettivamente "ostiche" da dominare.

A debita distanza si collocano temi ai quali ho dedicato molto tempo ed impegno ma che sicuramente riguardano un target molto ristretto di "professionidsti" della scrittura.

Dover scrivere un Case Study, un White Paper, un Abstract è un'eventualità che di certo non riguarda la più larga parte dei lettori che frequentano il blog.

Fuori classifica possiamo trovare i post "più recenti" (che hanno avuto un minor tempo di esposizione sul blog) ma anche qualche post un pò troppo "filosofico" come quelli che ho dedicato al problema della "qualità" della documentazionew tecnica.

Anche in tal caso, un tema che può interessare ai TW professionisti, ma non alla maggiorparte dei lettori che solcano la rete per trovare risposte immediate ai loro problemi di scrittura.

Non credo che modificherò radicalmente la gestione dle blog sulla base di tale risultanze. L'idea di base è sempre quella di raccontare quanto meglio possibile le mie esperienze professionali, illustrando le caratteristiche salienti di questa professione nel modo più diretto ed efficace possibile.

Ovviamente proverò ad approfondire meglio le tematiche più gettonate ma continuerò a proporre anche idee meno "popolari" ma che ritengo comunque interessanti.

Cosa ne pensate? Fatemi sapere, mi farebbe piacere un confronto di opinioni. 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...

150 anni... AUGURI Italia! Ne hai un gran bisogno!

...Noi fummo da secoli calpesti, derisi, perchè non siam popolo, perchè siam divisi...

Questo è uno dei versi più amaramente attuali del nostro inno Nazionale. Di solito, siamo abituati a cantare (per chi lo canta...) solo la prima strofa dell'inno seguita dal coro, ignorando le rimanenti quattro strofe.

In questo momento, in un paese dove più e peggio che in altri periodi difficili della nostra storia, spadroneggiano e sembrano prevalere loschi e miserabili figuri, taluni vestiti in camicia verde, che fanno dell'ignoranza, della mancanza di dignità e del disprezzo delle regole e della cultura i loro vessilli, forse dobbiamo ripartire da questo verso poco conosciuto e riflettere.

Il testo integrale dell'inno, di seguito:

Fratelli d'Italia,

l'Italia s'è desta,
dell'elmo di Scipio
s'è cinta la testa.
Dov'è la vittoria?
Le porga la chioma,
che schiava di Roma
Iddio la creò.

    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò.
    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò!

Noi fummo da secoli
calpesti, derisi,
perché non siam popolo,
perché siam divisi.
Raccolgaci un'unica
bandiera, una speme:
di fonderci insieme
già l'ora suonò.

    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò.
    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò!

Uniamoci, amiamoci,
l'unione e l'amore
rivelano ai popoli
le vie del Signore.
Giuriamo far libero
il suolo natio:
uniti, per Dio,
chi vincer ci può?

    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò.
    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò!

Dall'Alpi a Sicilia
Dovunque è Legnano,
Ogn'uom di Ferruccio
Ha il core, ha la mano,
I bimbi d'Italia
Si chiaman Balilla,
Il suon d'ogni squilla
I Vespri suonò.

    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò.
    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò!

Son giunchi che piegano
Le spade vendute:
Già l'Aquila d'Austria
Le penne ha perdute.
Il sangue d'Italia,
Il sangue Polacco,
Bevé, col cosacco,
Ma il cor le bruciò.

    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò.
    Stringiamci a coorte,
    siam pronti alla morte.
    Siam pronti alla morte,
    l'Italia chiamò!
    Sì (cantato)

Leggi questo articolo...

Ma quanto costa il lavoro di un Technical Writer?

Sto attraversando un periodo di super-lavoro, uno di quei periodi che penso siano capitati a tutti, quando le cose da fare richiederebbero ALMENO un tempo T e invece non si dispone nemmeno di un terzo di T.

Sono quei momenti in cui la stanchezza tira per la giacchetta lo spiritello del malanimo e in cui ci viene da pensare: " Ma quanto mi dovrebbero pagare IN PIU' per tutto quello che sto facendo, rispetto a quello che guadagno?".

Ecco, per un TW che è chiamato a realizzare molte cose diverse, secondo schemi retributivi spesso non omogenei, la risposta a questa domanda è sempre complicata.

E' evidente che scrivere un manuale da zero è diverso dall'attività di proofreading di una bozza magari scritta da un collega. Ed è difficile paragonare il tempo di lavoro necessario a realizzare della grafica da inserire in una presentazione, rispetto al tempo che viene impiegato per impaginare tabelle e grafici già pronti.

Inoltre, tali attività assumono un diverso peso economico se siete stipendiati da un'azienda o lavorate in modalità feee-lance per quell'azienda.

Esiste una metrica universale che si possa applicare ai diversi campi d'azione di un TW? E' più opportuno ragionare "a progetto" o per tipologia di documento? Ci si deve regolare a "pagine al giorno" o "parole per pagina"?

Dal sito Editorial Freelancer Association vi propongo la seguente tabella:

Quando si tratta di numeri e statistiche, gli anglosassoni sono molto affidabili e i valori che vedete nella tabella (riferibili al Settembre del 2010), pur potendo variare anche in funzione della zona geografica, sono un buon riferimento.

Tanto per essere chiari, recentemente, via Linkedin, ho letto una proposta di lavoro free-lance che parlava di un compenso pari a 5$ l'ora per attività di editing, indirizzata al mercato indiano. Vi lascio immaginare le reazioni di molti TW davanti a questa "proposta indecente", ma la proponente, un po' stupita e piccata, ha tenuto a precisare che in India sono prezzi normali... anche se poi ha aggiunto che spesso la qualità del risultato finale lascia a desiderare! MA GUARDA!

Fin dalle scuole elementari ci hanno insegnato che non si sommano le pere con le mele, quindi è evidente, come la tabella dimostra, che bisogna individuare una metrica per ogni specifica attività.

Che ne pensate? Da parte mia, la tabella ha acuito il mio spiritello del malanimo... dovrei proprio farmi pagare di più! :-)
Leggi questo articolo...

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

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

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

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

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