La Relazione Tecnica La Relazione Tecnica Caratteristiche comunicative, strutturali, linguistiche IBM Learning

Contenuti Che cosa è una Relazione Tecnica La Struttura Le Sezioni La Relazione Tecnica La Relazione Tecnica Contenuti Che cosa è una Relazione Tecnica La Struttura Le Sezioni La Bibliografia Il Layout I Titoli Grafici, Immagini e Tabelle Consigli sullo Stile 19 settembre 2018 IBM Learning

Che cosa è una Relazione Tecnica La Relazione Tecnica Che cosa è una Relazione Tecnica E’ un testo Comunica informazioni in merito ad uno o più argomenti Ha uno scopo prevalentemente informativo 19 settembre 2018 IBM Learning

Che cosa è una Relazione Tecnica Esempio: Il responsabile di un progetto applicativo illustra tutte le peculiarità di una nuova applicazione al capo dell’unità che ne ha richiesto lo sviluppo. 19 settembre 2018 IBM Learning

Che cosa è una Relazione Tecnica Se il capo-progetto ponesse a confronto due tipologie di applicazioni, ancora da sviluppare, al fine di ottenere un parere su quale delle due sia la più efficace/rispondente alle aspettative dell’unità richiedente: scopo valutativo 19 settembre 2018 IBM Learning

Che cosa è una Relazione Tecnica Qualora il capo-progetto provasse a far cadere la scelta sull’applicazione da lui considerata più idonea, adducendo una serie di motivazioni e ragioni a sostegno della sua tesi scopo argomentativo 19 settembre 2018 IBM Learning

Caratteristiche di una Relazione Tecnica Lunghezza media o lunga Rivolta a persone poco note o sconosciute Ambito lavorativo spesso differente da quello del relatore: necessarie info aggiuntive Dovrà essere utilizzato un lessico appropriato 19 settembre 2018 IBM Learning

La Struttura Quattro sezioni principali: Sezione Iniziale: comprende i blocchi paratestuali Introduzione: si anticipa e si inquadra l’argomento centrale del testo Corpo: analisi del tema e trasmissione dell’informazione fondamentale Conclusione: si riassumono i punti trattati 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale La sezione iniziale: lettera di trasmissione frontespizio indice elenco tavole e figure abstract / executive summary 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Lettera di trasmissione: è una breve presentazione della relazione presso il destinatario ne spiega l’oggetto e le ragioni della sua stesura presenta i punti chiave del documento indica la disponibilità dell’estensore a fornire tutti i chiarimenti necessari 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Frontespizio: titolo del rapporto nome del relatore o del gruppo che ha lavorato alla stesura del documento l’associazione/impresa a cui i redattori fanno riferimento e il loro recapito data di stampa (in calce) 19 settembre 2018 IBM Learning

Relatore/i (con qualifica) Relazione Tecnica – Sezione Iniziale Logo società Titolo Modello di frontespizio Relatore/i (con qualifica) Data di stampa 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Indice Elenco dei titoli dei capitoli, dei paragrafi e dei sottoparagrafi con relativi numeri di pagina Alcuni sono sintetici (capp. e parr. solo di I e II livello); mentre altri sono molto più analitici (riproducono l’intera struttura del documento) 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Segue: Indice Titoli più informativi possibile Es: invece di “Introduzione”...: Introduzione: sviluppo di un’applicazione per il calcolo della NSI 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Abstract i Introduzione: scrivere da professionisti 3 Cap. 1 - La scrittura tecnica: sfide ed opportunità 4 Paragrafo 1: la sfida della funzionalità 7    Paragrafo 2: la sfida della chiarezza 10    Paragrafo 3: la sfida dell'usabilità 14    ... … Conclusioni: l'importanza della formazione 20 Appendice: i dati sui corsi in Italia 25 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Elenco delle tavole e delle figure Lista di tutti i sussidi visivi inclusi nel documento Tavola: immagine a tutta pagina Immagini/figure: grafici, diagrammi o fotografie incluse all’interno del testo Se tavole e immagini sono molto poche il loro elenco è generalmente omesso 19 settembre 2018 IBM Learning

