Caratteristiche della Scrittura Tecnica, Stile, Tabelle, figure e grafici, Struttura dei Documenti “Tecnici”

1. Technical Writing
COMUNICAZIONE TECNICA
Parte II – Scrivere, scrivere per il web, presentare
Dicembre 2010
1

2. Contenuti
Scrivere Documentazione “Tecnica”
• Stile
• Tabelle, Figure e Grafici
Scrivere per il Web
Comunicazione Orale
Valutazioni Documenti e Presentazioni
Sintesi finale
2

3. Citazione
Parte del materiale è tratto dal corso:
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. Struttura e Contenuti
Stile
4

5. Errori Comuni
• Problemi a Livello Paragrafo -- Le difficoltà a livello
paragrafo sono le più complesse. Sono dominanti,
difficili da riconoscere e non presentano rimedi
semplici. I problemi provengono dalla complessità
delle idee espresse al livello di paragrafo e alle linee-
guida di riferimento (piuttosto che le regole) per la
definizione della struttura. Obiettivo: “Un’idea, un
paragrafo”
• Problemi a Livello Frase -- …
• Problemi a Livello Parola -- …
• Revisione globale – come redigere la prima stesura.
5

6. Problemi a Livello Paragrafo
• Unità, Transizione, Sviluppo – rendere accessibile al
lettore la logica di fondo e la struttura.
• Una idea per Paragrafo – assegnare ogni idea ad uno
specifico paragrafo per ridurre la sovrabbondanza di idee in
un paragrafo; assicurare i collegamenti tra i paragrafi.
• Parole di Transizione a Sorpresa -- L'autore conosce i
collegamenti e usa le parole in una sequenza logica.
Purtroppo, la logica ed il collegamento arrivano troppo in
ritardo per il lettore che si è già costruito una possibile
logica. Le parole offensive più comuni sono: così, quindi e
tuttavia.
6

7. Problemi a Livello Frase 1/2
• Tempi dei Verbi -- Tentare di mantenere costante il tempo dei
verbi, specialmente all'interno di un paragrafo. Quando dovete
cambiare il tempo, avvertire il lettore della transizione.
• Forma Attiva/ Passiva – Ci sono buoni motivi usare la voce
passiva e ci sono buoni motivi per evitarla. Usarla per cambiare
l'ordine delle informazioni in una frase, per variare la struttura di
una frase (i lettori gradiscono la varietà), per eliminare il vero
soggetto se non è importante. Evitarla perché i lettori
preferiscono le frasi attive e perché le frasi passive usano più
parole per esprimere un'idea. È più facile rendere passiva una
frase attiva che il viceversa.
Frase originale Frase riscritta
Lo scopo di questa tesi è di cercare di Questa tesi sviluppa e verifica un
sviluppare e verificare un modello per … modello per …
7

8. Problemi a Livello Frase 2/2
• Punteggiatura – Quando le frasi sono troppo lunghe e
complesse per usare correttamente la punteggiatura,
dividerle in frasi corte e garantirne il collegamento
• Serie di “e” – equivale a una lunga frase senza
punteggiatura: utilizzare correttamente la punteggiatura e
dividere in più frasi per migliorare la comprensibilità.
• Una Idea per Frase – e collegamento tra le frasi.
• Separazione Soggetto/Verbo – Come linea-guida
mantenere soggetto e verbo sulla stessa linea.
• Non usare la doppia negazione --
8

9. Problemi a Livello Parola 1/3
• Pronomi/ Pronouns (questo, qui, c’è, è) -- Pronouns are
links to previous nouns. Their misuse is usually due to the
author's awareness of the correct linkage and the reader's
ignorance of the linkage.
Frase originale Frase riscritta
It is possible to achieve maximum Maximum velocity can be achieved
velocity within five seconds. within five seconds.
There is an immense amount of We have to do an immense amount
work that we have to do. of work.
• Molto/ Moltissimo/A lot -- A lot means a lot to the author,
but not much to the reader. Be specific about the quantity.
9

