Un esempio di comunicazione efficace: il Manifesto del Celiaco

Mia moglie è celiaca. La celiachia è una malattia autoimmune che impedisce l'assunzione del glutine, una sostanza presente in un gran numero di alimenti, principalmente pane, pasta e tutti i derivati del grano e affini. Per illustrare la sua esperienza nel percorso attraverso questa patologia, ha deciso di realizzare un blog, Puntodivistaceliaco. E da questo blog, tra le altre cose, potete scaricare il Manifesto del Celiaco, una brochure che in un singolo foglio riassume e sintetizza una serie di osservazioni essenziali che forniscono un quadro istantaneo della malattia celiaca e dei presidi d'attenzione che devono essere messi in atto quando si prepara un pasto per un celiaco.
Il Manifesto è un piccolo capolavoro di comunicazione. Provate ad esaminare un qualsiasi argomento e provate a condensare in una sola pagina, in sole 15 frasi, tutte le coordinate che consentono di circoscrivere l'argomento. Vi assicuro che non è per nulla facile. Se non sapete nulla sulla celiachia, il Manifesto vi fornisce tutti i dati fondamentali, attraverso messaggi brevi e chiari, nonchè i riferimenti all'AIC (Associazione Italiana Celiachia). Leggi questo articolo...

Un buon esempio di Tutorial

Da alcuni anni siamo ormai abituati a relazionarci via Internet con la Pubblica Amministrazione e con diversi Enti Pubblici. Governo centrale, Regioni, Province, Comuni ed Enti previdenziali oggi dispongono di siti Web che forniscono diversi tipi di informazioni.
Non sempre i contenuti di questi siti sono all'altezza delle aspettative degli utenti e sarebbe abbastanza facile fare l'elenco delle manchevolezze grossolane che spesso ho rilevato. Ma stavolta voglio proporvi un esempio "in positivo".
Si tratta del sito dell'INPS (Istituto Nazionale Previdenza Sociale), che mette a disposizione degli utenti molti utili dati. Per accedere a tali dati, è necessario effettuare una registrazione, a valle della quale vi sarà fornito un PIN (Personal Identification Number).
Una volta ottenuto il PIN, si potrà effettuare il login ed accedere ad un insieme di informazioni che riguardano la nostra storia contributiva e altro ancora.
MA COME SI OTTIENE IL PIN? Con pochi semplici passaggi che sono illustrati da un breve ed efficace Tutorial consultabile on-line, nella sezione GUIDA ALL'ASSEGNAZIONE.
E' un ottimo esempio di come si possa facilitare la vita agli utenti, spiegando in soli 4 passi tutto ciò che necessita per l'ottenimento del PIN.
La veste grafica è molto elementare e si potrebbe fare di meglio, ma è in linea con l'aria di "semplicità" che permette all'utente di concentrarsi sui passaggi essenziali della procedura.
Dateci un occhiata. Leggi questo articolo...

Soluzioni: facciamoci...le note degli altri!

Ora vediamo come vengono usate le note nei manuali di alcuni tra i maggiori vendors del mondo ICT.
Nei suoi manuali la SUN usa una forma molto sobria per proporre la nota:

Questo stile non mi convince, se una nota è "troppo sobria" rischia di non essere... notata!
La Microsoft in alcuni manuali (ad esempio, nei manuali che si usano per preparare una certificazione), usa ben 10 tipolgie di note:


Francamente mi sembra un eccesso di zelo; tuttavia, nell'ottica di un manuale che devo usare per ottenere una certificazione, questo approccio molto differenziato può avere una valenza didattica degna d'attenzione.

HP in molti manuali utilizza una modalità meno dettagliata rispetto a quella utilizzata da Microsoft, ma comunque efficace e strutturata su 4 tipi di note distinte:

Se possiamo ravvisare un difetto, dobbiamo dire che le icone utilizzate per indicare la nota non sono molto caratterizzate dal punto di vista grafico e non colpiscono sufficentemente l'occhio.

Anche nei Redbooks della IBM potete trovare diversi tipi di note.
Di seguito ne riporto soltanto 3 a titolo di esempio:




Lo stile di IBM è anch'esso molto sobrio, tuttavia la nota, grazie allo sfondo grigio, emerge in modo molto distinto rispetto al testo.

Come potete vedere da questi esempi, ogni vendor usa uno stile diverso, ma tutti utilizzano le note "in prossimità" del contesto a cui si riferiscono, rifuggendo quindi dallo stile classico della nota a piè di pagina o dalle note di chiusura, di cui vi ho fatto cenno nel post precedente.
Potrei fare molti altri esempi, ma lo scopo di questo post non è fornire una tassonomia di tutti i modi possibili di proporre una nota.

