sabato 16 ottobre 2010

Calcolare il valore degli Indici di Leggibilità con Word

Nel post del 10-10-2010 ho introdotto il tema degli Indici di Leggibilità.
La gran parte delle persone che scrive un testo sul PC usa Office Word.
Ma pochi sanno che Word offre la possibilità di valutare la leggibilità di un testo attraverso il calcolo degli indici Gulpease e Gunning Fog.

L'Indice Gulpease, presentato nel post sopraindicato, è adatto alla lingua italiana mentre il Gunning Fog è finalizzato alla lingua inglese (parole più corte e con poche sillabe).
 
Per poter eseguire il calcolo di tali indici, bisogna configurare Word con pochi semplici passaggi:

1.    Dalla barra dei Menù, selezionare Strumenti > Opzioni
2.    Nel pannello Opzioni, selezionare la scheda Ortografia e Grammatica
3.    Nella sezione Grammatica, spuntare la check-box Mostra le statistiche di leggibilità
4.    Premere il pulsante Ok, in basso a destra nel pannello Opzioni

A questo punto, se volete analizzare la leggibilità del vostro documento, dovete eseguire un controllo ortografico:

1.    Dalla barra dei Menù, selezionare Strumenti > Controlli Ortografia e Grammatica

Al termine del controllo ortografico viene visualizzato il pannello riassuntivo:

 
 I dati presenti nel pannello sono riferiti alle prime 3 frasi di questo post.

Leggi questo articolo...

lunedì 11 ottobre 2010

Buone prospettive per la professione di Technical Writer!

Ogni tanto una buona notizia ci vuole!

Dal blog di Luisa Carrada vi segnalo un post in cui si prospettano buone possibilità per la professione di Technical Writer, specialmente per coloro che padroneggiano la lingua inglese. La notizia si riferisce al mercato USA per il 2010, ma con le dovute pinze possiamo immaginare di poterla proiettare anche sul mercato nazionale ed Europeo.

Nel post Luisa cita anche il mio blog, bontà sua.

Ho la piacevole sensazione che forse si sta iniziando a capire l'importanza della comunicazione tecnica per sviluppare e creare valore aggiunto nella logica di business di un'azienda.

Nel mondo anglosassone questo concetto è già consolidato e in crescita, in Italia ci sono ancora praterie inesplorate a disposizione.

Se son rose... Leggi questo articolo...

domenica 10 ottobre 2010

La Qualità della documentazione tecnica: la Leggibilità

Quante volte, davanti ad un documento tecnico, avete avvertito la sgradevole sensazione che stavate leggendo qualcosa di poco comprensibile, anche se magari eravate degli esperti dell'argomento trattato?

Quante volte avete pensato che quel documento era poco "leggibile"?

Con il termine "leggibilità" intendiamo una particolare proprietà per cui un testo risulta comprensibile, facile da leggere. Tale proprietà può essere associata a qualsiasi testo scritto ed è influenzata sia da aspetti fisici che da aspetti linguistici.

La lettura di un testo sullo schermo di un PC risulta mediamente più lenta del 20-30% rispetto allo stesso testo scritto su carta. Anche la capacità di concentrazione di un lettore tende a ridursi più velocemente se legge un testo da una pagina Web piuttosto che da un libro tradizionale. Di conseguenza, l'utente Web legge di rado parola per parola, ma tende a "scannerizzare" la pagina alla ricerca di punti "sensibili" alla sua attenzione (titoli, elenchi, spaziature, immagini, ecc...) e saltando velocemente da una parte all'altra della pagina.

Queste osservazioni, dipendenti dal supporto "fisico" sul quale collochiamo il testo, hanno permesso di formulare specifiche regole di scrittura per il Web, che sono riassunte nelle diverse Guide di Stile che potete trovare in rete e sulle quali tornerò prossimamente con un post dedicato.

La leggibilità "linguistica" riguarda l'uso della lingua in tutte le sue componenti, dalla scelta dei termini e della sintassi impiegata all'articolazione dei contenuti.

Lo studioso americano Rudolf Flesch fu il primo a proporre un metodo "oggettivo" per misurare la leggibilità (Indice di Flesch, 1946).
La formula tiene conto della lunghezza media delle parole, misurate in sillabe, e della lunghezza media delle frasi, misurata in parole.
I principi basilari sono molto semplici:
  • una parola lunga è in genere usata meno di una breve;
  • una frase lunga è di solito sintatticamente più complessa di una breve.
La formula di Flesch, adattata alla lingua italiana da Roberto Vacca, è la seguente:

