Come redigere una documentazione tecnica

Da Wikiversità, l'apprendimento libero.
Jump to navigation Jump to search
lezione
Come redigere una documentazione tecnica
Tipo di risorsa Tipo: lezione
Materia di appartenenza Materie:
Avanzamento Avanzamento: lezione completa al 100%.

Nelle scuole superiori, dove è presente un laboratorio, al termine delle esercitazioni viene richiesta una documentazione tecnica. Di seguito i passi da seguire (e le cose da non fare) per produrre una documentazione ben strutturata.

Introduzione[modifica]

Dopo aver sviluppato un progetto (meglio ancora se durante il suo sviluppo) è necessario redigere una documentazione tecnica. Per documentazione tecnica si intende un testo, o altro supporto, cartaceo o multimediale, il quale chiarisca in modo corretto e completo come eseguire e riprodurre la procedura svolta. Va ricordato – inoltre – che la documentazione tecnica è l'unica cosa che l'utente finale possiede per poter riprodurre la procedura descritta. Pertanto, ogni passaggio dovrà essere descritto con la massima cura onde evitare confusioni o incertezze in chi legge.

Bisogna descrivere a parole ciò che si è progettato e realizzato, approfondire e puntualizzare le scelte operate che non sono immediatamente visibili o interpretabili nei documenti allegati e nel prodotto finale che si è realizzato. In sintesi, il lettore deve essere guidato passo dopo passo.

In ambito lavorativo la documentazione serve sia per il committente, sia per gli organi che debbono approvare il lavoro, sia per chi deve poi tradurre in pratica il progetto realizzando l'opera.

Pertanto, la documentazione tecnica è molto più di una semplice formalità. Si tratta non solo di scrivere su quanto si è ideato e progettato, ma di un complemento necessario, utile anche per il tecnico: non sempre il direttore di lavori è lo stesso tecnico progettista, e in ogni caso sono molteplici i tecnici che curano la realizzazione di un progetto.

Questo capitolo è scritto per fornire un primo punto di partenza a chi deve affrontare il problema di redigere correttamente (dal punto di vista tecnico) una documentazione tecnica.

Titolo[modifica]

È la parte più importante della documentazione. Da esso dipende se il lettore proseguirà nella lettura o la scarterà a priori. Deve essere essenziale e – allo stesso tempo – comunicare il più possibile il contenuto che verrà affrontato.

Come esempio utilizziamo il titolo di questo corso:

Come redigere una documentazione tecnica

e – come primo esercizio – si eseguirà l'analisi logica del testo. Comunicare, infatti, è un'arte che richiede molteplici competenze, prima tra tutte la padronanza della lingua in cui si scrive

Come = avverbio
redigere = predicato verbale
una documentazione tecnica = complemento oggetto

In questo titolo, il complemento oggetto è legato direttamente al verbo senza l'uso di preposizioni: così si semplifica la lettura e la comprensione alla frase.

Si sarebbe potuto evitare l'avverbio iniziale? Sì. Il motivo per cui è stato introdotto è per sottolineare che questo capitolo rientra nella categoria dei cosiddetti how-to[1].

Oggetto[modifica]

L'oggetto è da intendersi come un sottotitolo, o meglio come una sua maggiore esplicazione. Sempre relativamente a questo capitolo un oggetto potrebbe essere:

A uso interno dell'Istituto "La mia scuola carissima"

dove il lettore troverà una specifica – o connotazione – ulteriore. Non ci si è ancora calati nei dettagli, ma si sta informando il lettore di cosa ha tra le mani: un manuale rivolto agli studenti dell'Istituto "La mia scuola carissima" su come redigere una documentazione tecnica. Quest'operazione è fondamentale affinché il lettore possa decidere se la documentazione gli interessa oppure no.

Un titolo e un oggetto errati, o fuorvianti, possono sì, indurre alla lettura, ma con l'inganno. Il lettore non utilizzerà più questa fonte di informazioni una seconda volta.

Alcune regole base per la titolazione[modifica]

Si è detto che per ogni documentazione il titolo è fondamentale: è l'elemento che per primo la caratterizza e richiama l'attenzione del lettore riassumendo il senso intero del testo che segue. Se è costruito in maniera sbagliata, il lettore non sarà interessato alla prosecuzione della lettura.

