sabato 3 ottobre 2009

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.

Condividi


Articoli correlati per categorie



Nessun commento:

Posta un commento