Scrittura Tecnica

Materiale di riferimento:

dispense “Saper comunicare”

Politecnico di Torino, edizione 2003

Presentazione a cura di G. Dodero, settembre-ottobre 2004

Laboratorio Specialistico 1

Perché Scrittura Tecnica?

n Perché leggere è un lavoro!

n Comunicare concetti precisi

n Usare il minimo dispendio di parole

n Includere tabelle, grafici, formule, elenchi puntati o numerati….

In ogni caso occorre COMUNICARE:

Un messaggio va espresso diversamente a seconda del destinatario

n Dirigente

n Tecnico

n Utente non tecnico, cliente

Essendo un discorso tecnico, occorre attenersi a normative (quando esistono)

n Unità di misura, UNI-EN, ISO, ecc

n Regolamenti interni aziendali

n Documenti analoghi “ben fatti”

Scrivere una LETTERA:

n Indirizzare all’ente-azienda + “all’attenzione di”

n Specificare l’indirizzo del mittente (oppure carta intestata aziendale)

n Riportare tutti i riferimenti, numeri di protocollo ecc.

n Oggetto

n Una formula di apertura il più semplice possibile

Gentile signor Bianchi,

Egregio Ingegnere,

con il TITOLO ESATTO (dott-ing-rag-…)

n Il testo della lettera deve trattare UN SOLO ARGOMENTO e spesso conterrà un solo capoverso o due.

(se mettiamo insieme diversi argomenti, complichiamo il lavoro al destinatario, che potrebbe non essere competente per tutti quanti!)

n Una formula di chiusura ed eventuale ringraziamento, anch’essa semplicissima

Con i migliori saluti

DA EVITARE ASSOLUTAMENTE

n Piaggeria

n Burocratese

n Commercialese

Esempio di lettera mal fatta:

GROfficina Meccanica Via Alba, 100 — 10095 Rivoli tel. 958 00 00

Egregio Rettore del Politecnico

Torino

Il sottoscritto si rivolge alla S.V. Ill.ma perché deve far tarare il manometro con scala da 0 a 100 ate quì allegato e prega pertanto di trasmetterlo al laboratorio che se ne può occupare

Vorrei con l’occasione chiederLe di farmi inviare i programmi dei corsi di diploma e cioé della cosidetta laurea breve, di cui ho sentito parlare sui giornali, che interessano a mio nipote.

Avendo infine sentito parlare del COREP, pregasi mandarci notizie sulla sua attività/.

Cordialmente

G. Rossi

Rivoli, 15 novembre 1993

1. Non si scrive Egregio Rettore!

2. Contiene tre argomenti, di competenza di tre uffici diversi

3. SV Ill.ma, poi lei, poi impersonale: stile confuso!

4. Il sottoscritto, io, noi: chi è l’autore?

5. Non c’è un Oggetto (ce ne sono tre!)

6. Errori di ortografia, punteggiatura e accentazione

Una lettera migliore è la seguente:

Scrivere una email al posto di una lettera??

Attualmente si può fare, ma occorre rispettare le stesse regole di cui sopra:

n oggetto della email (occhio ai filtri antispam)

n identificarsi ed identificare il destinatario

n SALUTARE E FIRMARE

Si può fare poi un reply allegando (sotto) l’email originaria, ma è meglio evitare di fare messaggi con 5-6 Re: lunghi 120K solo per aggiungere una riga!

Scrivere una relazione tecnica

n Perizia o collaudo (destinatario esterno)

n Rapporto tecnico, documentazione di un progetto (destinatario interno)

n Prova finale o tesi di laurea (destinatario interno)

n Manuale d’uso (destinatario esterno)

Caso particolare, scrivere un curriculum

(dovreste averlo appreso a Cultura Aziendale!)

Attenzione: il curriculum DEVE essere accompagnato da una lettera di autopresentazione, che deve essere “personalizzata” a seconda del destinatario (spesso deve essere adattato anche il CV!).

Trovate diversi esempi nelle dispense, da seguire e da evitare!

Esporre una relazione tecnica

n Seminario didattico

n Presentazione (a colleghi, a clienti, a superiori)

n Prova finale/Tesi

Preparazione:

n informarsi del tempo a disposizione e dell’attrezzatura disponibile (lavagna, proiettore, pc, software, periferiche)

n preparare lucidi (se possibile con appositi software, altrimenti “a mano”)

n provare la durata del discorso e se si sfora riorganizzare il materiale!!!

I lucidi

