Académique Documents
Professionnel Documents
Culture Documents
Introduzione
Nel seguito sono riportate alcune indicazioni di massima circa la stesura di una
relazione tecnica, in merito alla struttura sua propria, alle sequenza dei capitoli
e agli stili tipografici da utilizzare.
Si tratta evidentemente di semplici indicazioni, cui ciascuno può apportare le
modifiche che ritiene opportune, aggiungendo o rimuovendo parti ove del caso,
ferma restando la struttura generale riportata.
La trattazione viene eseguita analizzando pagina dopo pagina, come si
presentano nella
sequenza della relazione ultimata e stampata.
Logica generale
Il presente documento si sviluppa attorno a una logica ben espressa nel
paragrafo che segue:
“...La scrittura tecnico–scientifica è quel genere di prosa che si usa per comunicare ad altri i
concetti in modo preciso, senza ambiguità, con il minimo di dispendio di parole; spesso il testo
è accompagnato da formule, tabelle, diagrammi e altri mezzi grafici o numerici per rendere più
facilmente recepibile il messaggio che si vuole trasmettere. Il lettore della prosa tecnico–
scientifica non legge per divertirsi o per passare il tempo in modo creativo, ma per acquisire le
informazioni che cerca con il minimo di dispendio di tempo ed energia; per lui quella lettura è
un lavoro, non uno svago. È quindi molto importante che lo scritto tecnico–scientifico trasmetta
il messaggio in modo efficiente ed efficace. Efficiente perché deve trasmettere il massimo di
informazione con il minimo di parole, efficace perché deve trasmettere il messaggio in modo
valido, senza ambiguità e con il dettaglio necessario per le esigenze del lettore. ...”
1
Strutturazione
La struttura generale di una relazione tecnica contiene una serie di parti che
necessariamente devono essere presenti, di seguito riportate (le parti indicate
fra parentesi sono da intendersi come opzionali):
frontespizio
2a pagina: vuota, bianca
introduzione
oggetto della relazione
descrizione della soluzione adottata
descrizione del percorso di soluzione
(possibili varianti)
(integrazioni)
conclusioni
sitografia e bibliografia
sommario/indice
(allegati)
Nella trattazione che segue si forniscono indicazioni relative a ciascuna parte di
cui sopra.
frontespizio (pagina 1)
La pagina 1 comprende indicazioni di massima circa il titolo dell'opera, l'autore
e il committente.
E' la copertina della relazione tecnica stessa.
In tal senso è buona norma che si presenti senza particolari fronzoli, priva di
colori sgargianti o figure sgranate. Dal momento che presenta la relazione
stessa è opportuno che sia sobria, personalizzata, esplicativa.
A livello stilistico:
titolo → con carattere sufficientemente grande, con allineamento
centrato, disposto a metà pagina, più o meno
committente → chi ha commissionato l'opera (nel caso di una relazione
scolastica indicare l'istituto, la materia, il docente di riferimento)
progettista/relatore → l'autore della relazione tecnica (COGNOME e Nome)
E' utile riportare il logo dello studio tecnico (o della scuola, in ambito scolastico,
e la classe in tal caso).
La pagina 1 è rigorosamente priva di numero di pagina.
Per rimuovere il numero di pagina dalla prima (e seconda) pagina si veda:
openoffice/libreoffice:
◦ http://tinyurl.com/z4zuqnu
◦ http://tinyurl.com/j8jtyfq
Microsoft Office:
◦ http://tinyurl.com/jsdoaxn
◦ http://tinyurl.com/zpzmtw5
2
2a pagina
Per questioni per lo più tipografiche la pagina 2 è lasciata bianca, senza
numero di pagina. Per rimuovere il numero di pagina si veda al punto
precedente.
introduzione
Dalla pagina 3 comincia la relazione tecnica vera e propria, di cui la prima
sezione è tassativamente una introduzione generale.
Nell'introduzione si riporta in termini volutamente generici l'oggetto del lavoro:
ha lo scopo di consentire al lettore di inquadrare il discorso senza dover leggere
l'indice o, peggio, tutta la relazione stessa per comprenderne a grandi linee il
contenuto.
Una buona introduzione non supera le 3000 battute, all'incirca mezza pagina o
poco più.
Dalla pagina 3 la numerazione ha inizio, con numerazione che comincia da 3
(vedasi ai punti precedenti).
Per le indicazioni stilistiche circa questa e le successive parti si veda al
paragrafo dedicato, più avanti nel presente documento.
oggetto della relazione
Si descrive dettagliatamente la richiesta, l'oggetto del lavoro, e gli obiettivi che
ci si è prefissi e/o sono stati richiesti. Può essere utile inserire un disegno, uno
schema, delle tabelle che aiutino la comprensione dell'obiettivo o dell'oggetto
della relazione tecnica.
Una relazione tecnica relativa al dimensionamento meccanico di un cancello
automatico potrebbe presentare nell'introduzione uno schema di massima dei
punti di vincolo del cancello stesso nel contesto edilizio in cui è inserito, per
esempio.
descrizione della soluzione adottata
Contrariamente a quanto si è naturalmente portati a fare, si comincia...dal
fondo, dai risultati. Dovendo descrivere il lavoro svolto comunemente si pensa
che sia buona cosa spiegare per bene i vari passaggi cronologici compiuti;
mettendosi invece dal punto di vista del committente che desidera conoscere il
risultato o la soluzione l'aspetto cronologico è assolutamente da evitare, per lo
meno in questa sezione.
Si riporta invece direttamente il risultato ottenuto/proposto: il disegno finale, o
il riferimento al'eventuale allegato, il risultato dei calcoli, con schemi e tabelle,
insomma tutte le indicazioni necessarie a inquadrare da subito a quali
conclusioni tecniche si è giunti.
descrizione del percorso di soluzione
In questa sezione si analizzano i vari passaggi che conducono alla soluzione
proposta.
Di nuovo è importante evitare una sequenza di natura cronologica (prima si è
studiato..., poi si è fatto..., poi...) che appesantisce il discorso focalizzandolo sul
percorso e non sul risultato.
E' invece importante riportare tutto ciò che si ritiene necessario ed essenziale
alla comprensione e alla replica del risultato stesso
3
dati di partenza: benché possa apparire una ripetizione del paragrafo
soprastante è opportuno riportare le condizioni di partenza, i valori
iniziali, la situazione pre-esistente (a seconda dei casi)
risultati ottenuti: di nuovo, anche questa sezione può apparire come
una ripetizione di paragrafi di cui sopra. Per evitare questo effetto può
essere utile utilizzare tabelle e schemi, per sintetizzare. In ogni caso è
molto utile riportare consecutivamente gli uni rispetto agli altri dati e
risultati, dal punto di vista della comprensione del percorso di soluzione
semplifica il discorso
percorso per ottenere i risultati: finalmente, la descrizione del
percorso diretto che a partire dai dati di partenza conduce ai risultati
ottenuti; evidentemente tutte le eventuali strade alternative intraprese,
specialmente quelle che si sono rivelate infondate, erronee oppure prive
di risultato non vanno riportate
teoria / legislazione / norme: riportare in questa sotto-sezione i
riferimenti teorici e normativi che consentono di ottenere il risultato di cui
sopra
calcoli: riportare i calcoli effettuati, sottolineando i soli passaggi
essenziali, tralasciando i passaggi algebrici elementari
discussione dei risultati: questa sotto-sezione è estremamente
importante: in essa si analizzano criticamente i risultati ottenuti, ponendo
in luce i punti di forza e di debolezza della soluzione ottenuta,
accennando dove del caso a possibili soluzioni alternative, giustificando i
risultati stessi
La strutturazione in sotto-sezioni descritta può essere utilizzata tale e quale, o
rimaneggiata dallo scrivente in funzione delle specifiche necessità della
relazione tecnica in essere.
Si ribadisce tuttavia il fine di questa sezione, che risiede nella descrizione
dettagliata del percorso di soluzione a partire dai dati di partenza fino al
risultato, un po' come una ricetta di cucina.
possibili varianti
Come accennato nel paragrafo precedente, spesso in ambito tecnico emergono
una molteplicità di soluzioni al problema commissionato che spesso
approssimano solamente la richiesta in maniera più o meno buona.
Descrivere una o più possibili varianti alla soluzione può rappresentare un
punto di forza in termini di credibilità rispetto al committente; in ogni caso la
descrizione delle stesse, con il medesimo schema dati-risultati-percorso, non
deve dilungarsi eccessivamente, se non espressamente richiesto.
integrazioni
Su alcuni punti specifici può essere utile ricavare all'interno della relazione
tecnica un paragrafo, il presente, in cui approfondire alcuni aspetti
particolarmente importanti o specifici, la cui trattazione nei paragrafi
precedenti distoglierebbe l'attenzione dall'obiettivo. Tali integrazioni possono
riguardare la modalità di taratura di un sensore, la descrizione dettagliata di un
materiale utilizzato, la descrizione di una tecnica di calcolo, un software
specifico utilizzato o potenzialmente utile.
4
conclusioni
Le conclusioni si presentano in modo molto simile all'introduzione: non
prevedono un contenuto dettagliato e specifico, bensì fanno da commento e
chiusura al discorso. Anche in questo caso al più mezza pagina è più che
sufficiente, di solito.
documentazioni allegate
Allegati: posso comprendere i dati tecnici di uno o più componenti
utilizzati (cuscinetti, trasduttori, materiali), utili al fine di poter riprodurre
i lrisultato in un secondo momento
Tavole: le tavole CAD (se presenti) della soluzione adottata, esplicative
della soluzione stessa
bibliografia
La bibliografia rappresenta l'elenco delle opere letterarie la cui consultazione
ha consentito la realizzazione della soluzione indicata dalla relazione tecnica
stessa. Attraverso le note bibliografiche è possibile, in un secondo momento,
ricostruire tutto il percorso teorico che ha condotto al risultato, anche a
distanza di anni, quindi è opportuno riportare non tanto e non solo il titolo del
libro utilizzato quanto piuttosto il capitolo e la/le pagine del medesimo,
riportando anche in quale contesto del lavoro sono state utilizzate.
Es.:
sitografia
Ha la medesima funzione della bibliografia, ma fa riferimento ai siti web. E'
importante, come sopra, riportare il link e la motivazione, il contesto di
consultazione del medesimo.
Per rendere esteticamente migliore l'impaginazione può essere utile fare
ricorso ai servizi di abbreviazione dei link (URL shortener, in linguaggio tecnico:
si veda al riguardo http://www.html.it/articoli/abbreviare-url-bitly-e-googl/ ).
E' assolutamente da evitare riportare nella sitografia indicazionicome le
seguenti:
Google.com
wikipedia
5
libero.it
che inducono al sorriso in ambito scolastico (“hai letto tutto google???”) ma
alla scarsa credibilità in ambito professionale.
Correttamente si potrebbe riportare:
6
Si tratta di un software commerciale molto potente e diffuso, installato sui
calcolatori della scuola, che prevede solitamente un costo di licenza.
Si trovano in Rete una infinità di modi per ottenere senza costi una licenza di
utilizzo: ciò è praticamente sempre illegale ed è buona norma evitarli, sia per
evitare di incorrere in problemi di sicurezza informatica (virus, malware, trojan)
per il proprio calcolatore, sia per gli aspetti legali, a maggior ragione se nel
contesto di una azienda, sia per semplici questioni etiche circa il diritto
d'autore.
Per una panoramica generale sul pacchetto Office, installazione e relativi costi
si veda:
http://www.microsoftstore.com/store/mseea/it_IT/cat/Office/categoryID.6622670
0
Qui invece alcune indicazioni più generali:
https://it.wikipedia.org/wiki/Microsoft_Word#Versioni_di_Word
Una alternativa all'utilizzo di Microsoft Office con relativi costi di licenza (o sue
violazioni) è rappresentato dal pacchetto OpenOffice e dal suo derivato
Libreoffice. La differenza tra i due risiede, in estrema sintesi, per lo più nella
natura delle licenze con cui sono rilasciati e nella natura di chi si occupa dello
sviluppo degli stessi. In particolare:
7
sballati, caratteri non riconosciuti.
Tali problemi non si presentano solamente come incompatibilità tra Microsoft
Office e OpenOffice/Libreoffice, ma anche all'interno del mondo Microsoft
soprattutto dopo l'introduzione dei nuovi formati “docx”, non retro-compatibili.
Si consiglia pertanto, una volta sistemata l'impaginazione della relazione
tecnica, di effettuare il salvataggio e poi di esportarla in formato PDF, che
consentirà (quasi) nella totalità dei casi di ottenere la medesima
visualizzazione anche su piattaforme diverse (Android, Microsoft, Linux, MacOS,
ecc.).