F = 206 - (0,6 * S) - P

ove:
  • 206 è una costante normalizzatrice, finalizzata a mantenere i valori della formula compresi fra 0 e 100;
  • 0,6 è una costante relativa alla lunghezza media delle parole italiane;
  • S è il numero di sillabe contenute in un campione di 100 parole;
  • P è il numero medio di parole per frase presenti in un campione di 100 parole.
Se F>60, il testo è MOLTO leggibile.

Se 50<60, il testo è di MEDIA leggibilità.

Se F<50, il testo è POCO leggibile.

Per calcolare la leggibilità con questo indice è necessario scegliere un campione adeguato alla lunghezza del testo stesso (tanto per semplificare, una sezione almeno pari al 10-15% del testo).
Terminata questa operazione, si dovranno contare le sillabe contenute nel campione e calcolare il numero medio di parole per frase.

Come vedete, non è un'operazione banale.
Esistono anche altri indici, oltre a questo.

Nel 1987 un gruppo di linguisti dell'Università La Sapienza di Roma si è riunita attorno a Tullio De Mauro per costituire il GULP, Gruppo Universitario Linguistico Pedagogico. In questi laboratori è nato l'Indice Gulpease.


La scala di leggibilità secondo questo indice va da 100 (leggibilità massima) a 0 (leggibilità nulla). I lettori che hanno un'istruzione elementare leggono facilmente i testi che presentano un indice superiore a 80. I lettori che hanno un'istruzione media leggono facilmente i testi con indice superiore a 60. I lettori che hanno un'istruzione superiore leggono facilmente i testi con indice superiore a 40.
 

Quindi, per ottenere testi leggibili, bisogna semplificare!

La formula dell'Indice Gulpease è:

G= 89 - (Lp / 10) + (3 × Fr)

ove:

  • Lp = (100 × totale lettere) / totale parole
  • Fr = (100 × totale frasi) / totale parole
L'Indice Gulpease è il primo indice di leggibilità tarato sulla lingua italiana e ha il vantaggio di calcolare la lunghezza delle parole in lettere, anziché in sillabe. In rete è possibile trovare dei siti Web che consentono il calcolo dell'indice Gulpease e io ve ne propongo tre:

ANALIZZATORE LEGGIBILITA' 1 


ANALIZZATORE LEGGIBILITA' 2 


ANALIZZATORE LEGGIBILITA' 3

Sperimentateli.

Generalmente non siamo abituati a calcolare l'Indice di Leggibilità di quello che scriviamo.
Ma realizzare documenti leggibili può essere molto desiderabile quando scriviamo per il Web o quando dobbiamo valutare i costi da sostenere per tradurre i nostri documenti o quando scriviamo documenti per la Pubblica Amministrazione che poi devono essere proposti agli utenti.

Tali indici sono delle armi molto utili nella lotta al "burocratese" che, soprattutto in Italia, è spesso molto diffuso. Non è certo banale semplificare testi che trattano argomenti/concetti complessi, qualche volta è quasi impossibile. 


A maggior ragione, se ci riusciamo, possiamo dire di aver aggiunto un pezzo al puzzle della Qualità di un documento tecnico che tentiamo di costruire.

Leggi questo articolo...

giovedì 7 ottobre 2010

Come realizzare un Video Tutorial: i fondamentali

