Home → Tutorial →
Appunti scolastici → Digitale → Relazione
Stesura preliminare
Ogni attività di laboratorio deve essere documentata. Due sono i
documenti che possono essere prodotti:
- Appunti per uso personale per tenere traccia nel taccuino
di laboratorio di quello che si sta facendo. Utile sia per "non perdere
il filo", sia per ricostruire a distanza di tempo il proprio lavoro.
Personalmente la indico come procedura essenziale nell'attività di
laboratorio
- Relazioni, da rendere pubbliche: un articolo da pubblicare
su una rivista, un lavoro
scolastico, un report da presentare a colleghi o collaboratori
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:
- la finalità del lavoro: cosa voglio ottenere
- il metodo di lavoro: breve descrizione di come si è lavorato, una
sorta di sommario
- le conclusioni ottenute, soprattutto se si tratta di un lavoro di
ricerca (nota 1)
- gli autori del lavoro
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:
- è importante che lo schema sia chiaro ed accurato; deve contenere
tutti i componenti ed i collegamenti necessari per descrivere il
circuito
- in funzione della complessità del circuito potrebbe essere utile
suddividere il circuito in blocchi da analizzare separatamente
- lo schema deve coincidere con il circuito fisico effettivamente
realizzato. Eventuali differenze, se obbligate, devono essere ben
documentate
- occorre riportare la sigla oppure il valore dei componenti
utilizzati. Per esempio: non una porta NAND a due ingressi, ma
una 74HC00
- in genere non serve descrivere i singoli collegamenti (lo schema è auto
esplicativo...). Inutile dire che tra uscita di una porta logica e LED è
presente una resistenza quando è disegnata
- spesso vengono progettate o realizzate varianti dello stesso
circuito; è possibile scegliere se disegnare tutti gli schemi
separatamente oppure semplicemente evidenziare le differenze tra di
essi. Per esempio: se un resistore assume diversi valori, basta
scriverlo, senza ridisegnare tutto
- lo schema può essere disegnato a mano oppure con l'utilizza di un
programma di progettazione specializzato come Deeds
oppure SIMetrix.
Assolutamente sconsigliato l'uso di programmi di disegno generici, fonte
di perdita di tempo ed errori
- A volte lo schema, soprattutto se complesso, può essere allegato e
non inserito come immagine nella relazione
Materiali utilizzati
Spesso si elencano i materiali utilizzati, inserendone di inutili, ma
tralasciando cose importanti. Per esempio:
- Inutile citare oggetti di uso comune nel contesto in cui si opera,
dai fili elettrici... alla sedia. A meno sia un lavoro specifico su di
essi
- abbastanza inutile elencare i componenti già presenti nello
schema
- utile indicare dettagliatamente gli strumenti usati (produttore e
modello) ed il software usato (nome e versione)
Misure
Spesso è necessario fare misurazioni
- è importante descrivere accuratamente come sono state ottenute
- fondamentale l'uso delle corrette unità di misura e
l'indicazione dettagliata della grandezza, possibilmente in riferimento
allo schema. Per esempio, l'indicazione corretta è tensione ai capi
di R3 oppure corrente in uscita da una porta logica (se ve ne è
una sola...) oppure tensione di alimentazione, ma evitiamo di
scrivere che che "la tensione è 3 V".
- spesso le misure sono rappresentate graficamente: anche in questo
caso è fondamentale indicare le unità di misura e le grandezze presenti
- se si utilizza uno strumento PC-based (come
Picoscope) è
assolutamente consigliabile fare frequentemente screenshot.
Anzi questa è una procedura veloce per poter successivamente analizzare
i dati ed individuare eventuali errori nelle procedure seguite. Se li si
utilizza nella documentazione molto spesso si guadagna in chiarezza e
precisione (ed anche velocità nelle descrizioni)
Immagini
Una relazione in genere contiene:
- fotografie del circuito reale realizzato. A volte questo aspetto è
inutile, a volte indispensabile per ricostruire un circuito la cui
struttura fisica è importante
- lo schema del circuito
- lo screenshot dello schermo è il metodo nel contempo più veloce e
dettagliato per documentare una misura, un errore, l'output di un
programma: usateli!
- in genere non è necessario disegnare le connessioni sulla
breadboard con programmi tipo Fritzing oppure Tinkercad.
Se viene inserito ovviamente non guasta, ma non sostituisce lo schema o
una fotografia
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):
- deve essere interamente presente. Se si tratta di poche righe può
essere scritto direttamente nella relazione, altrimenti meglio
includerlo in un file separato, soprattutto se si tratta di un progetto
con molti file
- fondamentale descrivere gli aspetti più importanti, anche
usando i commenti direttamente nel codice
- se il codice produce output su un monitor, includere screenshot
significativi (nota 2)
I riferimenti
Quando si scrive un documento tecnico sono spesso presenti riferimenti al
lavoro fatto da altre persone (nota 3):
- a volte si consultano documenti presenti su Internet: indicare con
precisione l'URL e gli aspetti ritenuti importanti e che sono stati
utilizzati nel proprio lavoro. Stesso ragionamento per le riviste
specializzate ed i libri.
- spesso occorre ricavare informazioni dai fogli tecnici messi a
disposizione dal produttore dei componenti; indicare
dettagliatamente quali si sono utilizzati e quali informazioni si sono
giudicate utili nel proprio lavoro, indicando la pagina/tabella/figura
o, meglio ancora, includendo uno screenshot.
- spesso si collabora o ci si fa aiutare da altre persone: scrivetelo!
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:
- Se si raccoglie un'informazione dal Web, indicare esattamente la
fonte
- Se si collabora in un'attività di gruppo, va indicato
esplicitamente, eventualmente specificando i diversi ruoli
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 possibilmente 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
- Soprattutto nei lavori scolastici, maglio evitare frasi del tipo: l'esperimento
è riuscito , il lavoro mi è / non mi è piaciuto e simili
- Da evitare assolutamente fotografie dello schermo, in genere di
pessima qualità
- Ovviamente in una attività sperimentale, occorre che una parte
significativa del lavoro sia personale...
Pagina creata nel dicembre 2020.
Ultima modifica: 2 dicembre 2020
