Cm - Scrivere Una Relazione Tecnica

8/17/2019 Cm - Scrivere Una Relazione Tecnica

1/14

Come si prepara una relazione tecnica(alcune raccomandazioni)

Dipartimento di Ingegneria meccanica e aerospaziale

Politecnico di Torino

Perché presentare una relazione

Per comunicare i propri risultati

Una buona relazione è anche esteticamente “piacevole” Dà una migliore impressione degli autori

Comunica in modo più efficace le informazioni che si devono

trasmettereLa relazione tecnica dunque deve trasmettere informazioni:risultati di calcolo o di misure, elaborazioni, etc...

Costruzione di macchine 2


2/14

Prima di … scrivere

Quale è il tuo messaggioInformazioni tecniche (tante/poco)

Controversia

ecc. …

A chi è diretta la vostra relazione Accademico o industriale

Altri ingegneri

Managers

Gestionali

Operatori

Misto


Contenuti della relazione

Frontespizio - Titolo

Sommario

Indice, indice delle tabelle, delle figure

Introduzione

Descrizione del problemaProcedure di calcolo

Risultati

Analisi dei risultati / discussione

(Conclusioni)

Bibliografia

(Appendici).

Disegni (Complessivo e particolare)



3/14

Frontespizio - Titolo


Titolo del progetto

Autori:

Tizio Primo

Caio Secondo

Sempronio Quinto

Logo con riferimenti

Titolo

Autori

Data, luogo, etc...

Corso di Laurea Magistrale in Ingegneria meccanica

Corso di Costruzione di macchine

Torino, 30 maggio 2099

Contenuti

L’indice deve essere sempre presente (consigliabileall’inizio del documento)

L’introduzione deve presentare i contenuti del lavoro

Eventuali appendici conterranno

Grafici ripetitivi di numerose proveDocumentazione da fonti esterne

Trattazioni pesanti non essenziali ai fini del testo



4/14

Sommario

Perché é importante?Quello che la maggioranza delle persone legge

Cosa è necessario dire50 – 200 paroleRiepilogo dello scopo, obiettivi, metodi, risultati, limitazioni, iprincipali risultati, raccomandazioni

Scritto in modo tale da poter essere letto indipendentemente dallarelazione

Solitamente la parte più difficile da scrivere


Introduzione

Introduce il lettore nel report

Identifica il problema a risolvere

Fornisce tutte le informazioni di base necessarie

Formato: stato dell’arte – obiettivo - scopo



5/14

Svolgimento del progetto

Devono essere descrittiIl sistema da progettare / verificare

Il modello del sistema da progettare / verificare

Le ipotesi di base

Le procedure di calcolo

I risultati dell’analisi


Procedure di calcolo e Risultati

Assicurarsi che i calcoli siano ben presentati. Lo scopo deicalcoli nella progettazione tecnica è non solo di verificare cheun disegno sia accettabile, ma anche di fornire unadocumentazione chiara in modo che un ingegnere, che nonha familiarità con questo progetto, possa riprodurre everificare i calcoli di progetto.Prendere nota di quanto segue nella preparazione calcoli:

Rappresenta la parte centrale del report.

Usare passi logici organizzati in diversi paragrafi.

Dichiarare e discutere chiaramente la validità di tutte leipotesi principali.

Indicare chiaramente lo scopo di ogni calcolo (cosa si vuolottenere?).



6/14


Specificare tutte le relazioni principali e indicare iriferimenti a meno che questi non siano comuni (adesempio: F = m·a )

Definire tutte le notazioni utilizzate e fornire gli scheminecessari per garantire che il lettore sappiainequivocabilmente quello che si vuol dire

Evidenziare i risultati principali

I risultati devono essere sempre esaminati, analizzati,commentati e discussi in modo critico

Evitare la ripetizione delle stesse informazioni se non incasi particolari (ciò che si vede in una tabella non si vededi solito in un grafico e viceversa)

Evitare di riportare formulazioni inutili, passaggi inutili etabelle, testi e grafici reperibili in riferimenti bibliografici



Evitare assolutamente di riportare un numero di cifredecimali non coerente con le ipotesi di base e con laprecisione dei dati noti (evitare di dire: ma il risultato lo daExcel , Matlab o programma di calcolo xyz )



7/14

Bibliografia

Alla fine del report

Inserire secondo le normative


Unità di misura

Esiste uno standard internazionale: il SI

Prescrive come debbano essere scritte le unità di misura,multipli e sottomultipli



8/14

Errori inaccettabili

kg KgCostruzione di macchine 15

Nota: Kg significa kelvin × grammo (che non ha ovviamente alcun senso)