Quello che mi interessa sottolinare è che quando scrivete un documento tecnico, dovete fare attenzione a questo aspetto: mettete sempre in primo piano gli elementi essenziali di un discorso, la linea di pensiero fondante, il percorso concettuale fondamentale che l'utente deve seguire con attenzione.
Tutti gli elementi complementari e asincroni rispetto alla linea generale, possono essere evidenziati con delle note, posizionate "in prossimità" del flusso generale.

Nei post futuri vi proporrò qualche esempio per chiarificare la questione.
Leggi questo articolo...

Soluzioni: nota la NOTA!

In un documento tecnico è spesso utile far ricorso all'uso delle note, ma è necessario non abusarne inutilmente.

La nota tipicamente serve a puntualizzare o aggiungere elementi di conoscenza sul concetto che viene espresso e illustrato nel corpo principale del testo, in modo da non appesantire il testo medesimo.

Essa spesso fornisce informazioni "asincrone" rispetto al flusso primario, cioè informazioni complementari ma che nel corpo del testo potrebbero comunicare un fastidioso effetto "deviazione" della linea di pensiero principale.

Un esempio può essere utile a chiarire il concetto:

"...il modello è costituito da 5 elementi principali: gli Utenti, le Unità Organizzative, i Ruoli, i Profili e le Risorse. Le relazioni che intercorrono tra questi elementi..."

Il testo proposto descrive un generico modello, i suoi elementi principali e le relazioni tra tali elementi. Se abbiamo bisogno, in questo frammento, di aggiungere una distinzione tipologica tra gli Utenti che popolano il modello, possiamo usare una nota:

"... NOTA - Gli Utenti del modello possono essere suddivisi in 4 tipologie distinte: TIPO 1... TIPO 2... TIPO 3... TIPO 4... "

Ovviamente, potevamo scegliere di inserire il contenuto della nota nel corpo del testo principale, ma avremmo ottenuto per l'appunto l'effetto "deviazione", cioè avremmo costretto il lettore a deviare la sua attenzione dalla linea principale del ragionamento, finalizzata a descrivere gli oggetti critici del modello (entità e relazioni tra di esse), per acquisire delle informazioni certamente importanti ma che possono più utilmente essere proposte in un punto diverso.

Non ci credete ?

"...il modello è costituito da 5 elementi principali: gli Utenti (gli Utenti del modello possono essere suddivisi in 4 tipologie distinte: TIPO 1... TIPO 2... TIPO 3... TIPO 4...), le Unità Organizzative, i Ruoli, i Profili e le Risorse. Le relazioni che intercorrono tra questi elementi..."

Non mi sembra un granchè... molto meglio usare la nota.
Ma come identifichiamo la nota ? E dove la collochiamo ?

Distinguiamo principalmente tra:

• nota a piè di pagina (footer), collocata in fondo ad una pagina;
  

• nota di chiusura, collocata al termine del capitolo o alla fine del documento.

Classicamente, le note vengono richiamate da un numero posizionato in alto a destra della parola che necessita dell'annotazione. Possono essere numerate consecutivamente lungo tutto il testo, oppure si può usare una numerazione localizzata per ogni capitolo, ripartendo dal numero 1 all'inizio di ogni nuovo capitolo.

In alcuni contesti, le note devono essere utilizzate seguendo regole tipiche di quel contesto (ad esempio, nel caso di lavori scientifico-accademici si useranno le regole definite per le pubblicazioni di quel genere).

Io ho un'approccio abbastanza personale sull'argomento.

In primo luogo, detesto le note di chiusura. Le note spostate alla fine del capitolo (figuriamoci alla fine del documento) non servono a nulla e perdono completamente la loro utilità; le odiavo fin dai tempi in cui studiavo all'Università e non le uso mai nei miei documenti.
Immaginate una nota a pagina 13 di un capitolo di 70 pagine... per andarla a leggere devo scorrere in avanti, leggere la nota e ritornare a pag. 13... MA NON S'ERA DETTO CHE L'EFFETTO "DEVIAZIONE" ERA FASTIDIOSO ?

Non uso nemmeno le note numerate, perchè credo nel potere evocativo delle immagini.
Dovendo scrivere principalmente Manuali Tecnici nell'ambito ICT, uso due icone ben distinte, che identificano due tipi di note:

NOTE DI ATTENZIONE: vanno utilizzate per annotazioni critiche, che NON devono essere ignorate dal lettore, onde evitare danni o problemi.





NOTE DI OSSERVAZIONE: vanno utilizzate per annotazioni che rivestono un interesse specifico, ma che se ignorate non implicano particolari danni o problemi.




Le due icone colpisono l'occhio del lettore e prima ancora di leggerne il contenuto egli è già è avvisato della valenza della nota. Tali note sono collocate "in prossimità" del testo a cui si riferiscono, quindi non alla fine del capitolo.

Di seguito è illustrato un esempio:

Al prossimo post per esaminare COME USANO LE NOTE alcuni tra i più importanti vendors del mondo ICT.

Leggi questo articolo...