Relazione

In fase di sviluppo Stesura preliminare In fase di sviluppo

Ogni attività di laboratorio deve essere documentata. Due sono i documenti che possono essere prodotti:

Pur avendo finalità ben diverse, i due scritti condividono gli stessi contenuti. In questa pagina cerco di spiegare questi aspetti comuni.

Abstract

In genere una relazione, soprattutto se deve essere resa pubblica, inizia con un riassunto di poche righe, senza l'aggiunta di interpretazione e valutazione. Nella pubblicazione di articoli scientifici e tecnici il riferimento è la norma internazionale ISO 214-1976, che ne determina la strutture e la lunghezza.

Ovviamente non è sempre richiesto il rispetto di questa norma, ma alcuni elementi devono essere tenuti in considerazione:

Descrizione dettagliata del lavoro

La relazione tecnica di un progetto consiste in un documento che riporta fedelmente un fatto o una procedura.

Scontato il fatto che il documento deve essere scritto in italiano (oppure in inglese), usando i termini tecnici appropriati. In generale, se il lavoro deve essere reso pubblico, il formato preferito potrebbe essere PDF, ma sono idonei anche i formati XML standard ISO (DOCX e ODT) oppure HTML, soprattutto se il layout è semplice.

Il contenuto dipende ovviamente dal lavoro svolto, ma alcuni elementi sono piuttosto comuni:

Schema elettrico

Lo schema del circuito è spesso il punto di inizio di un lavoro di analisi oppure la conclusione di un lavoro di progettazione. La sua presenza è quindi essenziale. Alcune note:

Materiali utilizzati

Spesso si elencano i materiali utilizzati, inserendone di inutili, ma tralasciando cose importanti. Per esempio:

Misure

Spesso è necessario fare misurazioni

Immagini

Una relazione in genere contiene:

In genere la pubblicazione di un'immagine si accompagna ad una didascalia che la spiega nel contesto del lavoro svolto

Il codice

Spesso è presente del codice (Arduino, Raspberry Pi):

I riferimenti

Quando si scrive un documento tecnico sono spesso presenti riferimenti al lavoro fatto da altre persone (nota 3):

In genere l'utilizzo di materiale altrui è un elemento essenziale per la crescita della conoscenza!

Una domanda spesso frequente: qual è il confine tra il plagio e l'uso legittimo delle informazioni? In breve possiamo dire che se viene citata la fonte, la copia è legittima, altrimenti no. Qualche esempio di comportamenti corretti:

Quando il comportamento è non corretto? Internet è pieno di esempi come questo.

Gli errori ed i problemi

Spesso nell'attività di laboratorio si incontrano problemi e si commettono errori. Lungi dall'essere un ostacolo, questo deve essere un'occasione di crescita, ovviamente a condizione di documentare la difficoltà (e la soluzione trovata...).

Per esempio, non è utile, e quindi negativo, scrivere: ci sono stati problemi; al contrario: è molto utile scrivere che, a causa della mancanza di un driver, si è dovuta attivare una specifica procedura, descrivendola possibilmente nei dettagli.

Note

  1. Soprattutto nei lavori scolastici, maglio evitare frasi del tipo: l'esperimento è riuscito , il lavoro mi è / non mi è piaciuto e simili
  2. Da evitare assolutamente fotografie dello schermo, in genere di pessima qualità
  3. Ovviamente in una attività sperimentale, occorre che una parte significativa del lavoro sia personale...


Pagina creata nel dicembre 2020. Ultima modifica: 2 dicembre 2020


Licenza "Creative Commons" - Attribuzione-Condividi allo stesso modo 3.0 Unported


Pagina principaleAccessibilitàNote legaliPosta elettronicaXHTML 1.0 StrictCSS 3

Vai in cima