Per realizzare un Video Tutorial bisogna dotarsi di un software in grado di manipolare un filmato, magari realizzato con una videocamera o una web-cam, e che possa catturare le immagini che fluiscono sullo schermo di un PC. Ai fini della realizzazione di un Video Tutorial, sono veramente fondamentali poche funzionalità ed essenzialmente:
  • la possibilità di realizzare un filmato in diversi formati;
  • la possibilità di partizionare lo schermo in diverse zone;
  • la possibilità di avere funzionalità di "post-produzione", come quella di aggiungere la voce narrante dopo aver realizzato il video (rendendo asincrona la realizzazione dell'audio rispetto al video) o aggiungere testi scritti ed elementi grafici al video
 Io conosco direttamente due prodotti:
  • CamStudio
  • Camtasia Studio

CamStudio è un prodotto Open Source, gratuito, molto spartano ma efficace e la sua installazione dura circa un minuto. Consente di registrare qualsiasi attività che si svolge sullo schermo del vostro computer, prendendolo in considerazione nella sua interezza o selezionandone solo una regione specifica.
Il video prodotto è in formato AVI o SWF (formato Flash).
CamStudio consente inoltre di catturare l'audio dal microfono o dalle periferiche audio del sistema, nonchè di personalizzare il video con testo e note. L'interfaccia di CamStudio offre un menù essenziale ed intuitivo.
Se siete dei noefiti e non avete pretese iper-professionali, va benissimo.

CamtasiaStudio è un prodotto molto professionale, con licenza a pagamento, che fornisce numerose possibilità di configurazione. Produce filmati in diversi formati, oltre al formato proprietario CAMREC:
  • Flash (SWF/FLV) - Adobe Flash output
  • WMV - Windows Media streaming video
  • MOV - QuickTime movie
  • AVI video
  • iPod/iTunes
  • RM - Real Media streaming media
  • CAMV - Camtasia for RealPlayer streaming media 
  • GIF animation file
Anche Camtasia Studio consente di realizzare un video che registra tutto ciò che accade sull'intero schermo o solo in una parte di esso. Una volta terminata la registrazione si dispone di un ampio insieme di opzioni di post-produzione (diverse modalità di editing, effetti di transizione, aggiunta del commento audio, zoom, definizione di rapporti di compressione del video, aggiunta di un watermark,...).

Prendere confidenza con questi strumenti è un pre-requisito per poter iniziare a sviluppare un Video Tutorial.
Come ripeto, ce ne sono molti altri, sia freeware (gratuiti) che a pagamento.

Dovete valutare quello che vi interessa in base alle vostre esigenze e poi potete iniziare a "giocare". A presto.
Leggi questo articolo...

lunedì 4 ottobre 2010

Un esempio di White Paper tecnico

Nel mese di Aprile vi avevo illustrato una classificazione dei diversi tipi di White Paper che si potevano realizzare. Tra questi, avevo indicato quali erano le caratteristiche fondamentali di un White Paper "tecnico".
Ora ecco un un esempio classico di questa tipologia. Potete confrontare la struttura di questo WP della Symantec con le linee guida che vi avevo fornito nel post del 25 Aprile e rilevare una sostanziale sovrapposizione delle due impostazioni... oppure no?!? Si accettano eventuali contestazioni! :-) Leggi questo articolo...

sabato 2 ottobre 2010

Il Video Tutorial: uno strumento efficace per una comunicazione agile

Da quando YouTube ha sdoganato il film-maker che c'è in ognuno di noi, il "video" è uscito dal recinto della produzione artistica ed è diventato, grazie anche alla diffusione di strumenti di riproduzione hardware/software a basso costo, un mezzo di  comunicazione che tutti possono utilizzare in qualsiasi frangente, allo scopo di documentare le proprie attività, passioni e i diversi momenti di vita di ognuno di noi.

Ma da qualche anno, nell'ambito della comunicazione tecnica, si è diffuso l'uso del Video-Tutorial, un particolare tipo di video in cui vengono descritte delle sequenze operative ben definite inerenti all'uso di applicazioni software, strumenti tecnici e soluzioni tecnologiche di vario tipo.

Il Video Tutorial è una nuova frontiera per il comunicatore tecnico ed è uno strumento complementare rispetto al panorama delle diverse opzioni tradizionali.

Ricordiamo che un Tutorial è un documento in cui un certo argomento viene esposto in una modalità estremamente semplificata,  attraverso delle descrizioni sintetiche, spesso in modalità "passo-passo", corredate da immagini di supporto finalizzate a migliorarne la comprensione.

Un Video Tutorial si ispira allo stesso schema, ma sfrutta il connubio tra immagini e parole per rendere ancora più incisiva ed  immediata l'efficacia comunicativa.

Una caratteristica specifica del Video Tutorial è quella della brevità.

Mentre un Tutorial tradizionale cartaceo può comunque essere un documento anche molto voluminoso, un VT deve avere uno sviluppo che può ragionevolmente oscillare tra i 3-4 e i 15-20 minuti. Ovviamente nessuno vi impedisce di realizzarne uno da 2 ore, ma non credo che potrà riscuotere particolari consensi, indipendentemente dall'argomento e dalle vostre capacità didattiche.

In rete vi sono numerosissimi esempi di VT, non sempre di qualità eccelsa, ma comunque interessanti.

Per iniziare, segnalo questo sito agli appassionati di grafica e in particolare di Photoshop, dove troverete numerosi VT in italiano sull'uso del più famoso software di fotoritocco.

Invece, per gli appassionati di altri prodotti Adobe, vi segnalo la Web TV di Adobe, in cui sono illustrate le diverse funzionalità dei vari moduli della suite.

E PRECISO CHE NON PRENDO SOLDI DA ADOBE! :-)

