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).
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.
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.
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
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.
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.
4 – La struttura canonica
Si passano in rassegna le parti della struttura canonica con riferimento alla Figura 1.
4.1 – Titoli
I titoli delle sezioni di un manoscritto tecnico-scientifico sono di due tipi: titoli categorici, titoli tematici. I titoli categorici comunicano il tipo d'informazione che si trova nella sezione, non gli argomenti particolari di cui si parla.
Titoli categorici sono prefazione, riassunto, sommario, generalità, introduzione, teoria, risultati, applicazioni, discussione, conclusioni, ecc. I titoli tematici, invece, comunicano maggiori particolari sul contenuto del testo, contengono parole chiave, tecniche.
I titoli categorici sono adatti solo per il primo livello, o al massimo per i primi due, ma in ogni caso nessun indice è completo se non ci sono alcuni titoli tematici. Il titolo del manoscritto è sempre tematico.
4.2 – Prefazione
La prefazione, a volte chiamata presentazione, premessa, ecc., è destinata essenzialmente ad indicare gli scopi del manoscritto e le ragioni che hanno indotto a scriverlo. La prefazione più comune è scritta dallo stesso autore. Egli vi esprime il bisogno, l'impulso, lo scopo, l'intenzione che lo hanno spinto ad agire e a scrivere. Parla in prima persona singolare. Si presenta direttamente al lettore.
La prefazione non riporta informazioni propedeutiche al contenuto del testo, perché ciò che il lettore deve sapere sull'argomento, per poter comprendere ed apprezzare il lavoro dell'autore, deve apparire nell'introduzione. Solo nella forma più semplice, e in assenza di una prefazione, il materiale può trovarsi nell'introduzione. Sovente una prefazione termina con i ringraziamenti. In molti libri, l'autore presenta un "indice" ragionato del contenuto del libro, capitolo per capitolo, e offre anche consigli ai lettori.
4.3 – Riassunto
Il riassunto ha lo scopo di mostrare sinteticamente i risultati fondamentali e il loro significato. Contiene l'idea centrale del manoscritto e deve normalmente essere sviluppato con meno di 250 parole, in ogni caso mai con più di 500 parole (norma ISO 5966). Si devono eliminare le informazioni secondarie e di sostegno, i particolari importanti ma non fondamentali, come figure, tabelle, riferimenti bibliografici, appendici, e note. Si deve esporre solo il cuore del contenuto, i risultati e l'idea centrale che hanno giustificato sia il lavoro sia il manoscritto.
Ci sono due tipi fondamentali: il riassunto descrittivo, il riassunto informativo. Il riassunto descrittivo riassume il contenuto in termini generali e qualitativi. Il riassunto informativo riassume il contenuto in termini quantitativi, e può anche discutere o interpretare brevemente i risultati. Il riassunto informativo-descrittivo, combinazione dei due tipi, è usato spesso in articoli, relazioni e rapporti che riportano risultati originali.
Un riassunto informativo o informativo-descrittivo deve contenere i seguenti elementi:
1.
1. Una esposizione del problema tecnico-scientifico sintetizzato con una frase cristallina.
2.
2. Una spiegazione dell'approccio usato per risolvere il problema.
3.
3. I risultati principali che hanno giustificato il manoscritto.
4.
4. Le limitazioni dei risultati.
5.
5. Le conclusioni e le raccomandazioni (se vi sono).
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.
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.
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.
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.
5 – Simboli matematici e acronimi
Le formule matematiche, e i relativi simboli, sono una forma di comunicazione tecnico-scientifica essenziale. Il sistema di numerazione preferito per le formule matematiche poste in una riga propria (non inserite in una riga di testo) è una doppia numerazione, in cifre arabe, in cui il primo numero indica il capitolo, il secondo il numero progressivo all'interno del capitolo. Un simbolo deve essere definito dove è introdotto per la prima volta, dove è reintrodotto dopo molte pagine o dove è ridefinito per rappresentare una nuova quantità.
Nei testi tecnico-scientifici è essenziale un impiego rigoroso delle unità di misura e dei corrispondenti simboli. Il sistema d'unità di misura da usare è quello stabilito dal Comitato Internazionale dei Pesi e delle Misure, noto con il nome di Sistema Internazionale di unità (SI). La Tabella 2 riporta le unità di misura e i loro simboli, la Tabella 3 riporta i prefissi dei multipli e sottomultipli delle unità di misura [2].
Tabella 2. Simboli delle unità di misura SI.
Unità Simbolo Grandezza misurata
ampere A corrente elettrica
becquerel Bq attività di una sorgente radioattiva
candela cd intensità luminosa
coulomb C carica elettrica, quantità di elettricità
farad F capacità elettrica
grado Celsius (centigrado) °C temperatura
grammo g massa
gray Gy dose assorbita
henry H induttanza elettrica
hertz Hz frequenza
joule J lavoro, energia, quantità di calore
kelvin K temperatura termodinamica
kilogrammo kg massa
lumen lm flusso luminoso
lux lx illuminamento (o illuminazione)
metro m lunghezza
mho: v. siemens
mole mol quantità di sostanza
newton N forza, peso
ohm Q resistenza elettrica
pascal Pa pressione
radiante rad angolo piano
secondo s tempo
siemens, o anche mho S conduttanza elettrica
sievert Sv equivalente di dose
steradiante sr angolo solido
tesla T induzione magnetica
volt V potenziale elettrico, differenza di potenziale (tensione elettrica), forza elettromotrice
Watt W potenza
Weber Wb flusso di induzione magnetica
Tabella 3. Prefissi dei multipli e sottomultipli di unità di misura.
Fattore di moltiplicazione Nome del prefisso
(davanti al nome dell'unità)
Simbolo del prefisso
(davanti al simbolo dell'unità)
1024 yotta Y
1021 zetta Z
1018 exa E
1015 peta P
1012 tera T
109 giga G
106 mega M
103 kilo k
102 hecto (o etto) h
10 deca da
10–1 deci d
10–2 centi c
10–3 milli m
10–6 micro µ
10–9 nano n
10–12 pico p
10–15 femto f
10–18 atto a
10–21 zepto z
10–24 yocto y
Gli acronimi, chiamati comunemente anche sigle, sono designazioni abbreviate di termini costituiti da più parole. Si ricavano conservando le sole lettere iniziali, o anche parti iniziali più estese, delle parole che compongono il termine, senza spaziature interne e senza punti di abbreviazione, e con lettere maiuscole. Non si considerano necessariamente tutte le parole del termine, ma ci si può limitare a quelle ritenute più significative, tralasciando articoli, preposizioni e congiunzioni. Ogni acronimo deve essere esplicitamente definito nel testo alla sua prima apparizione. L'unica eccezione è quando esso è molto noto.
Gli acronimi si applicano prevalentemente a denominazioni di enti, istituti e organizzazioni, ma anche a sistemi e metodi scientifici e tecnologici (TAC, tomografia assiale computerizzata), a nomi di prodotti commerciali (GPL, gas
di petrolio liquefatto), a designazioni di vario genere, come IRPEF.
Se un acronimo è usato da molto tempo, non è più necessario scriverlo come una sigla, tutto in maiuscolo, ma si può considerarlo un nome di un ente collettivo, o di un oggetto. Si può scrivere Nasa invece di NASA (National Aeronautics and Space Administration), laser invece di LASER (Light Amplification by Stimulated Emission of Radiation), radar invece di RADAR (RAdio Detecting And Ranging), Basic, invece di BASIC (Beginner's All-purpose Symbolic Instruction Code), pc invece di PC (Personal Computer), ecc.
Il genere e il numero degli articoli da premettere agli acronimi sono stabiliti in base al genere e al numero della denominazione completa, ricavata, nel caso di acronimi di derivazione straniera, dalla traduzione italiana; esempi: gli USA (gli Stati Uniti d'America), la SIAE (la Società ecc.), l'ENEL (l'Ente Nazionale ecc.).
6 – Tabelle
Le tabelle sono prospetti in cui l'autore presenta informazioni concise e ordinate. In base al contenuto si dividono in tabelle di numeri o di parole. Nelle tabelle di numeri si presentano le informazioni con dati numerici, nelle tabelle di parole con testo. A volte può essere utile, o necessario, costruire una tabella mista, con caratteristiche di entrambi i tipi.
Le tabelle numeriche rendono semplice il confronto dei dati perché evidenziano eventuali tendenze, e permettono al lettore di tirare rapidamente e accuratamente alcune conclusioni. Le tabelle di parole e frasi evidenziano concetti, classificazioni, casi particolari ecc., mediante liste di parole o frasi "chiave".
In base alla loro posizione nel testo corrente le tabelle si suddividono in tabelle informali e tabelle formali.
• Una tabella informale è un blocco di testo organizzato in forma schematica, inserito direttamente nel testo corrente, che permette una forma di tabulazione a metà strada tra il testo corrente e una tabella di tipo formale. Si usa per evidenziare informazioni strettamente collegate allo sviluppo dell'esposizione, e per questo motivo la sua tabulazione deve essere molto semplice, non più di due colonne, e deve essere facilmente inseribile nella struttura della frase di cui fa parte. Poiché una tabella informale fa parte di una frase compiuta, essa non è numerata, non ha un titolo e le spiegazioni relative ai dati sono riportate nel testo che la introduce. Per questa sua natura, una tabella informale non può essere facilmente richiamata in altre parti del testo e, se c'è questa necessità, l'autore dovrebbe trasformarla in una tabella formale.
• Per progettare una tabella formale si deve tenere presente che ogni tabella deve essere autonoma, ossia il più possibile indipendente dal testo corrente, e per questo motivo ogni tabella formale deve avere un titolo e un numero progressivo e deve essere richiamata almeno una volta nel testo corrente. Il numero progressivo e il titolo sono posti sopra la tabella (Tabella 4).
In una tabella le informazioni sono disposte secondo una matrice di righe e colonne (Tabella 4): a ciascuna intersezione riga-colonna, chiamata cella, corrisponde una certa informazione. Ogni colonna ha un'intestazione, titolo, che specifica il tipo d'informazione presente. La prima colonna a sinistra, chiamata colonna-indice, è costituita da un elenco di voci, chiamate entrate, che definiscono altrettante righe della tabella, e specificano i soggetti ai quali si riferiscono le informazioni contenute nelle colonne successive. L'insieme delle celle costituisce il corpo della tabella.
La suddivisione in colonne può essere articolata in più livelli successivi, definiti da sotto-titoli, che individuano altrettante colonne. Per non compromettere l'immediatezza e la semplicità della presentazione, l'articolazione non dovrebbe superare due livelli.
Se i dati sono numerici, i dati da confrontare sono disposti verticalmente, nelle colonne perché è molto più facile confrontare numeri allineati verticalmente e l'allineamento verticale semplifica la stampa perché i dati da confrontare hanno (o dovrebbero avere) lo stesso numero di cifre significative.
Tabella 4. Elementi strutturali di una tabella formale (eventuale sotto-titolo).
aTitolob Titoloc Titoloc
Sotto-titoloc Sotto-titoloc
Titolo Tabulazione dei dati (corpo)d
Sotto-titolo Sotto-titolo Titolo
Titolo
I titoli delle colonne e della colonna-indice, e la disposizione del materiale, contribuiscono a rendere efficace una tabella. Ogni titolo deve essere breve, concreto ed espresso usando una costruzione parallela. Se nella colonna-indice compaiono sotto-titoli questi sono rientrati dal margine d'allineamento dei titoli principali (Tabella 4).
I titoli delle colonne sono ordinati in modo logico e prevedibile. L'ordine può essere alfabetico, geografico, cronologico, quantitativo, ecc. La disposizione non deve mai essere lasciata al caso. Se l'ordine è cronologico, le colonne devono leggersi da sinistra verso destra, con la data più recente sulla destra. Per la colonna-indice è possibile porre l'ultima data sia in alto sia in basso.
I sotto-titoli delle colonne, o della colonna-indice, appaiono solo quando è necessario classificare ulteriormente i dati. Questa pratica fa risparmiare spazio, migliora l'aspetto della tabella e la rende di più facile lettura (legge del sette più o meno due). Nelle tabelle totalmente numeriche i sottotitoli sono dei numeri.
Il corpo riporta le informazioni in corrispondenza d'ogni cella: numeri oppure nomi o simboli, o brevi testi descrittivi, le cosiddette "frasi chiave". Tutto il materiale tabulato deve essere disposto in base alle seguenti regole:
•• I numeri interi sono allineati a destra.
•• I numeri reali sono allineati in corrispondenza delle virgole di separazione della parte decimale.
• Il segno "–" è sempre indicato, il segno "+" può essere omesso.
•• I numeri decimali sono scritti con la cifra "0" a sinistra della virgola.
•• Il grado di precisione e il numero di cifre significative sono costanti. Se i dati variano di ordini di grandezza, si usa la notazione tecnico-scientifica, ossia esponenziale in base 10.
• Dati numerici mancanti sono indicati con un trattino orizzontale lungo "—" e non con la cifra "0", che potrebbe essere confusa con un valore numerico possibile.
Nelle tabelle in cui appaiono parole e frasi, le colonne sono allineate a sinistra. Si mantiene il parallelismo sintattico.
La prima lettera d'ogni frase è minuscola, non si usano i punti finali.
Una tabella spesso deve essere corredata di note esplicative. Queste sono scritte normalmente sotto il corpo (si veda la Tabella 4), eventualmente con caratteri più piccoli. Le note possono essere di due tipi: generali e particolari.
• Le note generali forniscono precisazioni relative a tutta la tabella, e possono contenere indicazioni o spiegazioni utili per interpretare la tabella nel suo complesso (Tabella 4). Servono anche a citare le fonti da cui sono tratti i dati impiegati per costruire la tabella, se non sono dell'autore.
• Le note particolari forniscono precisazioni relative a singoli elementi della tabella, ad esempio una voce della colonna-indice o l'informazione di una cella (Tabella 4). Queste note sono associate a specifici contrassegni, che compaiono nel corpo della tabella, e sono riportate direttamente sotto la tabella (eventualmente dopo le note generali), ciascuna preceduta dal corrispondente contrassegno, ma senza alcun'altra intestazione.
Le note sono contrassegnate con numeri o con lettere minuscole (Tabella 4), consecutivamente, a cominciare dal titolo, e procedendo nella colonna-indice e nelle altre colonne, da sinistra verso destra e dall'alto verso il basso. Nelle tabelle numeriche è preferibile usare lettere minuscole perché il lettore confonderebbe i contrassegni numerici con esponenti.
Se lo spazio della tabella è poco, nei titoli e sottotitoli si possono usare abbreviazioni standard (ben note al lettore).
Abbreviazioni non standard, o poco note, devono essere esplicitate nelle note e usate coerentemente e uniformemente sia nella tabella in questione sia in altre simili.
Il formato di una tabella è evidenziato da linee di contorno orizzontali e verticali tracciate in modo tale da suddividere le parti fondamentali della tabella. Le linee di separazione verticali tra le colonne del corpo, o orizzontali tra le voci, devono essere impiegate raramente, e solo se sono necessarie per comprendere meglio i dati.
In una tabella, o nel testo corrente, si devono riportare solo le cifre che hanno un senso fisico, ossia le cifre significative, le quali dipendono dalla precisione delle misure. Deciso il numero di cifre significative per ciascuna grandezza, i successivi calcoli devono tenerne conto. (Non ci di deve preoccupare dei calcoli intermedi dei calcolatori perché questi lavorano con numeri in virgola mobile, ossia con un uguale numero di cifre significative.) Un esempio può illustrare il metodo da seguire. Si calcoli la somma 3,51 + 2,205 + 0,0142 = 5,7292. Il risultato corretto è 5,72 (arrotondato per difetto) o 5,73 (arrotondato per eccesso) perché uno degli addendi (3,51) è preciso fino ai centesimi, soltanto due sono le cifre significative dopo la virgola. Il risultato sarebbe 5,7292 solo se si sommassero 3,5100 + 2,2050 + 0,0142, ossia se gli zeri rappresentassero cifre significative.
Riassumendo, nella somma e nella sottrazione, per determinare il numero di cifre significative del risultato si applicano le regole seguenti: il risultato dell'operazione deve riportare un numero di cifre a destra della virgola non superiore a quelle presenti nell'addendo o sottraendo con minimo numero di cifre a destra della virgola, come nell'esempio precedente. Nella moltiplicazione e nella divisione il prodotto o il quoziente devono contenere un numero di cifre uguale a quello presente nel numero con minimo numero di cifre. Un esempio: 2,43 × 17,675 = 42,95025, ma la risposta "corretta" è 42,9 o 43,0 perché 2,43 ha tre cifre significative. Gli zeri a sinistra di una qualsiasi altra cifra diversa dallo zero non devono essere contati: 0,076 ha solo due cifre significative (76), tanto che spesso si preferisce usare la notazione scientifica (7,6 × 10–2 nell'esempio), perché questa riporta solo le cifre significative. Infine, nell'estrazione della radice quadrata, la radice non può avere più cifre significative del radicando.
7 – Figure
Il termine figura, o illustrazione, si riferisce a una varietà di materiale grafico, ossia materiale riprodotto così com'è, non composto a caratteri di stampa: fotografie, disegni tecnici, grafici, diagrammi, barre, torte, ideogrammi.
Le figure svolgono le seguenti funzioni:
• a) Visualizzano le informazioni, mostrano
•• Come appare qualcosa
•• Come fare qualcosa
•• Come è organizzato qualcosa
•• I dati con livello diverso di dettaglio: da più piccolo a più grande, da più facile a più difficile, ecc.
•• Le tendenze, i dati spuri, possibili errori.
• b) Facilitano il confronto tra le informazioni presenti in una stessa figura, o in figure poste in successione (figure multiple).
• c) Presentano molti numeri in poco spazio.
• d) Sostengono un ragionamento, una discussione.
Per ogni figura si deve sempre scrivere un commento nel testo corrente, per spiegare qual è il punto fondamentale illustrato e la figura deve essere richiamata almeno una volta. Per essere comprese, le figure richiedono anche un testo esplicativo che le accompagni: questo consiste di un titolo, una didascalia e, eventualmente, di una legenda.
Questi tre elementi devono comunicare tutte le informazioni necessarie per rendere la figura più indipendente possibile dal testo e dalla posizione.
Il titolo può essere scritto sopra la figura, o sotto la figura, prima della didascalia. In ogni caso, sotto la figura, dopo l'indicazione numerica (esempio: "Figura 5.3", la terza figura del capitolo 5) si scrive la didascalia: questa spiega il contenuto, a volte solo con il titolo (e in tal caso lo sostituisce), ma più spesso con una frase. Con la didascalia può trovarsi anche una legenda, vale a dire una spiegazione dei contrassegni usati per indicare grafici diversi, punti sperimentali, ecc. Questa spiegazione a volte è inserita nella didascalia e spesso direttamente negli spazi vuoti della figura. Per risparmiare tempo e spazio, molti eliminano il titolo e scrivono solo la didascalia, includendo un'eventuale legenda.
7.1 – Fotografie e disegni tecnici
Una fotografia rappresenta e conferma ciò che lo scrittore afferma nel manoscritto su un particolare oggetto. Per essere efficace, essa deve avere un buon dettaglio, una ottima messa a fuoco, una buona illuminazione del soggetto, un contrasto sufficiente e non mostrare alcun elemento estraneo.
Rispetto a una fotografia, il disegno tecnico di un oggetto può evidenziare molto meglio i particolari che interessa mostrare, particolari che in una fotografia o non apparirebbero, o sarebbero confusi con tanti altri. Il disegno può riguardare l'oggetto intero (anche in assonometria), oppure particolari, sezioni, movimenti, funzioni ecc. Il disegno tecnico è comune a moltissime discipline, sia nelle scienze sia in ingegneria e in architettura, e ci sono molti testi specialistici e norme di settore da rispettare [6].
7.2 – Grafici
I grafici sono un mezzo semplice per mostrare come una variabile (dipendente) varia in funzione di un'altra variabile (indipendente). I grafici evidenziano la continuità di una funzione, mostrano il movimento, la tendenza in funzione del tempo, o di un'altra variabile continua, mostrano come una variabile cambia in relazione all'altra (fanno valutare le derivate).
Le coordinate più comuni sono le cartesiane ortogonali, ma spesso sono utili anche le coordinate polari, cilindriche, sferiche. Un grafico in coordinate cartesiane molto comune è la serie "temporale", che mostra come varia una grandezza in funzione del tempo, o di un'altra variabile indipendente. Per sua natura, una serie temporale riporta, di solito, dati grezzi, che spesso richiedono altre elaborazioni (statistiche) per evidenziare proprietà più importanti.
Per un progetto efficace si devono considerare i seguenti punti: scale, facilità di lettura, semplicità. Le scale devono essere scelte in modo da poter osservare la funzione in tutto l'intervallo di definizione della variabile indipendente.
Se si riportano dati sperimentali il grafico deve estendersi all'incirca al solo intervallo coperto dalle misure. Questo può essere esteso solo per mostrare estrapolazioni (giudicate affidabili) dei dati sperimentali. Le scale più comuni sono la lineare, la logaritmica o una loro combinazione. Una scala logaritmica è utilissima quando l'intervallo da coprire si estende per diversi ordini di grandezza e si devono poter osservare, uniformemente in tutta la scala, intervalli percentualmente costanti.
Quando si costruisce una scala si devono ricordare i seguenti punti:
•• Iniziare la scala dal valore zero (origine dell'asse), altrimenti si distorce la rappresentazione. Se, inserendo lo zero, una gran parte della figura è vuota, inutile, è meglio rompere l'asse e indicare sempre la posizione dello zero.
• Selezionare il rapporto tra la larghezza e l'altezza (rapporto d'aspetto) in modo che ci sia una distorsione accettabile secondo l'asse orizzontale o verticale, tale cioè da non dilatare o comprimere troppo la forma della curva.
•• Indicare sempre le unità di misura sugli assi.
La facilità di lettura dipende sia da una buona scelta delle scale sia dal numero di curve presenti in una stessa figura.
Un grafico con molte curve può confondere il lettore, specie se queste s'intersecano. In un grafico con più di una curva, ciascuna deve essere disegnata con un tipo di linea diverso, se possibile, o deve essere individuata chiaramente con lettere, numeri, simboli, ecc.
Se si riportano misure sperimentali, queste vanno indicate chiaramente con contrassegni (pallini, asterischi, cerchietti, quadrati ecc., anche uniti da spezzate se le funzioni sono continue) e distinti dai punti, o dalle curve, calcolati teoricamente (i modelli). I contrassegni, i caratteri alfanumerici e le linee devono essere sufficientemente grandi e spesse da essere ancora ben visibili e distinguibili in caso di riduzione della figura.
7.3 – Diagrammi
I diagrammi possono rappresentare un circuito elettrico complicato, uno schema a blocchi (diagramma di flusso), una formula chimica, ecc., o illustrare schematicamente un fenomeno fisico.
Il diagramma di flusso è uno strumento grafico molto usato nella comunicazione tecnico-scientifica per visualizzare la sequenza di tutte le operazioni, movimenti, ispezioni (e approvazioni), ritardi, decisioni e immagazzinamento di merci in un processo industriale di qualsiasi tipo.
Ci sono due tipi fondamentali di diagrammi di flusso: di funzioni, di processo.
• Un diagramma di flusso di funzioni descrive l'interazione tra varie attività all'interno di una organizzazione e tra diverse organizzazioni o sistemi.
• Un diagramma di flusso di processo descrive la sequenza delle attività che costituiscono il processo e evidenzia le loro relazioni.
Per essere uno strumento di comunicazione efficace, un diagramma di flusso deve contenere simboli grafici standard, definiti dalla norma ISO 9004.4 (Figura 4). Nei settori dell'ingegneria si usano in aggiunta anche altri simboli con significati particolari (Figura 5).
Fig. 4. – Simboli grafici standard da usare nei diagrammi di flusso (norma ISO 9004.4).
Fig. 5. – Simboli grafici standard usati nei diagrammi di flusso nei settori dell’ingegneria.
7.4 – Barre, torte e ideogrammi
Le barre sono utili per evidenziare somiglianze e differenze tra dati simili. Esse possono essere disposte sia in orizzontale sia in verticale. Come regola approssimativa, le barre verticali descrivono in modo chiaro le differenze di una certa grandezza in periodi diversi (o in funzione di un'altra variabile), le barre orizzontali evidenziano le differenze tra molti articoli in un momento specifico.
Molto usato è il diagramma a barre che riporta, in funzione del tempo, gli intervalli (le "barre") entro i quali devono essere svolte e terminate certe azioni, coordinate per raggiungere alcuni obiettivi (diagramma di Gantt). La figura che ne risulta fornisce il piano di lavoro, i tempi di un progetto.
Le torte mostrano le relazioni tra componenti che totalizzano 100%, non più di cinque. Ogni punto percentuale corrisponde a 3,6° e le fette sono disposte dalla più grande alla più piccola, a cominciare da "mezzogiorno" e movendosi in senso orario. Essendo difficile confrontare tra loro le aree, una torta è utile per mostrare differenze e somiglianze tra percentuali grandi e piccole, ma non per valutare piccole differenze. Non sono adatte per un pubblico qualificato di tecnici, al quale è preferibile mostrare una tabella numerica.
Le barre e le torte non devono essere mai disegnate in prospettiva, perché così facendo si aggiunge inchiostro che distorce la percezione visiva del lettore. A questo proposito, una regola valida in generale è la seguente:
il numero delle dimensioni rappresentate non deve superare mai quello dei dati.
Gli ideogrammi possono comunicare idee astratte e concetti mediante simboli, e si rivolgono a un vasto pubblico.
Spesso sono un adattamento dei diagrammi a barre: a queste sostituiscono dei simboli per dare l'ampiezza della barra, ma esistono problemi per le frazioni. Gli ideogrammi sono quasi un linguaggio universale perché usano
simboli che rappresentano direttamente le idee. Si usano per mostrare i dati a un pubblico generico, non di cultura tecnico-scientifica.
8 – Revisione
La revisione è un'attività che trasforma la prima versione di un manoscritto nella sua versione definitiva. Una revisione efficace consiste in
1. Una revisione di sostanza: riguarda la coerenza e l'organizzazione generale del manoscritto, relativamente al contenuto.
2. Una revisione dello stile: riguarda l'uso efficace e corretto dei paragrafi, delle frasi e delle parole, comprese quelle scientifiche e tecniche, e in generale l'ortografia e la sintassi.
8.1 – Revisione di sostanza
La revisione di sostanza riguarda la coerenza, l'organizzazione e il significato del manoscritto nel senso più vasto, il giusto impiego dell'enfasi, della subordinazione e del parallelismo relativi al contenuto, escludendo gli stessi aspetti relativi al linguaggio. La revisione di sostanza deve assicurare che:
• a) Il titolo riflette accuratamente il contenuto del manoscritto ed è allo stesso tempo conciso, concreto e breve.
• b) Il riassunto presenta sufficienti informazioni per determinare il contenuto generale del manoscritto, ed è conciso e di lunghezza appropriata.
• c) Il riassunto, l'introduzione, il corpo, le conclusioni, le appendici contengono il materiale indicato nei rispettivi titoli categorici e tematici.
• d) Il materiale è suddiviso in modo razionale, i capitoli e le sezioni si succedono logicamente, l'indice è ben strutturato.
• Gli argomenti di uguale importanza sono presentati allo stesso modo e allo stesso livello strutturale (parallelismo).
• Gli argomenti sono subordinati in base alla loro importanza relativa (subordinazione).
•• La sequenza e la struttura dei titoli riflettono il parallelismo e la subordinazione degli argomenti.
• e) Le contraddizioni reali, o apparenti, relative al contenuto tra capitoli o sezioni sono eliminate.
• f) Il materiale dimenticato è incluso: un glossario dei simboli; altri riferimenti bibliografici necessari per sostenere affermazioni, fatti e dati; note e perfino nuove sezioni o capitoli.
• g) I capitoli, le sezioni, le figure, le tabelle, la bibliografia, le appendici sono realmente presenti, e nel giusto ordine.
• h) È indicata la data della versione definitiva.
La revisione di sostanza si applica anche alle tabelle e alle figure.
Per le tabelle, la revisione deve assicurare che:
• a) Il formato della tabella è standard e corretto (per esempio, le diverse unità di misura appaiono nei sottotitoli delle colonne e non nel corpo della tabella).
• b) L'informazione è completa (variabili e unità di misura sono esplicitamente indicate, tutte le celle sono riempite correttamente).
• c) Informazioni simili (in una stessa tabella o in tabelle diverse) sono presentate allo stesso modo (parallelismo).
• d) I titoli sono concisi, brevi, completi e appropriati; tabelle simili hanno titoli simili.
• e) Le potenze in base 10 sono espresse in modo non ambiguo e coerente.
• f) Le colonne sono raggruppate e ordinate in una sequenza razionale; somiglianze e diversità sono evidenziate.
• g) Le unità di misura sono chiare ed espresse nel Sistema Internazionale (SI).
• h) Le fonti delle tabelle sono indicate esplicitamente.
Per le figure la revisione di sostanza deve assicurare che:
• a) Il contenuto del manoscritto è valorizzato da un numero sufficiente di figure, del giusto tipo, e poste il più possibile vicine al testo che le riguarda.
• b) Le curve, i punti sperimentali, le ordinate e le ascisse sono indicate in modo appropriato, le scale sono adeguate.
• c) Le scale delle figure che si devono confrontare sono tra loro coerenti.
• d) I particolari superflui sono eliminati.
• e) Le potenze in base 10 sono espresse in modo non ambiguo e coerente.
• f) Le unità di misura sono chiare ed espresse nel Sistema Internazionale (SI).
• g) Le figure poste in successione, o le parti di figure multiple, sono disposte in modo coerente e appropriato all'argomento.
• h) Le fonti delle figure sono indicate esplicitamente.
L'ultimo controllo riguarda la revisione del formato: il tipo e il corpo dei caratteri, il numero di righe per pagina, la larghezza e la spaziatura delle righe, e altri aspetti relativi al progetto di una pagina "stampata". Con un sistema di videoscrittura il controllo si fa in pochissimo tempo ed è possibile sperimentare diversi formati, e scegliere il più adatto al tipo di manoscritto alla fine, sulla versione definitiva.
8.2 – Revisione dello stile
Nella scrittura tecnico-scientifica un paragrafo è un blocco di testo che esprime e sviluppa completamente un solo concetto, una sola idea, una tesi, mediante una o più frasi. È l'unità fondamentale per sviluppare un argomento complesso. Molti paragrafi svolgono una, o più, delle seguenti funzioni:
•• Spiegano, difendono o illustrano la tesi.
•• Presentano esempi o applicazioni relative alla tesi.
•• Confrontano o contrastano la tesi con altre tesi.
•• Insegnano a usare o ad applicare la tesi.
•• Collegano la tesi a quella di un paragrafo precedente o successivo.
•• Definiscono e spiegano parole "chiave" presenti nella tesi.
•• Discutono le conseguenze logiche della tesi.
Dal punto di vista della struttura, gli elementi essenziali di un paragrafo sono: unità, coerenza, sviluppo adeguato.
• Unità. Un paragrafo ha unità quando è costruito intorno a un'idea centrale. Questa è espressa in una frase tematica, una tesi, e sviluppata nelle altre frasi del paragrafo (frasi di sostegno).
• Coerenza. Un paragrafo è coerente quando è un blocco di testo ben organizzato e logico. La coerenza si ottiene disponendo le frasi in un ordine identificabile e seguendo un percorso, che dipende dal tipo di paragrafo e dalla tesi, che aiuti il lettore a capire ciò che si dice.
• Sviluppo adeguato. Un paragrafo ha uno sviluppo adeguato se approfondisce la tesi in modo sufficiente. La presenza di poche informazioni ha il risultato di presentare un paragrafo che offre solo frammenti d'informazione, la presenza di troppe informazioni produce paragrafi lunghi e spesso ripetitivi che disorientano e annoiano il lettore.
Un paragrafo si deve sviluppare in modo che il lettore dopo averlo letto sia più informato di prima. In base al movimento del testo si possono distinguere cinque tipi di paragrafi: narrativo, descrittivo, di sostegno, di gradazione, di contrasto.
• Un paragrafo narrativo per il suo sviluppo dipende dal movimento nel tempo.
• Un paragrafo descrittivo descrive uno strumento, una procedura, una macchina, ecc.
• Un paragrafo di sostegno esprime subito la tesi e la sviluppa poi con frasi di sostegno. L'autore fa un'affermazione generale (tesi), e poi fornisce i fatti o i dati che la sostengono nelle successive frasi.
• Il paragrafo di gradazione inizia con i particolari, con le frasi di sostegno, e costruisce man mano l'affermazione più importante, la tesi, posta in fondo al paragrafo. È uno sviluppo inverso a quello del paragrafo di sostegno.
• Il paragrafo di contrasto è usato spesso nella scrittura tecnico-scientifica, di solito per discutere i vantaggi e gli svantaggi di qualcosa, per presentare aspetti contrastanti di una questione (pro e contro).
A questi tipi, infine, si aggiunge il paragrafo di transizione, di solito breve, che ha lo scopo di marcare il giro di boa nella discussione e a gettare un ponte tra ciò che si è appena detto e quello che si dirà subito dopo.
8.3 – Revisione delle frasi
Le frasi giocano un ruolo fondamentale nell'evidenziare i punti più importanti. Gli elementi essenziali di una buona frase sono: unità, coerenza, enfasi.
• Unità. In una frase il tema principale, la tesi, è un singolo pensiero espresso all'inizio o alla fine, e sviluppato mediante delle proposizioni di sostegno. Una frase unitaria presenta e sviluppa un solo pensiero.
• Coerenza. La coerenza di una frase è molto simile a quella di un paragrafo. Le frasi coerenti sono sempre chiare anche se vi sono numerose subordinate. Come i paragrafi, esse hanno bisogno di una buona continuità di pensiero, che può essere ottenuta disponendo le subordinate in una sequenza logica, collegandole attraverso proposizioni esplicite o implicite alla frase principale, e scrivendole con la stessa forma grammaticale, cioè usando una costruzione parallela.
• Enfasi. Anche se unità e coerenza assicurano la chiarezza, una giusta enfasi aiuta il lettore a distinguere i concetti importanti da quelli meno importanti. Disponendo bene gli elementi della frase lo scrittore può aiutare il lettore a dare all'intera frase, o a una proposizione, o persino a una sola parola, la dovuta importanza.
I verbi hanno una potente influenza nell'evidenziare una frase. La forma attiva attrae l'attenzione del lettore perché gli comunica direttamente chi ha fatto qualcosa, mentre la forma passiva tende a farla perdere perché descrive che cosa è stato fatto, dando importanza più all'oggetto che al soggetto dell'azione. La forma passiva è usata efficacemente solo quando ciò che è stato fatto è più importante di chi lo ha fatto.
Per migliorare le frasi della prima versione si seguono le seguenti regole:
•• Porre le informazioni nuove o interessanti alla fine.
•• Eliminare parole non necessarie per comprendere l'argomento.
•• Usare verbi invece di sostantivi.
•• Usare la voce attiva invece della passiva.
•• Disporre parole, frasi e proposizioni secondo una costruzione parallela.
•• Non esprimersi in modo troppo compresso e complicato, o troppo evasivo o semplice.
•• Variare la lunghezza delle frasi.
Dalla legge del sette più o meno due discende la necessità di non interporre troppe frasi implicite tra le parole che normalmente andrebbero poste una vicina all'altra, ad esempio soggettoverbo-complemento oggetto. Alla fine della frase, i lettori con una memoria a breve termine corta avranno forse dimenticato le connessioni che l'autore voleva stabilire.
8.4 – Revisione delle parole
La prima versione di un manoscritto è spesso piena di frasi contorte, di parole inutili e di ripetizioni. Nella prima versione una espressione verbosa è giustificata perché rallenta il flusso delle informazioni e dà tempo all'autore di pensare. Il lettore, però, che legge la versione definitiva, non ha bisogno di queste contorsioni e spreco di parole, può leggere a suo comodo, e secondo la velocità di apprendimento che gli è più consona. Una revisione efficace delle parole elimina le parole inutili, gratuite, e si accerta di un uso corretto dei termini tecnici.
Nella scrittura tecnico-scientifica ripetere parole "chiave", termini tecnici, non è "peccato". È molto meglio essere ripetitivi ma precisi, che introdurre sinonimi che non hanno mai esattamente lo stesso significato, e disorientano il lettore, il quale si chiede se si sta parlando ancora della stessa cosa, o di un'altra. Spesso la ripetizione eccessiva di questi termini può essere evitata usando una struttura sintattica diversa, o le liste.