pensato per categorie specifiche di lettori Relazione Tecnica – Sezione Iniziale Abstract / Executive summary Abstract : riassunto degli elementi informativi e valutativi più rilevanti del documento, che include le raccomandazioni eventualmente presenti Executive summary : versione meno sintetica dell’abstract che in molti casi ha la funzione di evitare la lettura dell’intero rapporto pensato per categorie specifiche di lettori (dirigenti) interesse verso “disinteresse” per aspetti economici e finanziari aspetti scientifici o tecnici 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Iniziale Esempio di abstract “In questo documento si analizza il processo attraverso cui è possibile arrivare alla preparazione di un documento tecnico efficace e funzionale. La prima parte inquadra l’argomento e dà alcune indicazioni generali e preliminari; le parti centrali, invece, trattano ciascuna delle fasi che compongono il processo della scrittura e forniscono vari consigli operativi. L’ultima parte, infine, oltre a presentare un sommario del documento, fornisce alcune indicazioni bibliografiche per eventuali approfondimenti.” 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Introduttiva La sezione introduttiva E’ la prima vera e propria parte del documento e normalmente include le seguenti sottosezioni: Analisi della questione che ha originato il report, con evidenza delle finalità del documento stesso Breve anticipazione dei risultati rilevanti emersi dalla ricerca o dall’analisi di dati  facoltativa Esplicitazione delle raccomandazioni (se la Relazione Tecnica ne prevede)  facoltativa 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Introduttiva Cosa ha originato il report Quali sono i punti sviluppati Anticipazione conclusioni 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Centrale La sezione centrale Comprende le seguenti sottosezioni: Inquadramento del soggetto da un punto di vista storico-evolutivo  facoltativa Analisi della letteratura esistente sull'argomento  facoltativa Indicazione sui metodi seguiti per la raccolta dei dati impiegati nell'analisi  facoltativa Comunicazione dei dati/informazioni Analisi ed interpretazione dei dati/informazioni Conclusioni sulla base delle analisi svolte/info fornite 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Centrale Inquadramento del soggetto da un punto di vista storico-evolutivo 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Centrale Conclusioni sulla base delle analisi svolte 19 settembre 2018 IBM Learning

Relazione Tecnica – Sezione Conclusiva La sezione conclusiva Sezione esterna alla R.T. vera e propria; può comprendere elementi diversi: una o più appendici documentarie (tabulati numerici, trascrizioni di testi legislativi, trascrizioni di interviste, grafici, ecc.) un glossario dei termini tecnici, delle abbreviazioni e delle sigle (più raramente prima del corpo della R.T.) una bibliografia 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia La bibliografia Necessaria per dar credito alle affermazioni contenute nel documento, ma non dimostrate Diversi modi per richiamare i riferimenti bibliografici nel testo: autore-anno alfabetico-numerico numerico 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia Autore-anno E’ il metodo più seguito negli ultimi anni per le citazioni “Per avere garanzia di entrare in sintonia con il nostro prossimo, dobbiamo convincerci delle tecniche di feed-back. <<Feed-back>> è un termine che abbiamo preso dall’inglese e viene impiegato anche da noi (in particolare nell’informatica e nella cibernetica): feedback significa retroazione, reafferenza.” (Birkenbihl 1990: 149 / Birkenbihl 1990, p. 149) 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia Bibliografia per autore-anno : elenco alfabetico dei cognomi+anno di pubblicazione con accanto l’indicazione completa del volume: BIRKENBIHL 1990 Vera F.Birkenbihl, L’arte d’intendersi, Milano, FrancoAngeli editore oppure BIRKENBIHL 1990 : Vera F. Birkenbihl, L’arte d’intendersi, Milano, FrancoAngeli editore NB: in caso di due o più pubblicazioni dello stesso autore, uscite nel medesimo anno, si ricorre a 1990a, 1990b, 1990c… 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia Alfabetico-numerico “Per avere garanzia di entrare in sintonia con il nostro prossimo, dobbiamo convincerci delle tecniche di feed-back. <<Feed-back>> è un termine che abbiamo preso dall’inglese e viene impiegato anche da noi (in particolare nell’informatica e nella cibernetica): feedback significa retroazione, reafferenza.” [3] [3] sarà il posto occupato nella bibliografia dal volume citato: [3] Vera F.Birkenbihl, L’arte d’intendersi, Milano, FrancoAngeli editore (p.) 149 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia Numerico Elenco numerato dei testi, presentati nella bibliografia nell’ordine di citazione Poco professionale e limitativo Utile nei testi di poche pagine e/o a carattere “informale” 19 settembre 2018 IBM Learning

