Esempio di relazione per TEPSIT
Antonio Elio Marino ITIS“Marconi” Pontedera (PI)
31 Dicembre 2016
Sommario
In questo esempio di relazione verr`a mostrato come si scrive una relazione per TEPSIT. Nel riassunto (o abstract o sommario) va spiegato brevemente lo scopo del progetto ed il metodo usato per portarlo a termine. Di nor- ma serve al lettore a capire se l’articolo `e di suo interesse o meno. Non `e obbligatorio. Cercate di essere concisi, non pi`u di quattro o cinque righe.
1 Introduzione [Indispensabile]
Nell’introduzione va spiegato lo scopo del progetto in maniera dettagliata. `E come l’abstract, ma pi`u esteso.
Note importanti sulla redazione di una relazione:
• Scrivete, all’inizio della relazione: il titolo (di solito basta riscrivere il titolo del progetto assegnato), il nome dell’autore, la classe, la data di consegna, il nome di chi ha eventualmente collaborato alla stesura del codice (si ricorda che la relazione `e individuale) e il nome del file sorgente a cui la relazione fa riferimento, cos`ı `e pi`u facile trovarlo per chi corregge;
• In una relazione i verbi vanno messi all’impersonale. Vietato usare un “io ho scelto” o “noi abbiamo scelto”, si preferisca un generico ”`e stato scelto”.
Mai rivolgersi direttamente al lettore.
Evitare di scrivere ”per avere l’eseguibile devi compilare con gcc”, meglio scrivere ”per ottenere l’eseguibile si consiglia l’uso di gcc”.
Notare che il verbo “dovere” `e stato rimosso, non `e piacevole ricevere ordini da una relazione.
Per motivi didattici, tuttavia, in questa relazione verranno usati i soggetti;
• La relazione va consegnata in formato .pdf o .odt.
Se usate il programma Word della suite Microsoft Office potete esportare facilmente in pdf il vostro file (per sapere come fare basta una veloce ricerca su Internet);
• Cercate di usare un font leggibile, grandezza 12-14 pt. Niente font strani (Comic Sans MS in primis) n´e interlinee doppie (non `e una gara a chi occupa pi`u spazio e presenta relazioni pi`u lunghe);
• Nel corso dei mesi molti di voi hanno creato uno schema personale nella crea- zione delle relazioni: mantenetelo ed usate questi appunti come integrazione.
Questa relazione non va presa alla lettera, n´e va seguita pedissequamente1, serve come traccia e mostrer`a cosa `e indispensabile inserire, cosa `e facoltativo e cosa `e inutile.
2 Descrizione del progetto [Indispensabile]
Qui va descritto il progetto. A differenza dell’introduzione, bisogna dire se `e stato usato un particolare metodo risolutivo o una tecnica e come `e stato implementato.
Nota: si suppone che il lettore della relazione abbia un’infarinatura di base, quindi non c’`e bisogno di spiegare cos’`e un computer o cosa fanno le singole istru- zioni del codice. D’altro canto non `e detto che conosca il metodo usato, quindi questo va spiegato bene (ovviamente il docente conosce il metodo usato, ma esso va comunque spiegato perch´e permette di capire se lo studente ha davvero capito e migliora la valutazione).
2.1 Materiale, risorse e software [Indispensabile]
Questa sezione `e obbligatoria. Ad esempio per scrivere questa relazione `e stato usato il seguente setup:
• Atom text editor ver. 1.12.7;
• T eX ver. 3.14159265;
• Ubuntu desktop 16.04 LTS amd64.
Nota: l’elenco del materiale e del software usato `e indispensabile per chi vuol replicare esattamente il vostro progetto. Ovviamente in questo caso non interessa il sistema operativo usato, ma il software usato e la sua versione potrebbe essere
3 Spiegazione codice [Indispensabile]
A differenza della descrizione, dove si parla del progetto (a cosa serve, quali tecniche avete usato e perch´e), adesso dovete spiegare come `e strutturato il codice, quali sono le parti principali, cosa fa ogni porzione di codice.
Spiegate la scelte che avete fatto.
Tenete in mente la seguente cosa: chi legge un codice non sempre riesce a capire cosa sta succedendo, ma con la relazione accanto deve essere in grado di avere una visione globale del progetto.
Nota: non dovete riscrivere l’intero codice. `E comunque possibile riscrivere le porzioni di codice che si vogliono commentare.
4 Note [Facoltativo]
4.1 Errori [Obbligatorio se il programma non funziona]
Non tutte le ciambelle riescono con il buco. L’importante `e almeno che le ciambelle ci siano. Frasi del tipo ”ho lavorato ma non mi riesce” sono inutili. Scrivete l’errore che vi d`a il compilatore, o isolate il codice che secondo voi d`a problemi.
Provate a ipotizzare dove possa essere l’errore, cosa fareste per trovarlo, magari implementando altro codice che possa individuarlo o aggirarlo, cosa avete trovato di anomalo nei valori delle variabili, dei registri etc...
Se dovete inserire del codice aggiuntivo a quello nel sorgente provate a scriverlo in maniera leggibile, indentato e pulito:
1 #i n c l u d e <s t d i o . h>
2
3 main ( ) {
4 p r i n t f (” h e l l o , w o r l d \n”) ;
5 }
4.2 Conclusioni o aggiunte [Facoltativo]
Se volete potete aggiungere conclusioni, riflessioni, idee o strade alternative.
Qualcuno in qualche relazione ha aggiunto tabelle comparative, idee non im- plementate nel codice, opinioni costruttive, feature, ipotesi, modifiche e altro. Per non appesantire il filo del discorso questo pu`o essere fatto alla fine, purch´e il lettore capisca che ci`o non `e parte del programma che la relazione va ad integrare.
4.3 Riferimenti bibliografici [Facoltativo]
Se avete preso informazioni o codice da Internet o da qualche libro e volete che il lettore possa fare riferimento a quelle informazioni `e possibile aggiungere dei riferimenti bibliografici. Ad esempio:
1 Baudoin, Marc. Impara LaT eX! (...e mettilo da parte)
https://users.dimi.uniud.it/~gianluca.gorni/TeX/itTeXdoc/impara_
latex.pdf
Manuale LaT eX usato per la stesura di questo documento.
2 Kernighan, Brian. Programming in C: A Tutorial https://www.lysator.liu.se/c/bwk-tutor.html Prima versione di “Hello, world” scritta in C.
Esempio schematico di relazione
Autore:
Classe:
Data:
File del progetto:
Componenti del gruppo di lavoro: (Obbligatorio se si `e lavorato in gruppo)
1 Sommario
Scrivere un riassunto del progetto (facoltativo ma apprezzato).
2 Descrizione progetto
Spiegare dettagliatamente il progetto: scopo e metodi usati. Dimostrate di aver capito cosa state usando, come e perch´e.
2.1 Materiale e risorse usate
• Hardware particolare (non c’`e bisogno di scrivere “computer”);
• Software: nome completo e versione;
• Qualsiasi cosa sia utile per riprodurre il progetto.
3 Spiegazione codice
Spiegare qui le scelte compiute: il perch´e di certi valori, di variabili di appoggio, di cicli annidati o altro. Questa sezione serve a rendere comprensibile il codice a chi lo legge per la prima volta.
3.1 Struttura del programma
Elencare e descrivere le parti principali del programma: main, direttive, funzioni, dichiarazioni etc...
4 Note
4.1 Errori
Obbligatorio se il codice non funziona.
4.2 Conclusioni, riflessioni o aggiunte
Qualsiasi cosa si voglia far sapere al docente.
4.3 Bibliografia e sitografia
Se si fa riferimento a libri, siti o manuali e si vuole che il lettore della relazione possa documentarsi sulle medesime fonti.