km KmCostruzione di macchine 16

Nota: Km significa kelvin × metro (che non ha ovviamente alcun senso)


9/14


123 [kg]123kg 123 kg

123 kgCostruzione di macchine 17

Nota: le parentesi quadre hanno il significato di “le dimensioni di” e si

mettono attorno ad una variabile non un’unità di misura

Ovvero: la versione più semplice…

Perché conformarsi allo stile corretto discrittura

Evitare confusioni!Km vuol dire kelvin × metro (non kilometro, idem per Kg) che nonha ovviamente alcun senso: in alcuni contesti può dare luogo aderrori

Scrivendo una parola in modo errato si rischia di non trovare (o

essere trovati) dagli algoritmi di ricerca elettronici (ricordo ancoraquel tizio che non trovava in alcun modo il manuale del suo stereo “tecnics”)

Se è cosa di poco conto, cosa costa farla bene?In fondo scrivere “kHz” (corretto) piuttosto che “Khz” (errato)cosa cambia? Devo comunque battere tre caratteri



10/14

Stile di scrittura

Occorre impiegare uno stile “tecnico” di struttura

Evitare lo stile romanzato o descrittivo (per esempio di tipo

sequenziale)Non eccedere nella sintesi (occorre spiegare e far capirecosa si è fatto)

Usare un linguaggio tecnico appropriato (proprietà dilinguaggio)


Proprietà di linguaggio: esempio

Nel linguaggio tecnico raramente un termine può essereimpiegato in sostituzione di altri

Barra, asta, trave, albero, asse... sono tutti termini chefanno riferimento a oggetti simili (un solido con una

dimensione molto maggiore delle altre) ma ognunodifferente dagli altri funzionalmente o costruttivamentePer esempio un “albero” è soggetto a momento flettente etrasmette momento torcente, mentre un “asse” è solamentesoggetto al momento flettente



11/14

Stile e correttezza di scrittura

Non usare termini stranieri se esiste l’identicocorrispondente termine in lingua italiana

“stress” è la traduzione esatta in tutti i sensi di “tensione”, “strain”corrisponde esattamente a “deformazione”

Quando la locuzione inglese non ha un esatto equivalenteitaliano o è molto più compatta conviene usare il terminein lingua

“strain-rate” si traduce “velocità di deformazione” che è moltomeno sintetico


Grafici

Devono essere curati, di buona qualità, leggibili


-0.001

0

0.001

0.002

0.003

0.004

0.005

0.006

0.007

0 100 200 300 400 500 600

F (Hz)

A ( m m )

Series1

0

0.001

0.002

0.003

0.004

0.005

0.006

0.007

0 100 200 300 400 500 600Frequenza, f (Hz)

A m p i e z z a ( m

m )

Caratteri illeggibili, espressioni sulle scale non immediatamente comprensibili,

formato della curva non adatto, colori ed altri elementi grafici non appropriati o

sconsigliabili


12/14

Grafici


0

2

4

68

10

12

0 2 4 6 8 10

x

y

0

2

4

6

8

10

12

0 2 4 6 8 10

x

y

0

2

4

6

8

10

12

0 2 4 6 8 10

x

y

0

2

4

68

10

12

0 2 4 6 8 10

x

y

Curva che rappresenta il fenomeno

che si sta studiando Rappresentazione corretta

No: i segmenti curvilinei mostrano un

andamento inesistente

No: anche segmenti di raccordo rettilinei fra pochi

punti fanno prevedere un andamento non reale

Ultime raccomandazioni

Non consegnare MAI un documento non rilegato in unaqualsiasi maniera

Inserire i numeri di pagina sui fogli sui documenti che

contengono più di pochissime pagine



13/14

Infine...

PASSARE IL CORRETTORE

ORTOGRAFICO PRIMA DISTAMPARE E CONSEGNARELA RELAZIONE!


Ancora...

Consultare ilmanuale: “Saper comunicare”di C. Beccari et al.


http://didattica.polito.it/tesi/

SaperComunicare.pdf


14/14

Ancora...

Assistenza alla stesura della relazione e degli elaborati grafici

A causa del gran numero di studenti in corso, si suggerisce

quanto segue:Frequentare assiduamente le esercitazioni. Durante questoperiodo il docente e i coadiutori saranno a disposizione perrispondere alle domande.

Fare domande durante la lezione.

Possono essere organizzati consultazioni per singolesquadre. In tal caso inviare una e-mail al coadiutore di

riferimento e al docente.Nella e-mail, identificare correttamente il problema.


Cm - Scrivere Una Relazione Tecnica

Documents

Transcript of Cm - Scrivere Una Relazione Tecnica