Relazione Tecnica – Bibliografia Inserimento in nota del riferimento bibliografico per esteso Metodo tradizionale Bibliografia finale  elenco alfabetico dei cognomi Testo ricorrente  citazione abbreviata (Es.: Birkenbihl, op. cit., p. 149) “Per avere garanzia di entrare in sintonia con il nostro prossimo, dobbiamo convincerci delle tecniche di feed-back. <<Feed-back>> è un termine che abbiamo preso dall’inglese e viene impiegato anche da noi (in particolare nell’informatica e nella cibernetica): feedback significa retroazione, reafferenza.”² ² Vera F. Birkenbihl, L’arte d’intendersi, Milano, FrancoAngeli editore, 1990, p. 149 19 settembre 2018 IBM Learning

Layout Relazione Tecnica – Layout Il paratesto e la formattazione devono essere curati e rendere più efficace la lettura; devono “guidare gli occhi del lettore” sulla strada da noi prefissata 19 settembre 2018 IBM Learning

Relazione Tecnica – Layout Allineamento “giustificato” Font di uno o due tipi al massimo (uno per corpo del testo e titoli, uno per sezioni specifiche come box, inserti…) Neretto/corsivo per alcune parole-chiave e per titoli Punti elenco coerenti e ben strutturati Blocchi di testo separati da righe vuote al cambio di contenuto informativo … 19 settembre 2018 IBM Learning

Titoli Relazione Tecnica – Titoli Brevi Informativi: indicano quale sia il contenuto della sezione di documento cui si riferiscono non devono limitarsi, se non in alcune sezioni istituzionali, a svolgere solo la funzione di etichette di sezione 19 settembre 2018 IBM Learning

NO !! Relazione Tecnica – Titoli Abstract 1 Introduzione 3 Corpo 5 Paragrafo 1 7 Paragrafo 2 10 Paragrafo 3 14 … … Conclusioni 20 Appendice 25 NO !! 19 settembre 2018 IBM Learning

SI !! Relazione Tecnica – Titoli Abstract 1 Introduzione: scrivere da professionisti 3 Cap. 1 - La scrittura tecnica: sfide ed opportunità 4 Paragrafo 1: la sfida della funzionalità 7    Paragrafo 2: la sfida della chiarezza 10    Paragrafo 3: la sfida dell'usabilità 14    ... … Conclusioni: l'importanza della formazione 20 Appendice: i dati sui corsi in Italia 25 SI !! 19 settembre 2018 IBM Learning

Relazione Tecnica – Organizzazione Pagine L’organizzazione delle pagine Numeri romani per la sezione iniziale (I, II, III, IV, ecc.) Numeri arabi per il corpo del documento e per la sezione finale (1, 2, 3, 4, ecc.) Numeri di pagina collocati a piè di pagina Note non troppo numerose, e poste preferibilmente a piè di pagina Materiale esplicativo o di approfondimento, se non strettamente funzionale al discorso, relegato nelle appendici 19 settembre 2018 IBM Learning

Perchè la parte visuale è importante in una Relazione Tecnica? Relazione Tecnica – Grafici, Immagini, Tabelle Modalità per inserire grafici, immagini, tabelle Perchè la parte visuale è importante in una Relazione Tecnica? Perchè fornisce supporto alla relazione tecnica - quando questa illustri andamenti di valori, compari grandezze differenti, esponga dati numerici - in modo da renderla maggiormente comprensibile ed efficace 19 settembre 2018 IBM Learning