n Se si usano trasparenze, ricordarsi che lo schermo è quadrato

n Massimo 10 righe per lucido con font almeno 20 pt

n Sfondo leggibile

n Non esagerare con marchi e loghi aziendali

n Non esagerare con animazioni

(un pochino suscita interesse, troppo distrae)

Font 16

Font 18

Font 20

Font 22

Caso particolare, la presentazione di una tesi:

n cosa si voleva ottenere

n come lo si è fatto (a grandi linee)

n cosa si è ottenuto

Preparazione di un rapporto tecnico

Un lavoro eccellente presentato male non viene valutato quanto merita

Un lavoro mediocre presentato bene può facilmente “superarlo”!

Curare una presentazione ha implicazioni

· Letterarie

· Strutturali

· Grafiche

Le regole che elencheremo (anche attraverso esempi) dovrebbero essere già note, ma in pratica spesso non sono applicate dagli studenti (e non solo)

Strutturazione

Ogni scritto tecnico deve essere strutturato!

Dal generale al particolare, troveremo

· Parte (Part)

· Capitolo (Chapter)

· Paragrafo (Section)

· Sottoparagrafo (subsection)

· Sotto-sottoparagrafo (sub-subsection)

· Capoverso (paragraph)

A seconda della dimensione e del contenuto una di queste suddivisioni potrebbe non esserci

· nella tesi difficilmente si suddivide in parti, ma soltanto in capitoli

· un paragrafo di 10 righe non si divide in sottoparagrafi

Tutte queste entità devono essere numerate in maniera gerarchica e dotate di un titolo,

fanno eccezione certi capitoli “speciali” come la Bibliografia, e i capoversi che in genere non si numerano.

La stesura del rapporto comincia scrivendo l’indice e strutturandolo.

Esempio (tabella 2.1 pagina 15)

Le norme ISO prevedono un elenco di

· Figure

· Tabelle

· Simboli

Se vi abituate è meglio, ma non è obbligatorio.

Fatto l’indice, si passa alla scaletta, ovvero elencare più in dettaglio cosa si inserisce in ogni elemento.

Naturalmente si cambia la struttura se mentre si approfondiscono i vari punti si trova una migliore organizzazione!

Avere un indice

· consente di NON scrivere necessariamente i capitoli nell’ordine,

· evita di ripetere un concetto più volte,

· evita di utilizzare concetti definiti dopo l’uso

Un indice NON e’ un diario

· evitare di esporre stile cronologico (cap.1=lavoro fatto ad aprile; cap. 2=lavoro fatto a maggio ecc.)

· non inserire le alternative esplorate e poi scartate se non in apposite sottosezioni (deve essere chiaro di cosa si parla!)

La regola aurea:

ogni scritto (ed ogni parte dello scritto) si divide in tre parti:

· introduzione,

· svolgimento,

· conclusione.

SE NON CI RIUSCITE ci potrebbe essere un problema

(es. nella suddivisione, o nella vostra comprensione del contenuto!!!)

In uno svolgimento tecnico

· si inizia con un capoverso che espone il concetto chiave,

· lo si motiva nei capoversi successivi,

· si conclude con un capoverso conclusivo.

Le parti più tecniche e più corpose vanno a finire nelle appendici:

· dimostrazioni di teoremi

· strutturazione in pseudocodice,

· listati,

· calcoli, uscite del programma, ecc.

Il Sommario

Serve a far comprendere se il documento deve essere letto tutto o no. Normalmente da 250 a 500 parole, senza figure o tabelle.

L’Introduzione

Deve contenere

· Oggetto

· Obiettivi

· Relazione con altri lavori

· Metodo

Non deve contenere

· Il sommario

· Teoria

· Metodo

· Risultati

· Conclusioni

Può concludersi con un breve riassunto dei capitoli seguenti.

Corpo del rapporto

· Destinato ad un esperto della materia, non deve contenere “cose note”.

· Rimanda i dettagli tecnici alle appendici.

· “una figura vale più di mille parole”

Il resto dipende dai casi…

Conclusioni

In genere è un capitolo molto breve

· Confronto tra scopi e risultati ottenuti

· Commento critico dei risultati

· Commento sulle parti non approfondite

· Sviluppi futuri possibili

Appendici

· Dimostrazioni matematiche

· Listati dei programmi

· Tabulati, tracciati di strumenti, tabelle di misure ecc.

Bibliografia

· In ordine alfabetico per autore ed anno [Gianuzzi 2004]

oppure

· In ordine di citazione [1]