Scrittura Tecnica
Che cosa c’è nella lezione
Questa lezione segue passo a passo che cosa bisogna fare
per produrre un buon rapporto tecnico.
In particolare la lezione analizza
gli errori da evitare
gli elementi di contenuto
gli elementi formali
gli aspetti grafici
come usare una lista di controllo
1
Scrittura Tecnica
Badare al sodo
In questa prima sezione ci occupiamo di come evitare di
seguire cattive strade nell’allestimento del testo.
In particolare vedremo qui
le insidie della “genericità”
come non complicarsi la vita
come non si deve scrivere
2
Essere generali, non generici
Un rapporto è generico quando di un argomento si
dà solo una visione molto generale.
Infatti, in questo modo il rapporto diventa generico,
non tecnico!
Si evitino anche le dichiarazioni di principio o non
provate o non argomentate.
Ci sono altri sedi in cui si può scrivere così, non nel
rapporto tecnico.
Un esempio
Non complicarsi la vita
A nessuno è chiesto di dimostrare di essere degno
del Nobel.
Quello che è richiesto è che le informazioni siano
chiare e comprensibili e che si colga il disegno
generale del rapporto.
Nessuno si aspetta da un rapporto una tesi di
dottorato!
3
Come NON si deve scrivere
Qualche regola
Evitare le frasi troppo lunghe,
contorte, esagerate;
evitare costruzioni sintattiche
complicate;
evitare la noia (se chi scrive ha a
disposizione una buona metafora
per far capire quello che sta
dicendo, la usi!);
evitare l’ironia (essere ironici è
abilità di notevole raffinatezza);
evitare gli “a capo” eccessivi
(ricordarsi che si scrivono
capoversi, non frasi!).
Scrittura Tecnica
4
Il contenuto del testo
In questa seconda sezione analizzeremo qualche aspetto
particolare che guida alla trasmissione dei contenuti nel
rapporto.
In particolare vedremo qui
gli schemi guida del contenuto
i contenuti più generali
la cura dei particolari e dei dettagli
Gli schemi guida
Ci sono alcuni schemi guida del contenuto in un
rapporto tecnico.
Questi schemi dipendono dal fatto che spesso i nostri
ragionamenti hanno alla base delle logiche ricorrenti.
Ne esamineremo ora qualcuno.
Uno schema del contenuto è l’indicazione di
concetto generale che deve essere presente nel
rapporto.
5
Le cause
Perché
Spesso nel testo occorre spiegare
quali cause provochino il
comportamento che stiamo
descrivendo e in genere quali cause
si colleghino al nostro argomento.
Inoltre il testo deve spesso
indicare per quale ragioni
qualcosa non può funzionare e
quali rimedi si possono attuare
al riguardo.
Gli effetti
Che cosa
capita
Occorre definire gli effetti, cioè le
conseguenze o i risultati, che si
collegano al nostro argomento.
Spesso gli effetti costituiscono la
ragione profonda che motiva il
lettore ad affrontare il nostro
testo.
6
La tipologia
Quanti tipi
esistono
Vale la pena di precisare sempre
quali tipi più generali esistono di
qualcosa che è oggetto del nostro
interesse.
Un buon rapporto tecnico
classifica, cioè indica in quali
classi rientrano i fenomeni
descritti e perché.
Esercizio
Notizie storiche
In passato
Può essere interessante precisare
quale è stata la storia
dell’argomento con cui ci
confrontiamo.
Anche per semplice curiosità, si
può fornire in nota – se non nel
testo – quando e come si è
escogitata la soluzione di cui
stiamo parlando.
Esercizio
7
Processi
I processi
Gli oggetti, ma anche i concetti,
funzionano per fasi, cioè si
sviluppano nel tempo.
Scriviamo un paragrafo o uno o
più capoversi (o blocchi inglesi)
che precisano le fasi del nostro
oggetto.
Esercizio
Descrivere
Far vedere
Spesso di un oggetto dobbiamo
precisare i suoi elementi più concreti e
presentarli al lettore. Occorre procedere
a una descrizione.
Descrivere significa dettagliare gli
elementi e presentarli in modo che il
quadro complessivo “evidenzi”
l’oggetto o il fenomeno con chiarezza.
Descrivere significa partire dal tutto e
dividere l’oggetto o il fenomeno in
parti.
8
Paragoni
Confrontare
Può essere utile confrontare gli
oggetti (o i concetti) tra loro. Questo
confronto può essere attuato:
con altri oggetti della stesse serie;
con oggetti familiari e noti.
I paragoni, le analogie e le metafore
servono per formare una “linea
essenziale” del contenuto del
fenomeno descritto .
Esercizio
Applicazioni
Applicare
Precisare le applicazioni concrete del
nostro oggetto (o concetto) è
indispensabile in un testo tecnico.
Descrivere un’applicazione significa
individuare i principi base e le loro
diverse potenzialità d’uso.
Esercizio
9
Vantaggi/svantaggi
Utilità
Le cose e i concetti - per quanto ben
fatti o ben pensati siano - offrono
sempre la possibilità di una
valutazione nei termini di vantaggi o
svantaggi.
Descrivere i vantaggi significa
cogliere le funzionalità principali di
un oggetto.
Descrivere gli svantaggi significa
individuare le funzionalità meno
efficienti in un oggetto.
Valutazioni
Valutare
Nel testo occorre valutare l’oggetto
(o il concetto) che si sta esaminando.
Valutare significa prendere posizione
o dare le informazioni necessarie per
farlo rispetto a quanto stiamo
esponendo.
Di solito le valutazioni
appartengono a ordini diversi:
- valutazioni economiche
- valutazioni culturali
- valutazioni sociali.
10
Problemi/soluzioni
Trovare
soluzioni
Uno degli aspetti più interessanti
dello scrivere testi tecnici è
individuare problemi e, nel limite del
possibile, indicare delle soluzioni.
Questo rende piacevole e personale il
processo di stesura del rapporto
tecnico.
I contenuti più generali
Gli schemi guida del contenuto vanno sempre inseriti
in una situazione “realistica” che definisca i
contenuti più generali del rapporto tecnico.
Infatti, il rapporto tecnico si situa costantemente in
una situazione molto precisa, deve cioè rivolgersi a
lettori concreti che operano in un contesto
molto specifico.
11
Il pubblico c’è
La audience non va banalmente ridotta a “qualcuno
che potrebbe essere interessato all’argomento”.
Occorre essere più realistici e valutare bene il
quadro della situazione entro cui il rapporto si
colloca (lettori comuni, esperti, enti interessati, ecc.).
Cura dei particolari
Il rapporto deve essere molto particolareggiato e
preciso nei dettagli.
Come entrare nei dettagli, quali selezionare e in che
modo parlarne è il risultato dell’analisi
dell’audience (un conto è il libretto esplicativo di
un forno a microonde scritto per le casalinghe che lo
dovranno usare e un conto è per gli specialisti del
settore!).
12
Scrittura Tecnica
Badare alla forma
In questa terza sezione ci occuperemo degli elementi
formali del rapporto.
In particolare analizzeremo qui
l’organizzazione interna
il paratesto (dai titoli alla note)
la lunghezza di pagina
13
L’organizzazione interna
Un testo tecnico si divide in una copertina e in tre
parti.
Queste componenti devono contenere alcuni
elementi ricorrenti che sono precisati nel documento
richiamabile qui sotto.
Componenti testuali
Il paratesto
Un rapporto non è un ammasso di informazioni che
procedono dalla prima all’ultima senza respiro.
È bensì un testo che è articolato e procede per
punti facilitando così la lettura.
Per questa ragione, il rapporto deve essere curato
nei titoli e nei sottotitoli di paragrafo e presentare
eventuali “liste” al loro interno.
14
Lunghezza di pagina
Ovviamente non ci sono regole per stabilire a priori la
lunghezza di un rapporto tecnico, che di solito si
esprime in pagine (ogni pagina contiene dai 1500 ai
2400 caratteri o più, a seconda delle esigenze).
Essa dipenderà dal tipo di approfondimento
richiesto.
Diciamo semplicemente che 2 pagine sono poche,
200 probabilmente troppe.
Scrittura Tecnica
15
La grafica del testo
In questa quarta sezione considereremo più a fondo gli
aspetti grafici del rapporto. È un argomento molto
importante per rendere i rapporti chiari e convincenti.
In particolare ci occuperemo qui
dell’inquadramento pagina
dell’uso di disegni e tabelle
dell’armonia delle parti
La grafica
La grafica indica tutti quegli aspetti immediatamente
“visibili” di un rapporto tecnico.
Vi rientrano:
l’inquadramento pagina (gabbia o frame);
la scelta dei corpi carattere e della loro grandezza;
l’uso di immagini (disegni o tabelle).
Per approfondire
16
Inquadramento pagina
L’inquadramento pagina riguarda l’equilibrio
complessivo delle componenti che fanno parte della
pagina.
La “gabbia” o “frame” è l’intelaiatura che prevede
come distribuire queste componenti (margini,
immagini, intestazioni e note eventuali).
Il corpo del carattere scelto è un altro elemento
importante della grafica del rapporto.
Margini e corpi
Le immagini
Le immagini riguardano tutti quei testi che sono
aggiunti nel rapporto e che hanno un aspetto
marcatamente visivo.
Oltre alle fotografie, rientrano in questa categoria
diagrammi, tabelle e disegni.
Ogni elemento definito da una cornice di inserimento
deve recare una didascalia, cioè l’indicazione in
chiaro del contenuto dell’immagine.
17
I disegni
I disegni devono essere numerati a seconda del
capitolo (con due cifre, la prima delle quali indica il
capitolo, mentre la seconda indica l’ordine progressivo
dei vostri disegni).
Deve anche essere presente un titolo sotto il disegno
in corpo inferiore rispetto al corpo carattere del testo.
Spesso è possibile collegare con linee (puntatori) il
nome dell’elemento con l’elemento disegnato.
Le tabelle e i diagrammi
Le tabelle e i diagrammi sono importanti perché
semplificano il lavoro del lettore con dati numerici o
schemi.
Anche le tabelle devono essere numerate e recare
un titolo sotto la tabella.
Occorre indicare le “fonti” delle illustrazioni per
esteso, se sono state scandite (o scannerizzate), dopo
il titolo e tra parentesi quadre o tonde, compreso il
numero di pagina.
18
Armonia delle parti
Una grafica efficace è una grafica che tiene conto
dei rapporti “di misura” tra le componenti.
Queste misure devono essere regolari
(non cambiare) per tutto il rapporto.
Un rapporto dall’aspetto chiaro facilita la lettura e il
reperimento delle informazioni.
Esempi
Scrittura Tecnica
19
Una lista per controllare e rivedere
In questa quinta sezione costruiamo un comodo strumento
che ci permette di verificare se abbiamo tenuto tutto sotto
controllo.
In particolare ci occuperemo qui
passo a passo delle fasi di realizzazione
di una lista di domande da spuntare
Un comodo strumento
Una lista di controllo degli elementi che devono
essere tenuti presenti nello stendere un rapporto e in
genere un testo tecnico è un buon metodo per
rivedere quello che si è fatto.
Una “lista di controllo” (in inglese check list) è essa
stessa un esempio di formato testuale tecnico.
Infatti è utilissima per guidare le fasi che devono
essere seguite in un lavoro.
20
Come usarla
Formalmente una lista di controllo è un elenco di
brevi titoli con un argomento generale a cui seguono
o si affiancano alcune domande che permettono di
verificare se qualcosa è presente o è stato fatto.
Il modo migliore per usarla è spuntare ciascuna
domanda dopo aver fornito una risposta controllando
il vostro rapporto.
Analisi della audience
Analisi della
audience
Avete pensato a chi indirizzare il vostro
rapporto?
Avete individuato la situazione concreta
che definisce lo scopo per cui può
essere letto?
Avete precisato - eventualmente –
nell'introduzione quali immaginate siano
i vostri destinatari?
Avete il livello di conoscenze adeguato
al vostro preciso destinatario?
21
Documentazione
Documentazione
Avete indicato con chiarezza le fonti
del vostro lavoro, ad esempio i
riferimenti bibliografici che chiudono il
vostro lavoro?
Avete precisato anche l’eventuale lista
di siti Internet?
Struttura
Struttura
Il rapporto contiene gli elementi
strutturali principali?
Ci sono indice, abstract, titoli e
sottotitoli di parte, indice delle figure,
indice delle tabelle?
Avete inserito una premessa?
22
Scrittura
Scrittura
Vi sembra di essere stati sufficientemente
chiari?
Avete usato i capoversi o i blocchi inglesi?
Avete proceduto a una fase di revisione
dopo la prima copia?
Avete proceduto alla fase di editing?
Avete controllato di aver seguito
scrupolosamente le norme per la citazione
bibliografica?
Forma della pagina
La
pagina
Avete seguito le indicazioni di formato per
la pagina?
Avete distinto il corpo carattere tra titoli,
testo e note (ed eventualmente
bibliografia)?
23
Grafica
Grafica
Avete accompagnato il vostro testo scritto
con illustrazioni?
Avete messo la numerazione e il titolo per
ciascuna di esse?
Forma finale
Forma
finale
Avete rilegato il vostro rapporto tecnico?
Avete curato la copertina? Ci sono tutti i
dati che identificano il vostro rapporto?
24
In questa lezione
In questa lezione abbiamo appreso:
gli errori da evitare
gli elementi di contenuto
gli elementi formali
gli aspetti grafici
come usare una lista di controllo
25