Introduzione alla Scrittura Tecnica, Technical Writer, Strategie per Technical Writing.

1. Claudio G. Casati
COMUNICAZIONE TECNICA
technical writing
Parte 1 di 3
Introduzione alla Scrittura Tecnica, Technical Writer,
Strategie per Technical Writing
Gennaio 2011
1

2. Contenuti
Introduzione alla Scrittura Tecnica
Technical Writer
Strategie per Technical Writing
Praoblemi a livello parole
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. Obiettivi del Corso
• Identify the key elements of technical writing.
• Describe the nature of technical writing.
• Identify the characteristics of effective
technical writing.
• Identify the steps in the writing process.
• Identify some tips to help your documents.
4

5. Scrittura Tecnica
Introduzione
5

6. Gestione della Complessità
una volta …
I romantici sostengono che, una volta, la vita era semplice
e buona. Una singola persona, sebbene eccezionale,
poteva sapere tutto quello che c'era da sapere; Aristotele
e Beda il Venerabile sono esempio di tale intelletto.
Per intelletti meno potenti, la complessità veniva gestita
attraverso l'apprendistato. Le informazioni venivano
trasferite lungo tutto il corso della vita, mentre la pratica e
la tradizione rafforzavano l'apprendimento.
Un artigiano poteva sapere tutto sul suo mestiere.
6

7. Gestione della Complessità
adesso …
Ora, dopo duemila anni, la natura delle informazioni è
cambiata. La “conoscenza totale” e l’approccio da
apprendista alla gestione della complessità non sono più
fattibili.
Il volume di informazioni rende impossibile per una persona
assorbire tutto quello che c'è da sapere . Inoltre, le
informazioni cambiano più velocemente di quanto si può
apprendere attraverso l'apprendistato.
Questi cambiamenti fondamentali hanno forzato lo sviluppo
della scrittura tecnica, che permette di accedere,
aggiornare e memorizzare grandi masse di informazioni.
7

8. Scrittura Tecnica
“Technical Writing è qualsiasi cosa
che non si intende sia romanzesca,
immaginaria o narrativa”
8

9. Scrittura Tecnica vs. Accademica
Caratteristiche Scrittura Accademica Scrittura Tecnica
Scopo Dimostrare la Ottenere la realizzazione
conoscenza del tema di qualcosa
Conoscenza Inferiore al docente Superiore a quella del
del tema che deve valutare lettore
Pubblico Docente Parecchie persone
Criteri per la Profondità, logica, Organizzazione delle idee
valutazione chiarezza, unità e chiara e semplice
grammatica
9

10. Consider These Statements….
• Looking into the azure blue sky one could see
the golden orb of the sun slip gently beneath
the western sky.
• The sun set in the west.
10

11. Technical Writing_Definizione 1
“Technical writing conveys specific information about
a technical subject to a specific audience for a
specific purpose …The words and graphics of
technical writing are meant to be practical: that is,
to communicate a body of factual information that
will help an audience understand a subject or carry
out a task.”
Michael H. Markel
Director of Technical Communication
Boise State University
11

12. Technical Writing_Definizione 2
Prendere un tema complicato e trasformarlo in
una informazione facile-da-comprendere
per il lettore/ utente.
12

13. Technical Writer
Technical Writing & Technical Writer
13

14. Caratteristiche Technical Writing
• Tema Tecnico -- peculiar to or characteristic of a
particular art, science, trade, technology, or
profession
• Problema di Comunicazione -- recognized and
accurately defined in the communication context
• Comunicatore, scopo, lettori/ uditorio -- once
established, these elements are the beginning of a
solution to the communication problem
14

15. Output del Technical Writing
• Informazioni precise e accurate -- discovering
information needed to solve problem through
thinking, study, investigation, observation,
analysis, experimentation, and measurement
• Organizzazione e presentazione delle
informazioni -- achieving the writer’s purpose in a
clear, useful, purposeful way
15

16. Che cosa producono i
Technical Writer?
User’s manuals
System manuals
Step-by-step procedures
On-line help
Training manuals
Quick-reference guides
How-to video scripts.
I Technical Writers conoscono … i lettori, gli obiettivi,
come scrivere con semplicità, direttamente,
e in modo conciso.
16

17. Technical Writers_Caratteristiche
• Metodico
• Organizzato La scrittura tecnica
• Obiettivo
eccellente trasmette una
impressione globale di
• Centrato sui lettori
autorità, accuratezza,
• Onesto
completezza, e di lavoro
• Critico onesto.
• Informato
• Risoluto, deciso
17

18. Strategie per Technical Writing
Gestione della complessità
18

19. 2 livelli di complessità
Nella Comunicazione Tecnica devono essere gestiti due
livelli di complessità :
• l'idea stessa e
• il complesso incastro di parole utilizzato, sulla
pagina, per esprimere l'idea.
Gestire la complessità delle idee rimarrà una attività
dello scrittore, mentre l’esperienza sviluppata nella
gestione della complessità del testo è facilmente
trasferibili a diversi contesti, lavorando sulla struttura
del testo e sui processi che contribuiscono a crearlo.
19

20. Strategie per TW
La complessità di gestione della documentazione tecnica
richiede strategie di progettazione.
Alcune comunemente applicate sono:
semplificazione
prioritizzazione
Iterazione
struttura
pianificazione
astrazione
collaborazione
20

21. Semplificazione
Like "the force,'' simplification has a light
and a dark side.
“Light side” -- Sia prioritizzazione, che iterazione, struttura,
pianificazione, astrazione, collaborazione, possono essere
utilizzate in modo appropriato per semplificare una idea.
For example, diverse empirical information can be
"simplified'' by abstraction, through the definition of a law
or principle.
“Dark side” -- The improper use of simplification is to
"water down,'' to remove relevant detail from a perfectly
good idea just to make the idea easy to express.
21

