by E Matricciani — c) Un manoscritto tecnico-scientifico può svolgere tutte e tre le funzioni menzionate, però lo scrittore deve separarle opportunamente, in modo che il lettore
118 KB – 24 Pages
PAGE – 1 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 1 Elementi di qualit• nella comunicazione tecnico-scientifica Prof. Ing. E. Matricciani (Dipartimento di Elettronica e Informazione, Politecnico di Milano) • Introduzione Si riportano sinteticamente gli elementi fondamentali della scrittura e della comunicazione tecnico-scientifica, strumenti che gli scienziati e gli ingegneri usano per comunicare dati, fatti, opinioni, raccomandazioni ai colleghi, ai superiori, ai tecnici e, pi† in generale, al resto del mondo [1]. 1 • Pianificazione di un manoscritto tecnico-scientifico La pianificazione di un manoscritto tecnico-scientifico consiste nei seguenti passi: a) decidere lo scopo, la funzione del manoscritto, b) individuare il tipo di lettore, c) organizzare il manoscritto secondo una struttura standard. (Con il termine “manoscritto” si indicheranno, indifferentemente, le tesi, gli articoli, le relazioni, i rapporti interni, i libri, i manuali ecc. Il termine “manoscritto” d• un’idea generale della scrittura e della fatica personali dell’autore, anche se egli usa un sistema di videoscrittura.) ‡a) In ordine d’importanza le funzioni che un manoscritto tecnico-scientifico svolge sono tre: informare, persuadere, motivare il lettore. ‡Informare. Consiste nell’accrescere le conoscenze tecnico-scientifiche del lettore. L’informazione pu… riguardare eventi, fatti, fenomeni, risultati d’esperimenti, istruzioni tecniche, descrizione di oggetti e sistemi, e altro. Informare il lettore — un’azione imparziale, distaccata, obiettiva. La comunicazione — chiara se — difficile fraintenderla, ed — accessibile se pu… essere letta e compresa con uno sforzo ragionevole. Il contenuto informativo giustifica la redazione del manoscritto. ‡Persuadere. Consiste nel cambiare le opinioni e le certezze del lettore in base al contenuto informativo. ‡Motivare. Consiste nello spingere il lettore, in base al contenuto informativo e persuasivo, a fare qualcosa che altrimenti non farebbe. ‡b) Quando si scrive documentazione tecnico-scientifica ci si deve immaginare i potenziali lettori in relazione ai seguenti aspetti: caratteristiche di base, tecniche di comunicazione preferite, tipo di lettura. ‡Le caratteristiche di base del lettore riguardano soprattutto la sua cultura tecnico-scientifica. Il linguaggio e la presentazione devono essere adeguati all’argomento e alla cultura del lettore. ‡Le tecniche di comunicazione preferite dal lettore riguardano l’organizzazione del manoscritto, l’uso di figure, tabelle, formule, esempi, ecc. ‡Il tipo di lettura riguarda lo scopo per il quale il lettore legge il manoscritto. Egli pu… leggere per: fare qualcosa, imparare qualcosa, giudicare l’utilit• del contenuto. In un manoscritto da leggere-per-fare il materiale serve solo come riferimento, come memoria esterna del lettore. Egli vi cerca le informazioni, lo consulta soltanto quando deve svolgere un certo lavoro, il materiale — strettamente legato a un’attivit•: l’esempio tipico — un manuale. In un manoscritto da leggere-per-imparare il materiale — letto completamente. Il lettore intende ricordarlo e lo studia. In un manoscritto da leggere-per-giudicare il materiale — letto rapidamente, o sono lette solo alcune parti per giudicare se il manoscritto potr• essere utile. ‡c) Un manoscritto tecnico-scientifico pu… svolgere tutte e tre le funzioni menzionate, per… lo scrittore deve separarle opportunamente, in modo che il lettore si renda conto di quando si intende informarlo, persuaderlo e motivarlo. Questa separazione porta direttamente a un’organizzazione standard, alla struttura canonica (Figura 1). Testo composto con: www.hoeplipublishing.it
PAGE – 2 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 2 Fig. 1. † Struttura canonica di un manoscritto tecnico-scientifico. Un manoscritto tecnico-scientifico — assimilabile a un “prodotto” e, come per i prodotti industriali, deve possedere degli elementi che ne assicurino la qualit•. In ordine di importanza gli elementi dai quali — possibile stabilire il grado di qualit• di un manoscritto tecnico-scientifico sono: 1.Contenuto tecnico-scientifico: deve essere sufficiente per giustificare il tempo e gli sforzi necessari per scrivere il manoscritto. 2.Validit• dei risultati: deve risultare da fatti, dati, prove, confronti. 3.Portata dei risultati: oltre ad essere utili, i risultati devono anche rilevanti. 4.Organizzazione: deve seguire uno standard per facilitare la lettura (struttura canonica). 5.Stile letterario: lo stile include l’aspetto letterario (struttura dei paragrafi e delle frasi, uso delle parole e dei termini scientifici) e l’aspetto grafico (formato delle pagine, tipo e corpo dei caratteri alfanumerici, aspetto delle figure e delle tabelle). Uno stile adatto — essenziale per trasformare la prima versione del manoscritto, illeggibile, in un prodotto finito, nella versione definitiva. Ad una persona esperta la versione finale pu… richiedere, in media, tre ore di redazione per pagina. Come rivolgersi al lettore? Molto usate sono la forma impersonale “‡si — dimostrato‡” e la forma passiva “‡— stato dimostrato‡”. La forma impersonale ha il difetto di sfumare le responsabilit• perch– non chiarisce il soggetto dell’azione, chi ha fatto che cosa. Essa per… — necessaria nelle frasi in cui non c’— un soggetto preciso, o quando non — noto. Spesso si trova quando si descrivono metodi, procedure, algoritmi, perch– li si ritiene pi† importanti delle persone che devono applicarli, ad esempio nei manuali. Usatissimo e pi† accettabile — il plurale maiestatico, “noi”, anche se l’autore — uno solo. Raro — l’uso della prima persona singolare, anche se auspicabile. La forma passiva — da evitare perch– usa pi† parole della forma attiva per affermare lo stesso concetto. Quest’ultima — da preferirsi perch–, oltre a ridurre il numero di parole, rende pi† vivo il testo. Testo composto con: www.hoeplipublishing.it
PAGE – 3 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 3 Per citare la letteratura tecnico-scientifica si usa il tempo presente del modo indicativo perch– esso evidenzia l’esistenza “in vita” del contenuto di quel particolare lavoro, gi• accettato dalla comunit• tecnico-scientifica. Il presente indicativo indica il fatto, l’azione, il modo d’essere, che — certo nel momento stesso in cui si scrive o si parla. In quanto “non passato” e “non futuro”, il presente indicativo — in grado di significare ci… che si avvera sempre, le verit• atemporali tipiche della scienza. Quando ci si riferisce al proprio lavoro, al contenuto originale di un rapporto, di una relazione, di un articolo, si deve usare il tempo passato prossimo perch– il contributo non — ancora diventato una conoscenza dimostrata e certa. Il passato prossimo esprime un fatto compiuto nel passato, ma che ha una qualche relazione col presente. In quanto legato al presente, il passato prossimo — in grado di descrivere le azioni che hanno portato l’autore a scrivere il manoscritto. La principale eccezione a questa regola — nei casi d’attribuzione e nella presentazione di risultati e nei manuali, per i quali si usa il presente. Per vivacizzare la narrazione dei fatti, si pu… usare il presente storico, una forma verbale utile per far rivivere il passato nel presente. 2 • Indice del manoscritto La comunicazione tecnico-scientifica contiene informazioni sul materiale e informazioni sulla sua organizzazione. Questi due tipi di informazione sono legati dall’indice del contenuto (Figura 2). Fig. 2. † Relazione tra le informazioni sul materiale e sulla sua organizzazione. L’indice — un potente strumento di lavoro che porta ordine dove vi — disordine. Aiuta lo scrittore a realizzare due obiettivi interagenti: disporre il materiale in un ordine logico, organizzare il proprio pensiero. Per questa ragione esso deve essere scritto prima del resto del manoscritto, anche se potr• e dovr• cambiare pi† volte prima della stesura finale. L’indice — una mappa del manoscritto, una guida per l’autore e il lettore. Una suddivisione logica e gerarchica in sezioni e sotto-sezioni, ossia un indice ben strutturato, rende il materiale pi† facile da scrivere o da leggere. Per costruire un indice efficace si deve ricordare che gran parte del manoscritto sar• letto normalmente in sequenza, dall’inizio fino alla fine. Dopo il primo titolo ci si pu… muovere verso il basso, o verso destra (Figura 3), anche se il testo scorre sempre in una sola direzione. Testo composto con: www.hoeplipublishing.it
PAGE – 4 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 4 Fig. 3. † Spostamenti e livelli gerarchici presenti in un indice strutturato. Se ci si sposta verso destra si divide il materiale del livello in pi† parti, almeno due altrimenti la partizione non ha senso. Ogni livello deve avere uno scopo ben preciso e titoli disposti in una sequenza logica. Ci si sposta verso il basso per una di queste ragioni: ‡Logica del problema: problema-soluzione, causa-effetto, necessit•-azione; — l’organizzazione tipica di un articolo, di una relazione, di uno studio di fattibilit•. ‡Cronologia: sequenza temporale degli eventi discussi. ‡Interesse: il grado di interesse del lettore (secondo lo scrittore). ‡Priorit•: l’ordine di importanza o urgenza di fatti o azioni (secondo lo scrittore). ‡Difficolt•: da facile a difficile, o viceversa. ‡Complessit•: da semplice a complesso, o viceversa. Ogni volta che ci si muove verso destra si producono due effetti: — pi† facile scrivere il manoscritto partendo dall’indice, il testo di ogni sotto-livello — pi† breve. Se si pianifica la lunghezza dell’ultimo livello si pu… anche stabilire la lunghezza totale del manoscritto. Vari sono i sistemi di numerazione dei livelli. Il pi† usato — il sistema numerico-arabo (v. Schema 1), richiesto dalla norma 5966 dell’ISO (International Standardizing Organization). Schema 1. † Sistema numerico-arabo. 1. Titolo primo livello 1.1 Titolo secondo livello 1.2 Titolo secondo livello 1.2.1 Titolo terzo livello 1.2.2 Titolo terzo livello 1.3 Titolo secondo livello 2. Titolo primo livello 2.1 Titolo secondo livello 2.2 Titolo secondo livello 2.3 Titolo secondo livello 2.3.1 Titolo terzo livello Testo composto con: www.hoeplipublishing.it
PAGE – 5 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 5 2.3.2 Titolo terzo livello 2.3.3 Titolo terzo livello .. A. Prima appendice B. Seconda appendice C. Terza appendice Se il primo livello rappresenta i capitoli, si pu… scrivere esplicitamente: Capitolo 1. Titolo primo livello 1.1 Titolo secondo livello 1.2 Titolo secondo livello 1.2.1 Titolo terzo livello 1.2.2 Titolo terzo livello La suddivisione del contenuto di un livello, oltre che dallo stile dello scrittore, dipende anche dall’enfasi che gli argomenti ricevono: un testo posto in un sotto-livello, e quindi evidenziato da un sotto-titolo, appare pi† importante dello stesso testo nascosto in una serie di paragrafi del livello superiore. (Il termine paragrafo ha il significato che normalmente gli compete in campo tipografico, vale a dire di generica porzione di testo compreso tra due successivi ritorni a capo (sinonimi capoverso, comma) [2, 3]). Con un sistema di videoscrittura, la numerazione dei livelli e dei sotto-livelli — automatica, e semplici istruzioni indicano i livelli delle sezioni, e lo stile da usare nei titoli e nell’indice. Anche se un manoscritto — ben strutturato, e ha un indice molto particolareggiato, distribuito su pi† pagine, e quindi presenta il materiale nel modo migliore, il lettore ha qualche difficolt• a capire e a memorizzare, con un colpo d’occhio, l’organizzazione e il contenuto perch– pu… mancargli un inquadramento ad un livello superiore. La difficolt• nasce da come la mente elabora le informazioni. La mente: 1.1.Legge le informazioni. 2.2.Decide che deve ricordarle. 3.Le mette, temporaneamente, nella memoria a breve termine. 4.Le mette, definitivamente, nella memoria a lungo termine. Per memorizzare le informazioni nella memoria a lungo termine il lettore deve prima comprenderle. Nel processo di apprendimento la mente collega le nuove informazioni con le informazioni gi• in suo possesso e memorizza le nuove in rapporto alle vecchie. Mentre il lettore “guarda” come le informazioni presenti nella memoria a lungo termine si collegano con le nuove, queste ultime sono memorizzate nella memoria a breve termine. Le nuove informazioni, infatti, non possono essere memorizzate nella memoria a lungo termine, se prima non passano per la memoria a breve termine. Una volta passate nella memoria a lungo termine, la memoria a breve termine viene “cancellata” perch– pu… contenere da cinque a nove informazioni. Questa — la legge del sette pi† o meno due di Miller [4]: una persona “media” pu… ricordare contemporaneamente solo sette elementi, alcuni ne possono ricordare fino a nove, altri solo cinque o anche meno. Quando l’indice diventa lungo, occupa pi† di una pagina, si possono sicuramente individuare delle aggregazioni superiori, ossia si pu… organizzare l’indice in parti comprendenti raggruppamenti logici di capitoli (Parte I, Parte II, ecc.), elencando soltanto i loro titoli, cio— un indice generale, e poi riportare l’indice completo, pi† particolareggiato, per capitoli. Il lettore ora pu… memorizzare pi† facilmente la suddivisione completa del materiale (primo indice) e la suddivisione all’interno dei capitoli e delle sezioni (secondo indice). La legge del sette pi† o meno due si applica ogni volta che si pretende che le informazioni siano ricordate. Testo composto con: www.hoeplipublishing.it
PAGE – 6 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 6 3 • Pianificazione di un manuale Un manuale (in lingua inglese manual) — un particolare manoscritto tecnico-scientifico che accompagna molti prodotti industriali con lo scopo di insegnare al lettore come far funzionare il prodotto, non a spiegargli come funziona. Una suddivisione schematica individua tre tipi fondamentali: manuale d’uso, manuale d’installazione, manuale di servizio. ‡Un manuale d’uso ha lo scopo di insegnare come usare il prodotto correttamente, al meglio delle sue possibilit• e senza pericoli. Per sua natura, questo tipo di manuale si rivolge sia a lettori con una cultura tecnico-scientifica elevata sia al pubblico pi† vasto. ‡Un manuale d’installazione si rivolge a tecnici, ossia a coloro che devono installare il prodotto. ‡Un manuale di servizio si rivolge a coloro che devono riparare o eseguire la manutenzione del prodotto industriale. Ai manuali industriali menzionati si devono aggiungere i manuali di studio o di riferimento (in lingua inglese handbook) dei quali un illustre esempio — proprio il Manuale dell’Ingegnere. Gli elementi di qualit• di un manuale sono: disponibilit•, idoneit•, accessibilit•, leggibilit•, manutenibilit•, modificabilit•. ‡Disponibilit•. Un prodotto industriale, di qualunque complessit•, dimensioni, costo, ecc. deve essere accompagnato da un manuale, spesso per disposizioni di legge. Non si devono tramandare oralmente le informazioni su come far funzionare qualcosa. In materia di istruzioni per l’uso e la manutenzione e, pi† in generale, di documentazione tecnica riguardante le macchine, la principale norma di riferimento — il DPR 24/07/1996 n. 459, attuativo della cosiddetta Direttiva Macchine (Direttiva CEE 329/89, e successive versioni). ‡Idoneit•. Un manuale non deve essere enciclopedico, non deve impressionare e intimidire il lettore, deve essere appropriato, ritagliato sui suoi bisogni. Il lettore non desidera sapere come funziona il prodotto, ma solo come farlo funzionare. ‡Accessibilit•. Un manuale pu… contenere ci… che serve all’utente (— idoneo), ma — male organizzato: ci sono troppi salti, deviazioni, ramificazioni, cicli finch– il lettore si perde. La “legge” fondamentale di una buona documentazione afferma che pi† il lettore deve saltare materiale o cambiare la direzione di lettura (avanti-indietro o viceversa), pi† ‡ difficile usare un manuale. L’idoneit• e l’accessibilit• si realizzano quando il manuale — organizzato per rispondere a domande del tipo: “Come si fa a‡?”, ossia quando — orientato a fornire risposte per svolgere una sola azione, un solo compito. ‡Leggibilit•. Il manuale deve essere facile da leggere, accurato, sobrio, senza errori. ‡Manutenibilit•. Un manuale deve essere facilmente aggiornabile in condizioni poco variabili (piccoli cambiamenti nel prodotto industriale). ‡Modificabilit•. Un manuale deve essere facilmente ed economicamente modificabile in condizioni molto variabili (forti cambiamenti nel prodotto industriale). Il manuale deve essere pianificato da tre punti di vista, da tre figure professionali: l’esperto della tecnologia, l’esperto della sua applicazione, l’esperto della documentazione tecnica. ‡L’esperto della tecnologia — colui che conosce il progetto, il sistema, la macchina, sa com’— fatta e come funziona. ƒ in grado di dire ci… che il prodotto pu… fare e ci… che non pu…, o non deve fare. ‡L’esperto dell’applicazione della tecnologia — colui che deve usare la tecnologia, rappresenta l’utente del prodotto, non sa com’— fatto, ma sa come farlo funzionare. ‡L’esperto della documentazione tecnica — il redattore del manuale. Testo composto con: www.hoeplipublishing.it
PAGE – 8 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 8 4.4 • Introduzione L’introduzione ha lo scopo di creare un contesto, un terreno comune per la comunicazione tra lo scrittore e il lettore. Ogni rapporto, recita la norma ISO 5966, deve iniziare con una introduzione nella quale sono sinteticamente illustrati l’oggetto e gli scopi del lavoro descritto. Gli argomenti da trattare in un’introduzione sono: 1.1.Lo scopo del manoscritto. 2.2.La definizione del problema tecnico-scientifico. 3.3.Una sintesi critica (sinossi) e i contributi principali di altri sullo stesso argomento. 4.4.Il fondamento logico del lavoro. 5.5.La validit•, la portata e la limitazione dei nuovi risultati. 6.6.Una breve indicazione sul contenuto delle sezioni (o dei capitoli). 4.5 • Corpo Mentre il riassunto e l’introduzione orientano il lettore, il corpo orienta e ordina il materiale principale del manoscritto. Durante la stesura di questa parte l’indice pu… essere modificato anche ampiamente. Non — possibile fornire indicazioni particolareggiate su come dividere il corpo perch– questo dipende dal tipo di lavoro. Le informazioni fornite nel corpo non devono essere troppo dettagliate, perch– bisogna concentrare l’attenzione sulla novit• del lavoro, sulla discussione e analisi critica dei risultati ottenuti, sulle motivazioni che sostengono le conclusioni e le raccomandazioni finali [5]. Nello stesso tempo bisogna introdurre tutti quegli elementi grafici, numerici, tabellari che sono fondamentali per comprendere l’argomento, rinviando alle appendici i dettagli, gli sviluppi matematici e quant’altro non strettamente necessario per comprendere il materiale presentato nel corpo. 4.6 • Conclusioni Ci sono diversi modi per “concludere” e la scelta dipende dal tipo di manoscritto. La sezione conclusiva pu… comprendere: un sommario dei punti principali, le conclusioni, le raccomandazioni. ‡Il sommario ha lo scopo di riepilogare i risultati principali. Deve essere vigoroso, convincente, selettivo. ‡Quando si riportano i risultati di un esperimento, le conclusioni dell’analisi di un problema, o gli sviluppi di un progetto, il modo appropriato di terminare il manoscritto — con le conclusioni. Queste non solo riassumono i risultati ma, diversamente dal sommario, li interpretano, li criticano e ne indicano le limitazioni. Molte conclusioni discutono pure nuove direzioni per uno sviluppo futuro del lavoro, e possibili applicazioni. ‡Dall’interpretazione dei fatti l’autore tira “conclusioni”, e da queste egli pu… formulare alcune raccomandazioni, ossia decidere e proporre delle azioni. Il carattere delle raccomandazioni dipende molto dallo scopo del manoscritto. Alcune situazioni tipiche possono essere le seguenti: ‡‡Si analizza un problema, si trova una soluzione, si propone un’azione. ‡‡Si seleziona una nuova procedura, una nuova tecnica, ecc., si indica perch– — preferibile ad altre. ‡‡Si identifica un bisogno, si suggerisce un modo per soddisfarlo. ‡‡Si propone un nuovo progetto, si mostra perch– e come deve essere applicato ai problemi attuali. La Tabella 1 mostra sinteticamente le conclusioni da scrivere per ogni tipo di manoscritto tecnico-scientifico. Testo composto con: www.hoeplipublishing.it
PAGE – 9 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 9 Tabella 1. Come concludere in diversi tipi di manoscritto. Argomento del manoscritto Sommario Conclusioni Raccomandazioni Progetto originale dispositivo, sistema X Risultati di un esperimento X Sviluppo di un processo, di un metodo X Descrizione caratteristiche dispositivo o sistema X Studio di un problema tecnico X Storia degli sviluppi di una disciplina X Monografia su un argomento X Analisi di sistemi o dispositivi difettosi X Proposta di un progetto X Stato di avanzamento di un progetto X 4.7 • Bibliografia Ogni manoscritto tecnico-scientifico poggia su molti risultati e lavori precedenti. Si vede chiaramente dalla lunga lista dei riferimenti bibliografici (bibliografia). Il richiamo (citazione) di lavori precedenti serve a sostenere le affermazioni assunte come vere ma non dimostrate, e a mostrare la collocazione del manoscritto nella vastit• della letteratura tecnico-scientifica. I sistemi di citazione pi† usati sono: (a) sistema autore-anno, (b) sistema alfabetico-numerico, (c) sistema numerico. I sistemi (a) e (c) sono previsti dalla norma ISO 5966. ‡Nel sistema autore-anno i riferimenti bibliografici sono elencati in ordine alfabetico nella bibliografia (posta in fondo al manoscritto, prima delle appendici) e nel testo corrente sono citati nel modo seguente: “Come hanno dimostrato (Rossi e Bianchi, 1990)..”, oppure “Come hanno dimostrato Rossi e Bianchi (1990)” Se ci si riferisce anche a un articolo successivo degli stessi autori pubblicato nel medesimo anno si riscrive la frase: “Come hanno dimostrato (Rossi e Bianchi, 1990a)”, e l’articolo successivo — citato con “(Rossi e Bianchi, 1990b)”. ‡Nel sistema alfabetico-numerico i riferimenti bibliografici sono elencati in ordine alfabetico e sono numerati secondo l’ordine d’apparizione nella lista. Nel testo corrente un riferimento bibliografico — citato nel modo seguente: ” e quindi il “bit” ‡ l’unit• di misura della quantit• di informazione [15]”, dove [15] indica la posizione dell’articolo nella lista. Il sistema — comodo quando ci sono molte citazioni, distribuite in un testo molto lungo, un libro o un manuale. ‡Nel sistema numerico i riferimenti bibliografici sono elencati nello stesso ordine in cui appaiono nel manoscritto e individuati con un numero arabo progressivo, come nel sistema alfabetico-numerico. ƒ il sistema pi† usato nei manoscritti brevi (gli articoli) perch– fa risparmiare spazio, non rompe eccessivamente il fluire del testo e permette di individuare rapidamente gli articoli citati nella bibliografia. Qualunque sia il sistema di citazione adottato, nella lista dei riferimenti bibliografici gli articoli e i libri sono trattati in modo diverso. I dati di un articolo possono essere riportati nel modo seguente (sistema numerico): [3] Oliver B.M, J.R. Pierce, C.E. Shannon, The Philosophy of PCM, Proceedings of the I.R.E., 36, November 1948, 1324-1331. Vi compare prima il cognome dell’autore o degli autori (ma alcuni preferiscono iniziare con i nomi), “[3] — il numero progressivo della citazione (sistema numerico), il titolo — in tondo, il nome della rivista — in corsivo, “36” — il numero del volume della rivista, “November 1948” — la data di pubblicazione, e “1324-1331” sono le pagine del volume. Spesso il mese, o una qualsiasi altra cadenza di pubblicazione (quadrimestrale, trimestrale, bimestrale), non sono indicati. Nel sistema autore-anno mancherebbe solo il termine “[3]”, e la citazione sarebbe nella posizione che le compete in ordine alfabetico. Testo composto con: www.hoeplipublishing.it
PAGE – 10 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 10 I dati di un libro possono essere riportati nel modo seguente: [2] Ramo S., J.R. Whinnery, T. Van Duzer, Fields and Waves in Communication Electronics, John Wiley, New York, 1984, 2a ed. Il titolo del libro — in corsivo, si indica la casa editrice, il luogo di pubblicazione (per i libri stranieri spesso — una delle sedi della casa editrice) e l’edizione, se diversa dalla prima. Rispetto a questi esempi, si possono trovare piccole variazioni di poco conto concernenti, soprattutto, la posizione dei dati indicanti l’anno, le pagine e il volume e il nome per esteso. ƒ importante per… che compaiano tutti gli elementi indicati: dati sbagliati fanno perdere molto tempo al lettore che li cerca per leggere i lavori citati, e fanno sospettare una citazione di seconda mano. 4.8 • Appendici e note Le appendici hanno lo scopo di riportare informazioni utili per comprendere il testo, ma marginali rispetto ad altre. Ogni appendice — individuata da un titolo, e da un contrassegno progressivo, generalmente una lettera maiuscola. Nelle appendici, ad esempio, si mostrano: ‡‡Lunghi sviluppi matematici. ‡‡Tabelle di dati di riferimento, di dati sperimentali (campagne di misura) con le indicazioni sulla strumentazione usata, le tarature eseguite, le condizioni di misura, la sequenza delle misure, i campioni misurati, ecc. ‡‡Richiami sintetici di teorie o esperimenti, quando il materiale riportato nell’introduzione o in qualche capitolo del corpo non basta. ‡‡Liste di istruzioni di programmi di calcolo, con allegato, magari, un floppy disc, o un CD-ROM. ‡‡Appendici grafiche, costituite da una collezione di disegni, dei quali nel testo corrente si mostrano solo pochi esempi illustrativi. Le note hanno lo scopo di riportare informazioni marginali. Le informazioni possono essere di due tipi: chiarimenti o commenti al testo corrente, note di contenuto, e riferimenti bibliografici, note di riferimento (entrambe a pi— di pagina). Le note di riferimento si usano raramente perch– le citazioni bibliografiche sono sempre elencate in un’unica lista in fondo al manoscritto, prima delle appendici (Figura 1). 4.9 • Indice analitico L’indice analitico — un elenco alfabetico di parole e brevi frasi, ciascuna delle quali riguarda un particolare soggetto presente nel manoscritto ed — accompagnata dal riferimento al punto in cui il soggetto — trattato. Un buon indice analitico registra ogni affermazione pertinente presente nel testo e ne permette una rapida consultazione. La materia e lo scopo del manoscritto determinano quali affermazioni sono pertinenti e quali no. A volte sono necessari pi† indici analitici, ad esempio un indice dei nomi e un indice della materia. L’indice analitico pi† comune comprende entrambi. L’estensore di un indice analitico deve aver presente l’intero manoscritto e il suo scopo, capire l’importanza relativa dei vari capitoli e sezioni, il loro legame con il resto del manoscritto, e deve visualizzarsi i potenziali lettori e anticiparne le necessit•. La persona che pi† si avvicina a questo ideale — l’autore medesimo Nella stesura dell’indice analitico si escludono la pagina del titolo, la dedica, la prefazione, la lista delle figure e delle tabelle, i ringraziamenti, il glossario, la lista dei simboli e la bibliografia. Testo composto con: www.hoeplipublishing.it
PAGE – 11 ============
Elementi di qualit• nella comunicazione tecnico-scientifica 11 Schema 2: Esempi di voci e sotto-voci di un indice analitico. Dipolo elementare elettrico, 247 magnetico, 252 .. Maxwell Equazioni di, 130 Equazioni di, nel dominio della frequenza, 190 Equazioni di, nel dominio del numero d’onda, 200 tensore degli sforzi di, 152 Le sotto-voci possono essere a loro volta suddivise in altre sotto-voci, come nell’esempio seguente: Rumore granulare, 318, 393, 476, 617 .. teorema di Campbell, 395, 627 uniforme, 393 autocorrelazione, 395 spettro di potenza, 394 valore medio, 394 Se si hanno dubbi sulla parola, o frase, che il lettore cercher• nell’indice — meglio elencare la stessa voce con titoli diversi e rinviare il lettore alla voce pi† particolareggiata, come nell’esempio seguente: Equazioni differenziali, 23-25 .. di Maxwell, vedi Maxwell Le appendici e le illustrazioni sono incluse solo se contengono materiale molto utile. Il materiale riguardante i titoli dei capitoli, delle sezioni, ecc. — escluso perch– — gi• ben evidenziato nell’indice del contenuto. La principale suddivisione di un indice analitico — la voce, individuata da un titolo e dalla posizione nel testo: pu… essere il numero di un capitolo, di una sezione, oppure il numero della pagina, o della sequenza di pagine. Non — necessario inserire nell’indice tutte le posizioni di una certa voce, ma solo quelle che si ritengono pi† utili. Una voce che assume aspetti diversi — suddivisa in sotto-voci, ciascuna con il suo sotto-titolo, il quale evidenzia la diversit•, e la posizione nel testo. Il titolo principale di una voce pu… essere un sostantivo, una breve frase, il nome di una persona, di una localit•, di un oggetto, di un’astrazione, ecc., come negli esempi riportati nello Schema 2, che comprendono anche sotto-voci. I sistemi di videoscrittura possono costruire l’indice analitico automaticamente. Questi sistemi producono l’indice analitico gi• pronto per la stampa, con le voci in ordine alfabetico, con i sotto-titoli, i rimandi, ecc. L’indice analitico — preparato in base alla versione definitiva del manoscritto. Testo composto con: www.hoeplipublishing.it
118 KB – 24 Pages