Download - Technical writing and communication
![Page 1: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/1.jpg)
1
TECHNICAL WRITING &
COMUNICAZIONE TECNICA
Linda Finardi25 marzo 2011
![Page 2: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/2.jpg)
Contenuti
Scrivere Documentazione Tecnica
Scrivere per il Web
2
![Page 3: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/3.jpg)
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
![Page 4: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/4.jpg)
1. Caratteristiche e natura
della scrittura tecnica
2. Errori comuni
3. Immagini (tabelle, figure,
grafici)
4. Struttura documenti
tecnici
4
Scrivere
documentazione tecnica
![Page 5: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/5.jpg)
NATURA
Ha un linguaggio altamente specifico e i documenti tecnici sono altamente operativi (linguaggio settoriale caratterizzato da precisa terminologia, definizioni, segni, simboli e formule)
5
Natura e Caratteristiche del TW
Comunicazione Tecnica
Ha principalmente lo scopo di tradurre il linguaggio
settoriale in un linguaggio comprensibile rispetto il
pubblico cui intende riferirsi
![Page 6: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/6.jpg)
REQUISTI:
Chiarezza e Concisione
Comprensività e Immediatezza
Correttezza
Puntualità (data di consegna -
organizzazione)
6
Natura e Caratteristiche del TW
Ma come si fa a
rendere operativi questi requisiti ?
![Page 7: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/7.jpg)
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
![Page 8: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/8.jpg)
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 nellacomprensione del testo e del suo scopo.
8
![Page 9: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/9.jpg)
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
![Page 10: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/10.jpg)
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
![Page 11: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/11.jpg)
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
![Page 12: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/12.jpg)
Tabelle, figure, grafici (esempi)
12
![Page 13: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/13.jpg)
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
• spiegazione
• chiarimento
13
Permettono di presentare l’idea a due
dimensioni: una scritta e una visiva
![Page 14: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/14.jpg)
Struttura documenti tecnici
14
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.
![Page 15: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/15.jpg)
Altre indicazioni operative
15
• 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
![Page 16: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/16.jpg)
Caratteristiche scrittura web:
16
Scrivere per il web
• Dinamica
• Interattiva
• Personalizzata
• Granulare
![Page 17: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/17.jpg)
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.
17
Una pagina "stantia"o "stagnante“ (con una data vecchia) oppure un
documento senza data non risulta una fonte di informazione
affidabile.
![Page 18: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/18.jpg)
InterattivitàQuesta caratteristica è legata alla dinamicità
Importanza dei collegamenti all’interno dello
stesso testo, ad altri documenti o ad altri siti.
18
![Page 19: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/19.jpg)
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.
19
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)
![Page 20: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/20.jpg)
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
![Page 21: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/21.jpg)
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
![Page 22: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/22.jpg)
Valutazione Documento 1/2
22
![Page 23: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/23.jpg)
23
Valutazione Documento 2/2
![Page 24: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/24.jpg)
Contenuti parte 3/3
Comunicazione orale
Valutazione presentazione
Sintesi finale
24
![Page 25: Technical writing and communication](https://reader033.vdocuments.us/reader033/viewer/2022060201/559b09e21a28ab19548b457f/html5/thumbnails/25.jpg)
25
Grazie per l’attenzione