Claudio G. Casati
COMUNICAZIONE TECNICA
technical writing
1
Parte 1 di 3
Introduzione alla Scrittura Tecnica, Technical Writer, Strategie per Technical Writing
Gennaio 2011
technical writing
Contenuti
� Introduzione alla Scrittura Tecnica
� Technical Writer
� Strategie per Technical Writing� Strategie per Technical Writing
� Praoblemi a livello parole
2
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 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
Obiettivi del Corso
• Identify the key elements of technical writing.
• Describe the nature of technical writing.
• Identify the characteristics of effective
technical writing.technical writing.
• Identify the steps in the writing process.
• Identify some tips to help your documents.
4
Introduzione
Scrittura Tecnica
5
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
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 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
Scrittura Tecnica
8
““““TechnicalTechnicalTechnicalTechnical WritingWritingWritingWriting è qualsiasi cosa è qualsiasi cosa è qualsiasi cosa è qualsiasi cosa che non si intende sia che non si intende sia che non si intende sia che non si intende sia romanzesca, romanzesca, romanzesca, romanzesca, immaginaria o immaginaria o immaginaria o immaginaria o narrativa” narrativa” narrativa” narrativa”
Scrittura Tecnica vs. Accademica
Caratteristiche Scrittura Accademica Scrittura Tecnica
Scopo Dimostrare la conoscenza del tema
Ottenere la realizzazionedi qualcosa
Conoscenza del tema
Inferiore al docenteche deve valutare
Superiore a quella del lettore
9
del tema che deve valutare lettore
Pubblico Docente Parecchie persone
Criteri per la valutazione
Profondità, logica, chiarezza, unità e grammatica
Organizzazione delle ideechiara e semplice
Consider These Statements….
• Looking into the azure blue sky one could see
the golden orb of the sun slip gently beneath
the western sky.
10
• The sun set in the west.
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 to communicate a body of factual information that will help an audience understand a subject or carry out a task.”
Michael H. MarkelDirector of Technical Communication
Boise State University
11
Technical Writing_Definizione 2
Prendere un tema complicato e trasformarlo in
una informazione facile-da-comprendere
per il lettore/ utente.
12
Technical Writing & Technical Writer
Technical Writer
13
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 contextaccurately defined in the communication context
• Comunicatore, scopo, lettori/ uditorio -- once
established, these elements are the beginning of a
solution to the communication problem
14
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• Organizzazione e presentazione delle
informazioni -- achieving the writer’s purpose in a
clear, useful, purposeful way
15
Che cosa producono i
Technical Writer?
� User’s manuals
� System manuals
� Step-by-step procedures
� On-line help
16
� 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.
Technical Writers_Caratteristiche
• Metodico
• Organizzato
• Obiettivo
• Centrato sui lettori
La scrittura tecnica eccellente trasmette una impressione globale di
• Centrato sui lettori
• Onesto
• Critico
• Informato
• Risoluto, deciso
17
impressione globale di autorità, accuratezza, completezza, e di lavoro onesto.
Gestione della complessità
Strategie per Technical Writing
18
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. 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
Strategie per TW
La complessità di gestione della documentazione tecnica
richiede strategie di progettazione.
Alcune comunemente applicate sono:
� semplificazione
� prioritizzazione� prioritizzazione
� Iterazione
� struttura
� pianificazione
� astrazione
� collaborazione
20
Semplificazione
� “Light side” -- Sia prioritizzazione, che iterazione, struttura,
pianificazione, astrazione, collaborazione, possono essere
utilizzate in modo appropriato per semplificare una idea.
Like "the force,'' simplification has a light
and a dark side.
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
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 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
Pianificazione, astrazione, …
� Pianificazione -- Planning is the definition or
organization of structure.
� Astrazione -- Abstraction is a very effective
method of simplification. method of simplification.
� Collaborazione -- Balance collaboration with
efficiency.
23
Scrivere è un processo
Scrivere bene significa, sia produrre un documento adeguato, sia attivare unaserie di azioni con l’obiettivo di produrredocumenti conformi alle specifiche.
Processi:
24
Processi:
• pianificazione,
• organizzazione,
• scrittura,
• revisione,
• editing, e
• riscrittura.
Scrivere è un processo
collaborativo
� Scrivere migliora con la pratica.
• Feedback on this writing produces better writing and
better writing habits.
25
� 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.
Parole vaghe, offensive, …
Problemi a livello parola
26
Fonte: spincity.tumblr.com
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.
27
Frase originale Frase riscritta
It is possible to achieve
maximum velocity within
five seconds.
Maximum velocity can be
achieved within five seconds.
There is an immense
amount of work that we
have to do.
We have to do an immense
amount of work.
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
sugarless gum.
Four out of five dentists
recommend sugarless gum.
28
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.
Surprise transition words
Original RewriteImmunoprecipitation is a
powerful technique because
the specificity of the immuno-
Because the specificity of the immunoglobulin for its ligand is
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.
the specificity of the immuno-
globulin for its ligand is high.
Thus, it allows detection and
possible quantification of a
target antigen in a mixture of
proteins.
immunoglobulin for its ligand is high, immunoprecipitationallows detection and possible quantification of a target antigen in a mixture of proteins.
29
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.
Parole vaghe
Original Rewrite
I was involved in research on
high temperature oxygen I constructed the current probes, measured the frequency
involve, deal with, and discussThese words are vague. Provide more detail; be specific. I see involve used in resumes and cover letters to very poor effect.
high temperature oxygen
conductivity. I was involved in
research on high temperature
oxygen conductivity.
probes, measured the frequency response of thin film samples, and analyzed data for high temperature oxygen conductivity experiments.
30
Without additional elaboration, the original sentence could mean that the author provided the researchers with pizza.
ESL (English as a Second Language)
ESL/ ESL (English as a Second Language ) – Problemi a livello
parola:
� subject-verb match
� determiners
� prepositions� 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
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 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.
32
Frase originale Frase riscritta
I was involved in research
on high temperature
oxygen conductivity.
I constructed the current probes, measured
the frequency response of thin film samples,
and analyzed data for high temperature
oxygen conductivity experiments.
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
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 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
Lo disse Socrate …
Original Rewrite
Many scientists have studied
PHB, mostly because of its
potential use as a
The potential use of PHB as a biodegradable plastic has promted numerous studies of its
Invoking scientists or researchers often makes your text sound like a caracatureof a 1950's press release. Usually, these words are used to indicate the importance of an idea.
potential use as a
biodegradable plastic.
Such a statement can be interpreted in
two ways, depending on the reader's
opinion of scientists:
� Scientists are always right,
therefore, PHB is important.
� Scientists are full of balony,
therefore, PHB is unimportant.
promted numerous studies of its physical properties and its production and purification.
The scientists have disappeared, as has any associated stigma or glory. The people who produced the studies can tracked down if need be through the references. And, I've taken the liberty of structuring the sorts of things that are known about the substance.
35
Contenuti Parte 2 di 3
� Caratteristiche della Scrittura Tecnica
� Stile
� Tabelle, figure e grafici
� Struttura dei Documenti “Tecnici”
36