22. Prioritizzazione, iterazione, …
Prioritizzazione -- If the project is large, the most
important aspects should be dealt with first.
Iterazione -- iteration is important because the
drafting process transforms the idea as understood by
the author into an idea that can be understood by the
reader.
Struttura -- For technical documents, structure
increases the ease of finding and absorbing
information.
22

23. Pianificazione, astrazione, …
Pianificazione -- Planning is the definition or
organization of structure.
Astrazione -- Abstraction is a very effective
method of simplification.
Collaborazione -- Balance collaboration with
efficiency.
23

24. Scrivere è un processo
Scrivere bene significa, sia produrre un
documento adeguato, sia attivare una
serie di azioni con l’obiettivo di produrre
documenti conformi alle specifiche.
Processi:
• pianificazione,
• organizzazione,
• scrittura,
• revisione,
• editing, e
• riscrittura.
24

25. Scrivere è un processo
collaborativo
Scrivere migliora con la pratica.
• Feedback on this writing produces better writing and
better writing habits.
Scrivere è una attività collaborativa.
• Writing is a collaboration between the writer and the
audience. Both expect cooperation from the other.
• Without this cooperation, nothing is communicated.
• Writing can also be a collaboration among writers
working together on a common task.
25

26. Problemi a livello parola
Parole vaghe, offensive, …
Fonte: spincity.tumblr.com
26

27. C’è, è
C’è/ è/there is and it is: These pairs of words often are used to
start sentences. They convey neither information nor
connections themselves and are thus dead text. Worse, it has
the connotation of linking back to a noun; a reader trying to
make such a connection will be confused. Recast sentences
that start with these pairs.
Frase originale Frase riscritta
It is possible to achieve
Maximum velocity can be
maximum velocity within
achieved within five seconds.
five seconds.
There is an immense
We have to do an immense
amount of work that we
amount of work.
have to do.
27

28. Molto/ Moltissimo/A lot
Molto/ Moltissimo/A lot -- A lot means a lot to the author, but
not much to the reader. Be specific about the quantity.
Frase originale Frase riscritta
A lot of dentists recommend Four out of five dentists
sugarless gum. recommend sugarless gum.
Suddetto/ Succitato/ aforementioned -- The reader won't
know which idea to associate with these constructs: qualify
and recap the idea for the reader.
28

29. Surprise transition words
Transition words are often a surprise to the reader. The author understands
the connection and indeed puts in a logically correct transition word.
Unfortunately, the logic and connection come too late for the reader.
The most common offending words are thus, therefore, and however.
Original Rewrite
Immunoprecipitation is a
powerful technique because Because the specificity of the
the specificity of the immuno- immunoglobulin for its ligand is
globulin for its ligand is high. high, immunoprecipitation
Thus, it allows detection and allows detection and possible
quantification of a target
possible quantification of a
antigen in a mixture of proteins.
target antigen in a mixture of
proteins.
The original is difficult to understand because its structure is not clear from the
start. The information about immunoprecipitation is true enough, but the reader
doesn't know what to do with the information. The "thus" comes as a surprise.
The reader needs to backtrack and remember the previous idea. 29

30. Parole vaghe
involve, deal with, and discuss
These words are vague. Provide more detail; be specific. I see involve used in
resumes and cover letters to very poor effect.
Original Rewrite
I was involved in research on I constructed the current
high temperature oxygen probes, measured the frequency
conductivity. I was involved in response of thin film samples,
research on high temperature and analyzed data for high
oxygen conductivity. temperature oxygen
conductivity experiments.
Without additional elaboration, the original sentence could mean that the author
provided the researchers with pizza.
30

31. ESL (English as a Second Language)
ESL/ ESL (English as a Second Language ) – Problemi a livello
parola:
subject-verb match
determiners
prepositions
infinitives
Get a native speaker to proof read your text. In the absence of a
native speaker, devote a proofreading to these trouble spots.
31

32. 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.
32

33. Ovviamente/Obviously
In rough drafts obvious is an important flag to the writer; it
means the idea is vitally important and care must be taken to
make that idea obvious to the reader. A reader can think
three things when reading the word obviously:
It is obvious, so why is it mentioned.
It is not obvious; the author is stupid.
It is not obvious; the reader is stupid.
Because none of these modes of thought are productive,
obviously should be ruthlessly eliminated from final drafts.
33

34. Sfortunatamente, …
Purtroppo/ Sfortunatamente/ unfortunately
Often unfortunate for the author, but the whim of fates is
rarely of importance to the reader.
Notare che/ note that
A note by the author to the author. It means that the
information is important but has not been connected to
the text. Remove the note and explicitly connect the
information to the rest of the text.
34

35. Lo disse Socrate …
Invoking scientists or researchers often makes your text sound like a caracature
of a 1950's press release. Usually, these words are used to indicate the
importance of an idea.
Original Rewrite
Many scientists have studied The potential use of PHB as a
PHB, mostly because of its biodegradable plastic has
potential use as a promted numerous studies of its
biodegradable plastic. physical properties and its
production and purification.
Such a statement can be interpreted in
two ways, depending on the reader's The scientists have disappeared, as has
any associated stigma or glory. The
opinion of scientists: people who produced the studies can
Scientists are always right, tracked down if need be through the
therefore, PHB is important. references. And, I've taken the liberty of
structuring the sorts of things that are
Scientists are full of balony, known about the substance.
therefore, PHB is unimportant.
35

36. Contenuti Parte 2 di 3
Caratteristiche della Scrittura Tecnica
Stile
Tabelle, figure e grafici
Struttura dei Documenti “Tecnici”
36