E per uscire dal campo ICT, un omaggio alle frequentatrici del blog con un make-up VT tanto per tenere sempre a mente l'altra metà del cielo!
Leggi questo articolo...

sabato 25 settembre 2010

Le immagini in un documento sono importanti: meglio se belle e free!

Vi ho già proposto in passato alcuni post relativi all'importanza dell'uso di immagini, grafici e tabelle in un documento tecnico. In questi giorni su Linkedin ho seguito una discussione in cui diversi technical writer hanno ammesso la loro inadeguatezza nel campo della realizzazione di immagini efficaci da inserire nei loro documenti. Di contro, è quanto mai raro che un'azienda, specialmente nel campo ICT, decida di pagare un grafico professionista a supporto dell'attività di comunicazione tecnica e di marketing.
Di conseguenza, i TW sono chiamati ad arricchire il loro skill per poter realizzare autonomamente gli add-on grafici di cui hanno bisogno. Io non sono un grafico e mi ritrovo spesso a dover provvedere in prima persona a realizzare gli elementi grafici che inserisco nei miei documenti, ottenendo risultati credo (spero...) assolutamente soddisfacenti ma certo non paragonabili a quelli che potrebbero essere ottenuti da un vero grafico.

In quest'ottica vi segnalo un post dal blog di Giacomo Mason (già presente nella sezione DA VISITARE), in cui l'autore mette a fuoco la valenza dell'uso delle immagini in una presentazione e fornisce un set di link utili per accedere ad immagini gratuite e copyright-free.

Sapere di poter attingere a delle collezioni di belle immagini già pronte è consolante, specie per chi conosce la fatica dell'autodidatta e le annesse nottate passate su Photoshop a filtrare, sovrapporre, provare effetti e ancora e ancora... tutto per beccare l'immagine "giusta". Leggi questo articolo...

venerdì 24 settembre 2010

La documentazione tecnica come moltiplicatore di business revenues

