domenica 19 febbraio 2012

Saper scrivere... il Glossario: terza parte

Eccoci al terzo post, dopo i due precedenti:
Oggi ci occupiamo del design del Glossario.

Ecco un primo esempio, tratto dal manuale del mio BlackBerry Curve:

 
 Ed ecco il secondo esempio, relativo ad uno standard della RSA, il PKCS11:


Come vedete, emergono 2 sole regole basilari:
  • i termini vengono elencati in ordine alfabetico
  • la struttura è solo una lista di coppie TERMINE - DEFINIZIONE
Un'altra opzione riguarda la possibilità di inserire, nella descrizione di un termine, un link ad un altro termine del Glossario. Questa soluzione può essere utile se il Glossario è particolarmente ricco e con numerosi elementi, ma perde efficacia se il manuale viene consultato in formato cartaceo e non in formato digitale.

Se non volete inserire un link ma volete comunque riferirvi ad altri termini presenti, potete scegliere altre opzioni: vedi - vedi anche - confronta.

TERMINE X: DESCRIZIONE X. Vedi TERMINE Y.
In questa situazione, all'interno della DESCRIZIONE X viene citato il TERMINE Y; in coda, si può utilizzare Vedi TERMINE Y per guidare il lettore al significato di Y che serve a definire X.

TERMINE X: DESCRIZIONE X. Vedi anche TERMINE Y.
Questa situazione significa che la DESCRIZIONE X è chiusa ma può essere eventualmente arricchita da ulteriori informazioni proposte altrove.

TERMINE X: DESCRIZIONE X. Confronta TERMINE Y.
Questa situazione significa che la DESCRIZIONE X può non essere esaustiva o va valutata in base al contesto e viene arricchita da informazioni complementari contenute in Y.

A questo punto siete in grado di scrivere il vostro Glossario ed avete tutte le informazioni necessarie per farlo.

Ma un Glossario è un oggetto "vivo" che può evolvere nel tempo per diversi motivi. Al prossimo ed ultimo post per chiudere l'argomeno.

Condividi


Articoli correlati per categorie



Nessun commento:

Posta un commento

Posta un commento