10. Problemi a Livello Parola 2/3
• Suddetto/ Succitato/ aforementioned -- The reader won't
know which idea to associate with these constructs: qualify
and recap the idea for the reader.
• ESL/ ESL (English as a Second Language ) -- Get a native
speaker to proof read your text. In the absence of a native
speaker, devote a proofreading to these trouble spots.
• Coinvolgere/Affrontare/ Discutere/ Involve, deal with, and
discuss – Parole vaghe: dettagliare, specificare.
Frase originale Frase riscritta
I was involved in research I constructed the current probes, measured
on high temperature the frequency response of thin film samples,
oxygen conductivity. and analyzed data for high temperature
oxygen conductivity experiments.
10

11. Problemi a Livello Parola 3/3
• Purtroppo/ Sfortunatamente/ unfortunately -- Often
unfortunate for the author, but the whim of fates is rarely of
importance to the reader.
Ovviamente/ Obviously -- In rough drafts obvious means the
idea is vitally important and care must be taken to make that
idea obvious to the reader. Unfortunately, a thing cannot be
made obvious merely by applying the adjective. A reader can
think 3 things when reading the word obviously:
1. It is obvious, so why is it mentioned.
2. It is not obvious; the author is stupid.
3. It is not obvious; the reader is stupid.
• Notare che/ Note that -- Note that is a note by the author to
the author. Remove the note and explicitly connect the
information to the rest of the text. 11

12. Struttura e Contenuti
Tabelle, figure e grafici
12

13. Tabelle, figure, grafici (esempi)
13

14. Integrazione Tabelle/Fig./Grafici
• Grafici (tabelle, figure, grafici) are not just salad dressing;
they are not just illuminations scribed in the margins by
hightech monks to increase the glory of science.
• I grafici sono parte integrale della logica, struttura, e scopo
del documento.
• I Technical Papers sono spesso strutturati intorno a grafici.
• Letteralmente, un grafico rende possibile far “vedere” al
lettore l’idea dell’autore.
• Grafici e rappresentazioni testuali differiscono:
Il testo è a 1 dimensione ed è composto da parole,
Il Grafico è a 2 dimensioni e presenta le idee a vista.
14

15. Scrittura Tecnica
Pagine Web
15

16. Contenuti della sessione
Web Content_Definition
Qualities of Web Content - Web Content is
• Dynamic
• Linked & Distributed
• Customized
• Granular
• Interactive
Web vs. Stampa
16

17. Web Content_Definizione
I Contenuti web sono la combinazione di informazioni
e interazioni che comprendono l’esperienza del
lettore/utente.
I Contenuti sono sinonimo di valore sul web,
comprendendo ciò che gli utenti vedono e con cui
interagiscono.
Qualità dei Contenuti web:
• dinamico
• collegato & distribuito
• personalizzato
• granulare Dicendo“sono” si allude alle
Dicendo“sono”
• interattivo aspettative dell’utente
17

18. I Contenuti Web sono Dinamici
What we see on the web, we expect to
change soon … or to have changed recently.
We talk of “stale” or “stagnant” pages. Pages
the don’t recognize us, or recognize what day
it is are less easy to trust as sources of
information. Note how different this is from
the medium of print.
18

19. I Contenuti Web sono collegati e
Distribuiti
Users experience content in a localized way when
it shows up on their screens. But we know that it
may reside on servers that are remote and widely
dispersed.
The ability to link content with other content
means that, often, the information IS the
interface!
19

20. I Contenuti Web sono
personalizzati
As “the primary location of value” of a website, the
content that is most prized is content that the user
experiences as tailored to their individual needs.
This creates an interesting dilemma: when should
we customize to the point of personalization? Is
there a point where delivering value by
personalizing yields diminishing returns?
20

21. I Contenuti Web sono Granulari
Web content is far less likely to stay neatly tucked into
the boundaries we associate with traditional print
genres.
As we develop better ways to attach meta-data to
content, we increase its granularity. Familiar units from
the print world like the page or the paragraph, give
way to new ones…
“Granularizing” content simply means identifying and
placing boundaries around smaller and smaller chunks
of information so it can be referenced, styled, and re-
used.
21

22. I Contenuti Web sono Interattivi
If we truly accept the idea that content
comprises both interactions and information,
then web “content” can conceivably take the
place of applications as we know them.
22

23. Web vs. Stampa
Users read print but scan web content
Users read print sequential but navigate web
content
Users scan the page for keywords and phrases
Web content must be edited to be scannable, it
must be
• bulleted
• less than half the print content
• highlighted with keywords
23

