Claudio G. Casati

COMUNICAZIONE TECNICA

technical writing

1

Parte 2 di 3Caratteristiche della Scrittura Tecnica, Stile, Tabelle, figure e

grafici, Struttura dei Documenti “Tecnici”

Gennaio 2011

technical writing

Contenuti

� Caratteristiche della Scrittura Tecnica

� Stile

� Tabelle, figure e grafici� Tabelle, figure e grafici

� Struttura dei Documenti “Tecnici”

� Valutazione Documento

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

Caratteristiche, requisiti, efficacia, qualità

Caratteristiche Scrittura Tecnica

5

Technical Writing_Natura

• Scopo: spelled out in the opening paragraphs

• Vocabolario: typically specialized

• Frasi: highly specific and fact filled

• Gergo: typically present in specialized • Gergo: typically present in specialized terminology, definitions, signs, symbols, and formulas

• Grafici & tabelle: reinforces and/or expands upon surrounding prose

• Documentazione: appears in text & bibliographies

6

Technical Writing_Caratteristiche

� Gergo e abbreviazioni

� Grafici (tabelle, grafici, figure) ed Equazioni

� Enfasi sulle funzioni rispetto l’intrattenimento

� I Documenti non devono essere letti dalla prima � I Documenti non devono essere letti dalla prima all’ultima pagina

� I Documenti possono essere utili anche solamentea una udienza ristretta

7

Technical Writing_Operatività

� I Documenti sono altamente operativi

� I Documenti Tecnici hanno una data di consegnadefinita

� I Prodotti devono essere spediti con la � I Prodotti devono essere spediti con la documentazione

� Le relazioni tecniche e/o scientifiche per congressi/ conferenze devono essere inviate in tempo per essere pubblicate.

8

Technical Writing_Efficacia

Le quattro “C”:

• Chiarezza – facilmente comprensibile dalpubblico designato

• Comprensività – tutte le informazioni• Comprensività – tutte le informazioninecessarie sono presenti

• Concisione – chiara senza eccesso di verbosità

• Correttezza – rispetta la grammatica e segue le convenzioni

9

Requisiti dei documenti

Il documento:

� Contiene all’inizio informazioni sugli scopi e sullaarea coperta

� Fornisce informazioni essenziali, è scriito in modo chiaro e senza orpellimodo chiaro e senza orpelli

� Include una sintesi e/o conclusioni

� È progettato per essere letto in modo selettivo(interessi/ necessità)

10

Caratteristiche Qualitative

• Consegna alla data prevista, o in anticipo

• Impressive when flipped through

• Uso di tabelle e grafici per presentare e chiarire icontenuticontenuti

• Uso di un piano razionale, facilmente percepibile, rivelato dall’indice dei contenuti e dai titoli deicapitoli/ paragrafi

• Reads coherently and cumulatively

• Anticipa le domande del lettore e risponde allestesse

11

Problemi a livello Paragrafo e Frase

Stile

12

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

13

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

14

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

15

Frase originale Frase riscritta

Lo scopo di questa tesi è di cercare disviluppare e verificare un modello per …

Questa tesi sviluppa e verifica un modello per …

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 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-guidamantenere soggetto e verbo sulla stessa linea.

• Non usare la doppia negazione --

16

Tabelle, figure e grafici

17

Tabelle, figure, grafici (esempi)

18

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 scopodel documento. 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.19

Struttura di una proposta e di un rapporto

Struttura dei Documenti “Tecnici”

20

Fonte: governmentproposalwriters.com

Struttura dei Documenti

• Sintesi / Summary -- a brief summary of the whole

• Introduzione / Introduction -- defines yourproblem.

• Contesto / Background -- shows how your

21

• Contesto / Background -- shows how your solution is likely to solve the problem.

• Metodi / Methods -- outlines your solution

• Conclusioni / End stuff -- details, schedule, costs

Struttura della Proposta/Proposal

• Because text is linear and finite, it has a beginning a middle and an end. This structure is maintained at every level of text: the word, the sentence, the paragraph, the section, and the document as a whole.

• Many structures are possible. The right organization is the one that best fits the purpose.

22

one that best fits the purpose.

• Give every document a title. In the introduction section of longer documents, be sure to introduce the structure and content of the rest of the document.

• Struttura della Proposta

• Struttura del Rapporto

Struttura del Rapporto/ Report

• Sintesi/Abstract -- a summary of the problem, methods, results, and conclusions.

• Introduzione/Introduction -- defines your problem.

• Contesto/Background -- shows how your solution is likely to solve the problem.

23

to solve the problem.

• Metodi/ Methods -- outlines your solution.

• Risultati/ Results

• Conclusioni/ Conclusions

Valutazione Documento 1/2

24

Valutazione Documento 2/2

25

Contenuti parte 3 di 3

� Scrivere per il Web

� Comunicazione Orale

� Valutazione Presentazioni

� Sintesi finale

26