Nel post precedente abbiamo individuato 4 criteri di base per costruire un Glossario:
- Focalizzare l'audience del documento
- Scegliere i termini da inserire
- Progettare un design essenziale
- Gestirne l'evoluzione nel tempo
Oggi ci concentriamo sul secondo punto.
SCEGLIERE I TERMINI DA INSERIRE
Immaginiamo di aver individuato un primo ed ampio insieme di termini che secondo noi andrebbero inseriti nel Glossario. Siamo certi di doverli includere tutti?
Forse è meglio fare qualche esempio.
Se sto scrivendo un manuale per installare un pannello fotovoltaico e faccio riferimento ad una normativa tecnica internazionale, forse è il caso di classificarla nel Glossario. Ma se consideriamo un concetto che viene ben sviluppato all'interno del documento, si può certamente evitare di includerlo, perché è integralmente definito e sviluppato al suo interno, quindi non è un concetto "esterno" che deve essere "spiegato" nel Glossario per renderlo intellegibile.
Questa regola, appena illustrata, tende a distinguere tra un set di concetti "esterni" ed un set di concetti "sviluppati internamente" al documento.
I principali concetti "esterni" sono ottimi candidati ad entrare nel Glossario.
In alcuni rari casi, anche i concetti "sviluppati internamente", se veramente fondamentali, possono entrare nel Glossario per fornire al lettore una specie di guida veloce ai concetti chiave che poi troverà nel corpo del manuale.
Altro aspetto riguarda invece i concetti che possono essere collegati a definizioni non univoche.
Se sto scrivendo il Manuale Utente di un software crittografico, quando descrivo l'operazione di Cifratura, mi trovo a dover fare una scelta. Ovviamente non ha senso descrivere nel Glossario i dettagli dell'operazione, perchè tali dettagli sono ampiamente indicati nel manuale. Quindi fornire una definizione "operativa" non mi interessa.
Ma forse dare una definizione "generale", di alto livello, del concetto di Cifratura di un file può essere assolutamente consigliabile, specie se il lettore ipotetico del nostro manuale non è necessariamente un esperto di crittografia.
In questo esempio, abbiamo un caso molto frequente: dato un concetto, ad esso potrebbe essere associata più di una definizione, in base al contesto e/o al lettore-target.
Riassumendo, teniamo sempre presenti 2 criteri:
- Distinguere tra concetti "esterni" e "sviluppati internamente" al documento: i primi spesso andranno inseriti nel Glossario, i secondi solo in rari casi.
- Dato un concetto, potrebbe essere associato a più di una definizione: nel dubbio, inserite nel Glossario la definizione "più utile" al lettore per aiutarlo nella comprensione del documento.
Nessun commento:
Posta un commento