È bene ricordare alcune regole base. La regola principale è quella di garantire nel titolo un'informazione immediata, chiara e univoca. Se si intende titolare la notizia della nascita del figlio di Mario Rossi[2], che si chiamerà Paolo, le vie possibili sono molte. Il titolo più semplice è il seguente:

Mario Rossi è diventato papà[3]

Ovviamente, si possono fare molte variazioni, mantenendo fede ai principi di chiarezza e immediatezza, ma giocando con le parole in modo da rendere più piacevole il titolo:

Fiocco azzurro in casa Rossi
È nato Paolo, festa in casa Rossi
Nuovo nato in casa Rossi, ecco Paolo

È bene – invece – evitare l'errore di una titolazione pomposa, la quale rischia spesso di sviare l'attenzione dalla notizia principale. Un esempio è il seguente:

Festa in casa Rossi per il nuovo arrivato

In questo caso, infatti, il lettore si chiederà: Qual è la notizia? La festa o il nuovo arrivato? E poi: chi è che è arrivato? Un parente che viveva negli Stati Uniti o un bimbo?

La titolazione, per essere completa, ha bisogno in genere di altri due elementi, l'occhiello e il sommario (detto anche – in gergo giornalistico – catenaccio). L'occhiello è la frase che precede il titolo vero e proprio; il sommario è la parte che lo segue. Occhiello e sommario forniscono ulteriori elementi per la comprensione della notizia. Per esempio:

Campi Contenuto
Occhiello Pesa 4 kg, ha i capelli neri e assomiglia alla mamma
Titolo Fiocco azzurro in casa Rossi
Sommario Paolo è nato ieri al Policlinico. Il parto seguito dall'equipe del dott. Stranamore

La titolazione completa, occhiello/titolo/sommario deve fornire un quadro esaustivo delle informazioni che seguiranno. Ovviamente, è possibile – anzi, a livello giornalistico, fortemente consigliabile – inserire elementi di dubbio soprattutto nel sommario, per spingere il lettore a proseguire nella lettura.

La titolazione proposta nell'esempio precedente potrebbe comprendere un sommario di questo tipo:

Paolo è nato ieri sera al Policlinico. E al mattino subito una sorpresa per i genitori

Il lettore si chiederà: una sorpresa per i genitori? Quale sorpresa? E sarà ovviamente spinto a leggere fino a soddisfare la curiosità. La sorpresa per i genitori, in questo caso, potrebbe essere la visita inaspettata da parte di un parente che non si vedeva da vent'anni.

Introduzione[modifica]

Questa è la parte dove si parla dell'argomento ancora con circospezione, cosa che trae in inganno la maggior parte degli studenti. Nell'introduzione – o abstract[4] – ci si focalizza maggiormente sugli aspetti che verranno trattati in seguito, fornendo un quadro esaustivo al lettore. Quanto seguirà dovrà essere riportato nello stesso ordine presentato nell'introduzione.

Supponiamo di dover redigere la documentazione tecnica dal titolo: "Verifica della legge di Ohm".

Cosa scrivere[modifica]

È importante capire quale argomento si andrà a indagare. Quindi è bene ricordare la cos'è la legge di Ohm, a quali contesti si applica, le eventuali formule inverse (se ritenute significative), come verrà impostato il problema – senza scendere troppo nei dettagli, i quali verranno illustrati in seguito – e ogni altra cosa ritenuta utile.

Il tutto utilizzando l'ordine che seguirà nella documentazione. Come anticipato, il lettore deve essere preso per mano e guidato passo dopo passo nella lettura. Non è possibile dare per scontato che conosca i pensieri di chi scrive.

Cosa non scrivere[modifica]

Un esempio di introduzione completamente errata è la seguente:

Georg Simon Ohm nacque in una famiglia protestante di Erlangen, Brandenburg-Bayreuth, (allora parte del Sacro Romano Impero), figlio di Johann Wolfgang Ohm, un fabbro e Maria Elizabeth Beck, figlia di un sarto di Erlangen. Sebbene i suoi genitori non fossero stati educati formalmente, il padre di Ohm era un uomo piuttosto straordinario che si era educato a un alto livello ed era in grado di dare ai suoi figli un'eccellente educazione attraverso i propri insegnamenti. Con tutti i fratelli e le sorelle di Ohm che erano nati egli avrebbe voluto formare una grande famiglia, ma, come era comune a quei tempi, parecchi bambini morirono nella loro infanzia. Dei sette bambini nati a Johann e Maria Ohm solo tre sopravvissero, Georg Simon, suo fratello Martin, che proseguì per diventare un famoso matematico e sua sorella Elizabeth Barbara. Sua madre morì quando Georg aveva dieci anni.[5]