24. Contenuti navigabili
Credibility is important for web content.
Readers often want to know the source of
information behind the document.
Authors must not be afraid to let readers visit
other sites. Content must be navigable with:
• outbound hypertext links
• similar articles or web sites
24

25. Raccomandazioni per le pagine web
• Strutturare/ Chunk* le informazioni.
• Mantenere corti i paragrafi.
• Meno è meglio.
• Controllare la larghezza del testo usando le
colonne.
* http://webstyleguide.com/site/chunk.html
25

26. Raccomandazioni per la
progettazione di pagine web
• Serif fonts don’t work well on
screens unless they are large.
• Use Sans Serif fonts for most information.
• Font sizes should be scaleable.
• Use contrasting colors for text and the
background of the page. Migliore contrasto di
colore.
• Avoid busy backgrounds.
Contrasto di colore
difficile da leggere.
26

27. Comunicazione Orale
Presentazione
27

28. Presentazione Orale
28

29. Importanza della
Presentazione Orale
• An oral presentation is not just salad dressing; it is
not just the press conference where you announce
your brilliant discovery to the rest of the world.
• La comunicazione orale con altri (inclusi il capo, gli
sponsor di un progetto, etc), a intervalli regolari nel
corso del progetto e/o delle attività , garantisce la
necessaria visibilità sul lavoro svolto e convince gli
altri della sua utilità, economia, e tempificazione.
29

30. Presentazione Formale/ Informale
• Molte delle caratteristiche della comunicazione formale
possono essere efficacemente utilizzate nelle situazioni di
comunicazione informale . Oral communication skills will
shape the course of any project.
• Principi che guidano una presentazione orale:
• struttura,
• dettagli,
• inizio/ corpo/ fine,
• unità,
• transizione,
• sviluppo.
• I due temi fondamentali sono struttura e consegna.
30

31. Mechanics -- 20 Dos & Don‘ts
• Mai chiedere scusa.
• Parlare a un ritmo ragionevole. Don't say, " We have alot of
material to cover, so I'm going to have to talk fast..."
• Proiettore …
• Tempo …
• Movimenti del corpo …
• Parlare …
• Domande
Ripetere le domande
Non impantanarsi nelle domande
31

32. Mechanics -- 20 Dos & Don‘ts
Proiettore
• Controllare la proiezione
• Evitare dia troppo “piene”
• Non stare davanti allo schermo
• 10/12 dia per una presentazione di 10=>15 minuti
• Rendere interessanti le dia (uso del colore, immagini, …)
• Non coprire parte dello schermo
• Utilizzare matrici, tabelle, grafici per illustrare i temi
principali
• Se si usa una dia 2 volte, duplicarla
32

33. Mechanics -- 20 Dos & Don‘ts
Tempo
• Non andare fuori tempo
• Focalizzarsi su un unico risultato
• … non andare fuori tempo
• Non andare fuori tema, a meno che … la
derivazione sia importante
• … non andare fuori tempo
• I dettagli possono uccidere
• … non andare fuori tempo
33

34. Mechanics -- 20 Dos & Don‘ts
Movimenti del corpo, Parlare
Movimenti del corpo
• Controllare le mani -- use them to focus attention on the
screen
• Non essere rigido/ non essere irrequieto
Parlare
• Adeguare il livello della voce in modo da poter essere
sentito
• Non parlare al muro/ pavimento
• Non leggere dalle note -- if you must, start with
something else
34

35. Presentazione Orale: considerare
la curva dell’attenzione
35

36. Valutazione
Documenti e Presentazioni
36

37. Valutazione Documento 1/2
37

38. Valutazione Documento 2/2
38

39. Valutazione Presentazione 1/2
39

40. Valutazione Presentazione 2/2
40

41. Sintesi finale
• La Comunicazione Tecnica è un processo problem-solving.
• Le Organizzazioni producono Comunicazione Tecnica per
uso interno ed esterno.
• I lavoratori classificano le competenze di comunicazione
secondo il seguente ordine di importanza:
chiarezza,
stringatezza,
organizzazione,
grammatica.
41

42. Certificato TW
42

43. Please don’t forget to fill out
the evaluation forms!
THANK YOU FOR YOUR TIME!
43