Vi segnalo un articolo pubblicato su Forbes da Aron Fulkerson, in cui l'autore sostiene che, per un'azienda "illuminata", lo sviluppo della documentazione di prodotto può essere un moltiplicatore economico assolutamente non banale, sia in termini di abbattimento dei costi di supporto ed help-desk, sia per ciò che riguarda la fidelizzazione del cliente e la promozione del proprio business (se avete tempo e voglia potete andare a rivedere i miei articoli inerenti all'argomento White Paper).
Aron Fulkerson è co-fondatore e CEO di  MindTouch.
In passato ha  lavorato per Microsoft e nell'ambito della ricerca sui sistemi distribuiti.

Leggi questo articolo...

domenica 19 settembre 2010

La Qualità non è un pranzo di gala.

Mentre pensavo al titolo di questo post, mi è venuta in mente una delle più famose frasi di Mao Zedong e con un eccesso di immodesta imprudenza ho pensato che, sostituendo la "Qualità" alla "Rivoluzione", facesse proprio al caso mio

Nell'ultimo post vi ho parlato di due attributi, la Chiarezza e la Sintesi, che contribuiscono a definire la Qualità di un documento tecnico.

Ma il percorso che ci porta a dare sostanza a queste due caratteristiche non è un regalo degli Dei, non nasce dallo sfolgorio scintillante del talento (per lo meno non nel mio caso) o da una qualche formuletta magica, ma è frutto di un lavoro "muscolare", faticoso, in cui il testo deve essere lavorato, asciugato, riletto e riscritto, a volte scompaginato e riorganizzato, corretto e limato attraverso un processo iterativo che assomiglia al lavoro dello scultore, che toglie dal blocco di marmo tutto l'inessenziale per far emergere quello che già esiste "nel marmo", affinando via via il lavoro del martello e dello scalpello.

Sull'argomento della revisione di un testo ho già scritto diversi post, riuniti nella sezione Esercizi di riscrittura.

In particolare vi invito a leggere i post del:

Quello che mi preme sottolineare è che:
  • la ricerca della Qualità è un PROCESSO e come tale può essere studiato e ingegnerizzato;
  • la Qualità non è mai gratis, ma richiede un lavoro;
  • la Qualità è un "TUTTO" che molto spesso non riusciamo ad ottenere completamente ma a volte, con opportune strategie, possiamo ottenere almeno "UNA PARTE DEL TUTTO" e sarà comunque meglio del "NULLA".
Leggi questo articolo...

giovedì 16 settembre 2010

La Qualità della documentazione tecnica: Chiarezza e Sintesi

Iniziamo questo percorso alla ricerca della Qualità della documentazione tecnica, secondo uno schema ispirato al principio del "learning by doing", partendo da osservazioni concrete e cercando di desumere, da queste, dei principi di ordine generale... se possibile!

Quando decidiamo di leggere un romanzo per passione e per diletto, è spesso molto gratificante abbandonarsi nei labirinti concettuali che l'autore ci propone, seguendo il filo di una costruzione intrigante e ricca di enigmi e sorprese.

Quando invece leggiamo un documento tecnico, lo facciamo per motivi professionali.
Cerchiamo in esso informazioni che ci servono per il nostro lavoro, per risolvere problemi concreti (installare un software, montare un armadio, configurare le funzionalità del nostro nuovo televisore al plasma,...), disponendo di tempi generalmente sempre molto compressi.

Quindi cosa c'è di più desiderabile di un documento incentrato sulla CHIAREZZA e sulla SINTESI?

In effetti è proprio quello che vogliamo: trovare tutte le informazioni che ci necessitano espresse chiaramente, senza omissioni e senza inutili giri di parole. C'è qualcuno di voi che ha il coraggio di alzare la mano e contestrmi? Chi di voi vuole leggere un documento OSCURO e PROLISSO? Quindi sto sostenendo un'ovvietà! Siete proprio sicuri?

Ora mi viene in mente che avrei potuto scivere "senza inutili circonlocuzioni".
Secondo me "CIRCONLOCUZIONI" è molto meno di chiaro di "GIRI DI PAROLE".
Però è più sintetico, è una sola parola, mentre "GIRI DI PAROLE" sono 3 parole!

Il problema è proprio questo: generalmente CHIAREZZA e SINTESI sono due proprietà in contrasto.
UN esempio? Eccolo:

FRASE 1
"MyNet Manager è un prodotto finalizzato alla gestione ottimizzata di una LAN (Local Area Network). Attraverso la Web COnsole di Amministrazione di MyNet Manager, è possibile configurare facilmente numerosi parametri per l'analisi e la gestione della vostra rete. MyNet Manager vi mette a disposizione un largo set di opzioni finalizzate ad individuare e tracciare tutte le informazioni che caratterizzano la dinamica funzionale della vostra rete"

E' chiaro? Non ne sono certo. E' sintetico? No!
Che cosa avete capito? Troppi aggettivi? Temo di si.
Riscriviamolo:

FRASE 2
"MyNet Manager è una Administration Web Console che vi permette di monitorare un largo set di caratteristiche della vostra LAN (Local Area Network), configurando facilmente un gran numero di parametri necessari a tale scopo".

Questa versione mi piace, mi sembra abbastanza chiara e più sintetica.
La volete più sintetica?

FRASE 3
"MyNet Manager vi permette di monitorare un largo set di caratteristiche della vostra rete locale".

Mi sembra ancora sufficentemente chiara e super sintetica.
Più di così non è possibile... o si?

FRASE 4
"MyNet Manager controlla la rete locale".
La rete di che? Di chi? In che senso la controlla? Come?
No, qui non ci siamo, abbiamo ottenuto una sintesi esagerata ma la chiarezza è scomparsa.

Se volessimo avere una rappresentazione grafica qualitativa della relazione che lega CHIAREZZA e SINTESI, potremmo disegnare un grafico di questo tipo:


Ad ogni FRASE k corrisponde una coppia di coordinate (SFk,CFk) che corrispondono ai valori di SINTESI e CHIAREZZA della frase in esame.
Come si osserva facilmente, quando la sintesi è elevata (SF4), la chiarezza tende a 0 (CF4). Se la sintesi invece tende a 0 (SF1), la chiarezza tende ad essere più elevata (CF1).
Esiste poi una coppia di valori (SF,CF), indicata in BLU
, che ci consente di massimizzare la chiarezza, accettando un livello di sintesi non troppo elevato. Aumentando il valore della sintesi si arriva ad individuare una zona del grafico caratterizzata da un rettangolo azzurro che forse rappresenta la zona di miglior equilibrio tra i valori combinati di questi attributi.

In effetti, sia la FRASE 2 (SF2,CF2) che la FRASE 3 (SF3,CF3) possono essere considerate accettabili. Il grafico ovviamente è solo un modo di visualizzare l'andamento qualitativo che lega questi due concetti, un ausilio a supporto della mia tesi. La cosa che mi interssa veramente è sottolineare che CHIAREZZA e SINTESI sono ingredienti necessari e contrastanti, che devono essere armonizzati quanto più possibile e che possono rappresentare la prima tessera del puzzle della Qualità che stiamo tentando di ricostruire.
Leggi questo articolo...