I cenni storici possono essere interessanti solo se hanno ricadute sul modo di condurre l'esperimento scientifico che ci si appresta a compiere o verificare.

Nel caso in esempio, la biografia di Georg Simon Ohm non ha nulla a che vedere con il lavoro che verrà condotto in laboratorio (a meno che non si tratti di un laboratorio di Storia).

Presentazione del problema[modifica]

Ora che è chiaro di cosa si discuterà, occorre chiarire come questo verrà fatto. Probabilmente, ci si recherà in un laboratorio: quale? Questa domanda sembra banale e retorica ma non lo è. Non si è interessati all'aula in sé, ma al suo contenuto, alle attrezzature, ai dispositivi e ai software eventualmente utilizzati.

È bene quindi redigere un accurato quadro riassuntivo degli strumenti e dei materiali che dovranno essere utilizzati per condurre a termine l'esperimento. Riprendendo l'esempio precedente, una elenco potrebbe essere quello riportato nella tabella seguente.

Strumento Tipo Costruzione Modello
Alimentatore Stabilizzato McPower LN–130 pro
Voltmetro Digitale PCE PCE–DM 12
Amperometro Analogico Pierron ML2742

Con una scheda di lavoro di questo tipo, è possibile dotarsi dei medesimi strumenti di misurazione utilizzati per il lavoro. Questo significa che è auspicabile attendersi simili errori casuali e sistematici.

Cosa non scrivere[modifica]

Sono assolutamente da evitare frasi criptiche quali «abbiamo via, via aumentato la resistenza». Quale resistenza? Quella dell'insieme dei movimenti politici e militari che in Italia, dopo l'8 settembre 1943, si opposero al nazifascismo nell'ambito della guerra di liberazione italiana? Nel laboratorio di Storia, forse sì.

Purtroppo, con frasi del genere, non si fornisce nessuna indicazione di carattere pratico a chi legge. La fisica studia i fenomeni fisici sotto un profilo quantitativo, non qualitativo. Dunque, servono numeri.

Cosa scrivere[modifica]

Un approccio decisamente migliore è il seguente:

Per l'esperienza eseguita sono state utilizzate le seguenti resistenze, di cui si riporta il valore nominale e il loro valore misurato tramite l'Ohmmetro (il voltmetro digitale è in realtà un multimetro e consente la misurazione di diverse grandezze fisiche, tra le quali la resistenza elettrica).
Tutte le resistenze utilizzate, in questa esperienza, hanno una potenza massima di 1/4 W e una tolleranza del 5%.
Resistenza Valore nominale Valore misurato
N. 1
N. 2
N. 3
N. 4
N. 5
N. 6

Così facendo – non solo sarà possibile utilizzare le medesime resistenze – ma anche verificare i risultati ottenuti con i valori effettivi di quest'ultime; valutare se rientrano nel range della tolleranza e ogni altra cosa ritenuta opportuna.

A questo punto vengono richiesti alcuni schemi a cui far riferimento.

Schemi elettrici[modifica]

Misurazione di una resistenza col metodo voltamperometrico

Lo schema elettrico mostra il circuito di misurazione così come lo si disegnerebbe – a livello teorico – alla lavagna. In questo schema alcuni dettagli possono essere omessi, per questo motivo diventa importante riportare anche come i vari elementi circuitali sono stati tra loro connessi, senza trascurare nessun dettaglio.

