Il documento tratta la scrittura tecnica e la comunicazione efficace, evidenziando l'importanza di chiarezza, concisione e correttezza nello sviluppo di documenti. Vengono analizzati errori comuni e si forniscono suggerimenti su come strutturare informazioni, utilizzare frasi e parole in modo appropriato, e integrare immagini efficacemente. Inoltre, il documento esplora le caratteristiche della scrittura per il web, inclusa la necessità di dinamicità, interattività e personalizzazione del contenuto.

1. TECHNICAL WRITING &
COMUNICAZIONE TECNICA
Linda Finardi
25 marzo 2011
1

2. Contenuti
 Scrivere Documentazione Tecnica
 Scrivere per il Web
2

3. Fonti
MIT OpenCourseWare | 21W.783 Science and
Engineering Writing for Phase II, Fall 2002 |
Prof. Prof. David Custer, course materials for 21W.783
Science and Engineering Writing for Phase II, Fall
2002
MIT OpenCourseWare (http://ocw.mit.edu),
Massachusetts Institute of Technology.
Downloaded on 20 October 2003
3

4. Scrivere
documentazione tecnica
1. Caratteristiche e natura
della scrittura tecnica
2. Errori comuni
3. Immagini (tabelle, figure,
grafici)
4. Struttura documenti
tecnici
4

5. Natura e Caratteristiche del TW
NATURA
Ha un linguaggio altamente
specifico e i documenti tecnici sono
altamente operativi (linguaggio
settoriale caratterizzato da precisa
terminologia, definizioni, segni,
simboli e formule)
Comunicazione Tecnica
Ha principalmente lo scopo di tradurre il linguaggio
settoriale in un linguaggio comprensibile rispetto il
pubblico cui intende riferirsi
5

6. Natura e Caratteristiche del TW
REQUISTI:
 Chiarezza e Concisione
 Comprensività e Immediatezza
 Correttezza
 Puntualità (data di consegna -
organizzazione)
Ma come si fa a
rendere operativi questi requisiti ?
6

7. Errori Comuni
• Problemi a Livello Paragrafo
I più diffusi e i più difficili da riconoscere e rimediare.
Provengono dalla complessità delle idee espresse: in
genere quando non c’è ancora chiarezza e sintesi a
livello di pensiero.
• Problemi a Livello di Frase
Anche questi possono provenire dalla complessità
delle idee espresse, ma sono maggiormente legati
anche alle regole grammaticali, alla sintassi e alla
punteggiatura.
• Problemi a Livello di Parola
7

8. Problemi a Livello Paragrafo
SUGGERIMENTO:
Una idea/informazione per paragrafo
1. strutturare il documento in paragrafi
2. assegnare un’informazione ad un paragrafo
3. assicurare i collegamenti logici tra i paragrafi
(argomentazione) per aiutare il lettore nella
comprensione del testo e del suo scopo.
8

9. Problemi a Livello Frase
• Tempi dei Verbi
Mantenere costante il tempo dei verbi.
• Forma Passiva
Usarla per eliminare il soggetto se non è importante o per
variare la struttura di una frase (i lettori gradiscono la varietà).
Preferire forma attiva (soggetto+verbo) perché di più facile
comprensione (soggetto chiaro e uso di meno parole).
• Punteggiatura
Utilizzarla per dividere le frasi lunghe e complesse in frasi più
corte, eliminando le subordinate (preferire le coordinate) e
cercando di garantirne il collegamento
• Evitare la doppia negazione
NO “Non vorrei non andarci….” ma “Vorrei andarci” 9

10. Problemi a Livello Parola 1/2
• Parole da Evitare:
Suddetto/ Succitato/citato
Possono essere di difficile collegamento
per il lettore: qualificare e ricapitolare l’idea per
aiutare il lettore.
Purtroppo/ Sfortunatamente”
Evitare di esprimere i sentimenti dell’autore.
Ovviamente
Ciò che scrive l’autore non è necessariamente già
conosciuto anche dal lettore.
Evitare Molto/ Poco/superlativi e simili
Possono essere interpretati in maniera diversa dal
lettore
10

11. Problemi a Livello Parola 2/2
 “Notare che”
In genere è qualcosa che l’autore dice a se stesso:
esplicitare e mettere in evidenza subito
l’informazione se fondamentale.
• Pronomi
Possono essere di difficile collegamento al nome di
riferimento per il lettore (cosa chiara invece per chi
scrive).
• Spiegare gli acronimi, le parole tecniche e le
abbreviazioni
• Non eccedere con i connettivi
Possono appesantire il testo.
11

12. Tabelle, figure, grafici (esempi)
12

13. Integrazione Immagini:
Tabelle/Figure/Grafici
Un altro errore comune è di mettere immagini senza
nessuna funzione, nemmeno quella estetica (are not just
salad dressing).
Le immagini sono utili per integrare la logica, la struttura e
lo scopo del documento. In funzione del:
• rafforzamento
• ampliamento Permettono di presentare l’idea a due
• spiegazione dimensioni: una scritta e una visiva
• chiarimento
13

14. Struttura documenti tecnici
1. Sintesi/abstract
all’inizio mettere informazioni sugli scopi e sull’area
coperta dai contenuti
2. Introduzione per chiarire il problema o l’ipotesi
3. Sviluppo
• Informazioni del contesto necessarie a far capire il
problema
• Indicare il metodo seguito
• Mostrare come la soluzione proposta tenta di
risolvere il problema o nel caso di un report mostrare
i risultati
4. Conclusione con dettagli, costi e tempi. 14

15. Altre indicazioni operative
• Deve contenere tutte le info necessarie al lettore, ma solo
quelle essenziali
• Deve non eccedere nella verbosità
• Deve rispettare le regole delle convenzioni linguistiche
• L’enunciazione principale deve essere contenuta all’inizio di
ogni paragrafo
• Usare un piano razionale rivelato dall’indice dei contenuti e
dai titoli dei capitoli/ paragrafi
• Deve tentare di anticipare le domande del lettore per dare
subito risposta
• Dettagliare e specificare le parole con ampio significato che
possono apparire vaghe
15

16. Scrivere per il web
Caratteristiche scrittura web:
• Dinamica
• Interattiva
• Personalizzata
• Granulare
16

17. Dinamicità
 Il contenuto del documento deve avere le
informazioni (testuali, visuali e link) ben
distribuite e organizzate perchè la prima
informazione che arriva è quella
dell’interfaccia (funzionalità+estetica)
 Il materiale sul web deve essere
costantemente aggiornato.
Una pagina "stantia"o "stagnante“ (con una data vecchia) oppure un
documento senza data non risulta una fonte di informazione
affidabile.
17

18. Interattività
Questa caratteristica è legata alla dinamicità
Importanza dei collegamenti all’interno dello
stesso testo, ad altri documenti o ad altri siti.
18

19. Personalizzazione
 Tener conto del pubblico a cui ci si intende
rivolgere (es.se sono specialisti e di che cosa o
è pubblico generalista)
 Deve essere progettato per essere letto in
modo selettivo.
I documenti non devono essere letti dalla prima
all’ultima pagina per essere compreso o per
trovare ciò che serve o interessa al lettore (ciò è
legato alla distribuzione del contenuto del testo
anche)
19

20. Granularità
"Granularizzare” il contenuto significa identificare
porzioni sempre più piccole di informazione.
….dalla pagina, alle frasi, alle parole: in modo che
questi “granuli” possano essere immediatamente
identificati dal lettore e riutilizzati.
20

21. Altre indicazioni
• Deve informare
enfasi sulle funzioni e sull’informazione e non
sull’intrattenimento.
• Fonti:
1. riferirsi a fonti attendibili (istituzionali o persone
autorevoli)
2. indicare la fonte
• Indicare la data di pubblicazione e aggiornamento
21

22. Valutazione Documento 1/2
22

23. Valutazione Documento 2/2
23

24. Contenuti parte 3/3
 Comunicazione orale
 Valutazione presentazione
 Sintesi finale
24

25. Grazie per l’attenzione
25