Relazione Tecnica – Grafici, Immagini, Tabelle 10 20 30 40 50 60 70 80 90 2001 2002 2003 2004 Pr. 1 Pr. 2 Pr. 3 % Grafico n. 1: percentuale diffusione dei prodotti 1, 2 e 3 nel quadriennio 2001-2004 19 settembre 2018 IBM Learning

Relazione Tecnica – Grafici, Immagini, Tabelle Stessa pagina in cui vi si fa riferimento Disposizione in linea con il testo Altrimenti alla fine della pagina o, in ultima analisi, alla sua sommità Tabelle/Grafici: Disposizione ottimale è quella in linea col testo 19 settembre 2018 IBM Learning

Relazione Tecnica – Grafici, Immagini, Tabelle Numerazione Didascalia esplicativa Esempi: Tabella n.3: andamenti vendite nazionali II semestre Figura n.5: sezione di cavo elettrico 20 kV (3x185 mm2) 19 settembre 2018 IBM Learning

Relazione Tecnica – Grafici, Immagini, Tabelle 19 settembre 2018 IBM Learning

Relazione Tecnica – Grafici, Immagini, Tabelle 19 settembre 2018 IBM Learning

“Faceva freddo quella sera...” Relazione Tecnica – Alcuni consigli sullo Stile “Faceva freddo quella sera...” L’errore più frequente: non è un romanzo! Le cose importanti vanno dette subito Movimentare il testo, rendendolo più gradevole alla lettura: Usare capoversi, paragrafi, sezioni Ogni paragrafo non dovrebbe superare le 2 facciate (meglio 1) Capoversi separati da spazio Capoverso non > 5 righe Il capoverso potrebbe aprirsi con una frase che sintetizza il concetto principale (e magari in grassetto) 19 settembre 2018 IBM Learning

Relazione Tecnica – Alcuni consigli sullo Stile Supportare il testo tramite utilizzo di immagini, grafici e tabelle L’Indice è fondamentale per la ricerca all’interno del documento: Titoli non troppo sintetici L’Abstract o l’Executive Summary saranno le ultime parti da sviluppare La Conclusione dovrà essere articolata, e costituire un riepilogo dell’intero documento Non dare l’impressione di aver “perso” le ultime pagine della R.T.!!! Chi non legge l’Abstract/Executive Summary, è probabile che faccia un salto alla Conclusione 19 settembre 2018 IBM Learning

Relazione Tecnica – Alcuni consigli sullo Stile Evitiamo gli errori ortografici e sintattici... Rendono il documento poco professionale e ne sminuiscono il valore A volte è più rapido guardare solo “le figure” Grafici, immagini e Tabelle dovrebbero poter essere esplicative del testo: inserire quelle effettivamente significative (le altre in appendice) Il destinatario di una R.T. ha poco tempo per leggere il documento, ma lo vuole comunque corposo e pesante !! Redigere un’Executive Summary efficace Sviluppare una sezione centrale snella, ma rimpinguare l’appendice 19 settembre 2018 IBM Learning

Relazione Tecnica – Alcuni consigli sullo Stile Una formattazione ben effettuata è sinonimo di professionalità Cercare di avere un modello professionale da cui copiare (libri, giornali...) Movimentare il testo Inserire liste puntate (ma non abusarne) Inserire intestazioni Inserire numero pagina Lasciare margini abbastanza ampi Font non troppo grandi (10-12) 19 settembre 2018 IBM Learning

Relazione Tecnica – E QUI CHE COSA NON VA ? 1) Manca il Frontespizio 2) Manca un Indice 3) Manca un Abstract/Exec. Summary 4) Manca una numerazione per i Capitoli 5) Manca la Numerazione Pagine 6) Layout poco movimentato: nessuna lista nessuna parola in neretto/corsivo nessuna riga vuota per separare argomenti 19 settembre 2018 IBM Learning

... saprà già dove cercarle !!! ...per concludere La nostra abilità dovrà essere quella di far sì che chi leggerà la nostra Relazione Tecnica, possa ritenersi ragionevolmente soddisfatto delle informazioni già acquisite, anche nel caso in cui non l’abbia letta per intero. E per quanto riguarda le informazioni non ancora approfondite... ... saprà già dove cercarle !!! 19 settembre 2018 IBM Learning