In figura è riportato un ipotetico schema elettrico per la misurazione di una resistenza col metodo voltamperometrico (come si direbbe in gergo tecnico, appunto). Qui vengono evidenziate le connessioni degli strumenti di misurazione (l'amperometro e il voltmetro), la resistenza che verrà via, via cambiata e l'alimentatore stabilizzato.

Schemi di montaggio[modifica]

Schema di montaggio per la misurazione indiretta di una resistenza con metodo voltamperometrico

Lo schema di montaggio ha – come anticipato – la funzione di mostrare un'anteprima di come realmente si presenta visivamente il circuito. Può essere realizzato mediante un disegno come con una fotografia (se questa è chiara e comprensibile). Non esiste una scelta migliore a priori: è chi scrive che sceglie cosa fare, a seconda della miglior chiarezza espositiva.

Nella figura che segue è riportato lo schema di montaggio relativo al circuito di figura. Attenzione: il circuito mostrato è molto semplice: un alimentatore, un componente elettrico e due strumenti di misurazione. Punto. Tuttavia, se fotografato, probabilmente risulterebbe ermetico. Quindi è fortemente consigliato disegnarlo, a meno che la disposizione di strumenti e cavi, sia di facile comprensione.

I colori convenzionali sono rosso (tensione o corrente positiva) e nero (tensione o corrente negativa o neutra). In questo schema si è utilizzato anche il colore blu per indicare un cavo intermedio al fine di evitare confusioni.

Approfondimenti[modifica]

A questo punto – se non lo si è già fatto nelle relazioni precedenti – è bene soffermarsi sugli strumenti di misurazione. In particolare, prontezza, sensibilità, precisione, portata sono alcuni parametri che è bene conoscere e far conoscere al lettore.

Inoltre, l'amperometro analogico (se utilizzato) presenterà un errore di parallasse: come evitarlo? Riguardo a entrambi gli strumenti è comunque bene chiedersi (ed esporre a chi legge) come deve essere impostato il fondo scala per minimizzare gli errori di misurazione.

Espansioni suggerite[modifica]

Anche se lo schema elettrico è stato proposto dal docente, ci si potrebbe comunque chiedere cosa accade invertendo l'ordine di inserzione del voltmetro e dell'amperometro[6]. Oppure non utilizzando il voltmetro e ricorrendo – al posto suo – al voltmetro integrato nell'alimentatore stabilizzato.

Sono tanti gli aspetti che possono essere ulteriormente esplorati, aprendo scenari molto interessanti.

Tabelle e grafici[modifica]

Una volta eseguito l'esperimento scientifico questo può – e deve – essere descritto attraverso due forme: tabelle e grafici.

Tabelle[modifica]

Le tabelle servono per riportare i dati in maniera accurata. In questa sede è bene riportare tutte – e sole – le cifre significative.

Per esempio, se un voltmetro digitale riporta la seguente misurazione: , nella tabella non è corretto riportare il dato , poiché così facendo si sopprimono due cifre significative (il centesimo e millesimo di Volt) riportate dallo strumento di misurazione. Quando lo strumento fornisce un dato numero di cifre significative queste devono essere riportate tutte, zeri inclusi: sì, anche quelli sono significativi. Un esempio è , misurazione da non riportare in tabella come , poiché – così facendo – sembrerebbe che le cifre significative siano tre, anziché quattro. L'ultimo zero fa parte della misurazione e, in questo caso, è da considerarsi significativo poiché esprime il valore del millesimo di Volt.

Analogamente – nella compilazione di una tabella – è altresì errato, in luogo di una misurazione come , riportare il dato poiché il millesimo di volt è un dato incognito, in quanto non misurato.

In tabella vengono – sovente – riportati anche dati statistici quali errori assoluti, errori relativi, errore medio e deviazione standard. Questi parametri servono – durante il confronto tra dati teorici e dati misurati – a stabilire se la teoria e l'esperienza pratica coincidono, se gli errori sono accidentali o sistematici e altre cose di interesse.

Grafici[modifica]

A differenza delle tabelle, i grafici servono a visualizzare l'andamento di un fenomeno fisico. È così possibile capire se la relazione tra ingresso e uscita di un sistema è di diretta proporzionalità, inversa proporzionalità, quadratica o altro. Da questo tipo di indagine è più facile risalire al tipo di equazione matematica che lega ingresso e uscita.

Per contro, i grafici non forniscono i dati esatti dei parametri misurati, come in tabella. È importante ricordare, pertanto, che da una tabella può essere ottenuto il suo grafico, ma non sempre è vero il viceversa.

Tipologie di grafici[modifica]

Mentre riportare i dati in tabella è relativamente semplice, la stessa cosa non può dirsi per i grafici. Infatti se si lavora con dati discreti si utilizzerà un istogramma (conteggio di eventi che si verificano in dati istanti non continui nel tempo o in intervalli di tempo prestabiliti); invece per dati continui si utilizzerà un diagramma.

In seconda istanza, se i dati variano molto il loro valore (per esempio, da a , per evitare che i valori elevati rendano di difficile (o impossibile) interpretazione quelli piccoli, appiattendo il grafico, è fortemente consigliato l'uso della scala logaritmica, la cui proprietà è appunto avere una uguale ampiezza per ogni decade. Così facendo i piccoli valori saranno visibili quanto i grandi valori.

Conclusioni[modifica]

Anche questo paragrafo spesso viene male interpretato, purtroppo. Non si tratta di scrivere se tutto è andato bene o come previsto. Le conclusioni devono fornire al lettore un singolo messaggio: da questo lavoro di laboratorio si è acquisita questa competenza o quest'altra esperienza.

Vale lo stesso se l'obiettivo preposto nel titolo della documentazione non è stato raggiunto. Non è importante commettere errori, importante davvero è saper individuare una giustificazione valida a essi.

A esempio: se si ottengono valori discordanti da quelli attesi, ma i componenti utilizzati, una volta misurati, forniscono valori differenti da quelli nominali; oppure gli strumenti di misurazione risultano starati a fronte di un confronto con strumenti di maggior fiducia; ancora: si è eseguita l'analisi una seconda volta cambiando tecnologia di misurazione, e gli esempi potrebbero continuare. In tutti questi casi si forniscono ottimi dati al lettore per non commettere i medesimi errori.

Descrivere gli insuccessi non significa esporsi allo scherno o rendersi ridicoli. La scienza è piena di insuccessi che si sono tramutati come un boomerang nella fortuna di chi li ha commessi: il post-it è figlio di una colla che funzionava malissimo; inoltre si narra che un tale – di nome Galileo – nel 1616 abbandonò il tribunale dell'Inquisizione mormorando «...eppur si muove».

L'unica cosa importante è che le vostre conclusioni siano migliori di quelle di Erasmus Wilson, presidente dello Stevens Institute of Technology, quando nel 1879 dichiarò: «Quest'invenzione dell'energia elettrica è un fallimento totale»; o di Lord Kelvin, il cui nome dovrebbe ricordare qualcosa, famoso fisico britannico e presidente della Royal Society il quale nel 1895 dichiarò: «È impossibile che qualcosa più pesante dell'aria possa volare».

Postfazione (per non concludere)[modifica]

Come impostare la struttura del testo[modifica]

Un testo scientifico, indipendentemente dall'argomento che si vuole trattare, ha una struttura variabile. Questa dipende dal tipo di documento che si vuole scrivere e, spesso e volentieri, anche chi lo richiede inserisce ulteriori specifiche (che sia il professore o una rivista poco cambia). Si potrebbe pensare a ogni tipo di documento: tesi di laurea, documentazione tecniche, verbale di riunioni, riassunto di un articolo scientifico, brevetto e altro. Pertanto non esistono indicazioni universali.

La prima cosa su cui ci si focalizza è: un testo scientifico si scrive in forma impersonale. Come: «si è effettuata una visita presso l'azienda Costruzioni Srl», e non in prima persona «siamo stati in gita all'azienda Costruzioni Srl»; ancora «dopo le osservazioni fatte...», e non «alla fine il professore ci ha mostrato...».

Per cominciare bene, la prima pagina deve riportare sempre, e in modo inequivocabile, l'autore, il titolo, oltre alle eventuali informazioni aggiuntive legate all'ambito nel quale il documento è stato scritto. Per fare un esempio, una documentazione tecnica su una visita didattica presso un’azienda dovrà esporre almeno: autore, titolo, corso di studi, materia, data della visita e nome del docente. Queste informazioni possono essere riportate in testa alla prima pagina (per testi brevi, di poche pagine), oppure, per testi più lunghi, (quando si superano le dieci pagine) è opportuno riportate da sole, su una prima pagina di copertina, così facendo il testo vero e proprio inizierà nella seconda pagina.

Le pagine del documento vanno sempre numerate ed è bene riportare in ognuna (o in intestazione, o piè pagina) il proprio nome e il titolo del documento. Se il testo è lungo oppure articolato, è opportuno l'inserimento di un indice. In genere, l'indice si posiziona nella prima o nella seconda pagina (se la prima è di sola intestazione). L'indice riporta i titoli dei capitoli, dei paragrafi e dei sottoparagrafi (di norma non si superano i tre livelli) con il numero della pagina corrispondente.

Il testo deve avere una struttura. Ciò significa che le diverse parti che lo compongono (indice, introduzione, parte generale, risultati, conclusioni, bibliografia, allegati) devono essere immediatamente identificabili, sia grazie all'uso di opportuni formati, sia grazie all'organizzazione del testo; la cosa migliore è utilizzare una struttura gerarchica, disponibile in ogni elaboratore di testi. Questa procedura semplificherà anche la creazione dell'indice, che può essere generato automaticamente.

Informazione essenziale[modifica]

Nella costruzione delle frasi è bene fare molta attenzione alla comprensione del testo, poiché il lettore non conosce le motivazioni che ci spingono a scrivere in un dato ordine o in un altro. Letteralmente, il lettore va preso per mano e guidato in un percorso che non conosce. Ecco perché si è scritta l'introduzione ed ecco perché tutto quello che segue è stato inserito nello stesso ordine presentato nell'introduzione stessa.

Non siate mai avari con le cancellature, non è reato sacrificare parole inutili; nei testi scientifici ricorrono abitualmente parole e frasi superflue: è facile riconoscerle ed eliminarle: «il composto è stato ottenuto inserendo in successione gli elementi l'uno dopo l'altro...»; «nella Figura 1 si trovano i risultati schematizzati in forma grafica»; «la schiavità è stata totalmente abolita»; «il dolore è di natura essenzialmente cardiaca».

La lunghezza di un testo è ininfluente, le relazioni tecniche non si vendono a peso. Essere ridondanti e prolissi è più grave: dopo poche righe si annoia il lettore; uno scritto scientifico ha il dovere di essere rigoroso, chiaro ed essenziale. Pertanto è bene costruire frasi brevi e lineari, con pochi incisi. Queste sono di più agile lettura rispetto a frasi lunghe o con otto subordinate inanellate l'una di seguito all'altra prima della reggente. Impostante è l'uso corretto della punteggiatura. Molte persone trattano la punteggiatura come l'acne: se non c'è, meglio. Celebre è l'esempio: «adesso mangio mamma», in luogo di «adesso mangio, mamma».

Evitate frasi logore o abusate: «Sulla base degli studi e delle ricerche effettuate presso il nostro laboratorio...»; «Alla luce dei risultati ottenuti sembrano necessari ulteriori studi per confermare il ruolo delle pagine dinamiche...» e luoghi comuni come «La ricerca scientifica ha fatto passi da gigante».

La scelta delle parole[modifica]

La chiarezza e l'accuratezza sono i criteri cardine nella scelta delle parole da usare nel testo. Occorre essere certi dell'esatto significato di tutte le parole utilizzate, senza abusare dei modi di dire del momento; sempre più spesso diverse parole sono scritte in modo scorretto o usate in modo del tutto improprio, l'esempio classico è la contaminazione di omologhi termini stranieri, così da creare termini che non trovano asilo in alcun vocabolario:

No
Effettuare una scansione Scannerizzare
Gestire la complessità Complessizzare
Redigere un referto Refertare
Terminare Stoppare
Aggirare Bypassare
Ottimizzare Upgradare
Inoltrare Forwardare

Di fatto, il linguaggio scientifico prevede già numerosi termini mutuati dalle lingue straniere, perché privi di un esatto corrispondente in italiano. Bisogna fare attenzione a distinguere tra termini universalmente accettati e termini di uso poco comune, i quali possono essere ignoti al lettore medio e appesantiscono il testo.

Tanto più si usano parole elaborate e ricercate, tanto maggiore è il rischio di commettere errori. In ogni caso è bene consultare un buon vocabolario e un dizionario scientifico/tecnico, oggi disponibili anche online. Se ben utilizzati, questi strumenti possono essere di grande aiuto e fornire soluzioni a molti dubbi.

Ma soprattutto: non fate alcun affidamento sul correttore automatico dell'editor di testo; ci sono molti termini errati che i correttori automatici non rilevano.

Tabelle e grafici[modifica]

Altre note sull'uso di tabelle, immagini e grafici in un testo scientifico. Devono essere sempre codificati da un numero e da un titolo. Se vengono riportati dati di fonte esterna (dati che non sono frutto di elaborazione propria) nel titolo va sempre citata la fonte:

  • Tabella 3. Piovosità media in Urbino nel decennio 2009–2019. (Dati Regione Marche, 2020).
  • Grafico 5. Rugosità del manto stradale nella Regione Marche (Rielaborazione di dati forniti da smartroadsense.it).

La tabella e il grafico devono avere sempre una citazione nel testo che li presenta o li commenta:

  • I principali circuiti integrati sono riportati in Tabella 3.
  • Le principali aziende italiane (Tabella 7) sono le cosiddette PMI.

Questo significa anche posizionarli nel testo con ragionevole contiguità con il testo che li illustra (compatibilmente con i vincoli di impaginazione).

La bibliografia[modifica]

Il testo scientifico spesso fa riferimento a concetti, dati sperimentali e lavori derivati da altri testi, articoli, capitoli di libri. Tali riferimenti devono essere sempre corredati del relativo riferimento bibliografico. Come regola, quando le citazioni siano più di una, vanno ordinate in ordine cronologico, e a parità di anno di pubblicazione, in ordine alfabetico.

Ogni riferimento bibliografico presente nel testo, in una tabella o in un grafico va poi esplicitato in modo dettagliato al fondo del testo, in un'apposita sezione bibliografica. Qui sono indicati quattro esempi, relativi alla citazione da un articolo scientifico, da una tesi di dottorato, da un capitolo di un libro e dagli atti di un convegno:

  • Alessandroni, G. et al. A Study on the Influence of Speed on Road Roughness Sensing: The SmartRoadSense Case. Sensors 2017, 17(2), p. 305.
  • Alessandroni, G., Analisi e Modelli per il Monitoraggio del Manto Stradale, PhD Thesis, University of Urbino, 2016, pp. 169.
  • Alessandroni, G. Dov’erano i pacifisti? Dodici mesi di movimento pacifista. In: Guerra e mondo—Annuario geopolitico della pace, ed. Altreconomia, 2004, pp. 15–38.
  • Alessandroni, G. et al. Sensing road roughness via mobile devices: A study on speed influence. Image and Signal Processing and Analysis (ISPA), 2015 9th International Symposium on, 7–9 September 2015, Zagreb. pp. 73–75.

Note[modifica]

  1. Gli how-to sono documenti – maggiormente diffusi in ambito scientifico e informatico – affini al campo della conoscenza procedurale. La parola how-to può essere tradotta con "come fare per..." e denota un tono informale della trattazione. Sono, generalmente, monotematici e pensati per aiutare i meno esperti tralasciando dettagli che potrebbero interessare solo il pubblico con conoscenze più approfondite riguardo all'argomento di trattazione.
  2. Un esempio volutamente estraneo alle telecomunicazioni per assumere un carattere generale e valido in ogni contesto.
  3. Anche se non è stato scritto, a questo punto dovrebbe essere chiaro a tutti che il titolo non vuole la punteggiatura. Fa eccezione il punto interrogativo.
  4. L’abstract è il sommario di un documento senza aggiunta di interpretazione e valutazione. Si limita a riassumere, in un dato numero di parole, gli aspetti fondamentali del documento esaminato. Solitamente ha forma "indicativa-informativa" presenta notizie sulla struttura del testo e il percorso elaborato dall'autore. La norma internazionale ISO 214–1976 definisce il termine "abstract" come "una rappresentazione abbreviata e accurata dei contenuti di un documento senza aggiungere interpretazione e valutazione e senza distinguere il destinatario dell'abstract", mentre per la norma 5127–1981 (versione italiana del 1987) lo si definisce come "riassunto del contenuto di un documento in forma abbreviata, senza interpretazione né critica".
  5. Tratta da Georg Simon Ohm. Questo esempio viene riportato poiché sono state corrette – con valutazioni che si possono facilmente immaginare – relazioni con questo contenuto, le quali, oltre a essere un plagio, non aggiungono nulla di significativo, anzi: sviano il lettore.
  6. La cosiddetta inserzione dello strumento "a monte" e "a valle".