Difference between revisions of "Tesi"

Revision as of 14:19, 15 April 2013

Se siete qui per cercare una tesi... peccato, siete nel posto sbagliato! Le tesi disponibili presso il laboratorio di Intelligenza Artificiale e Robotica vengono raccolte nell'apposita sezione di airwiki. Ovviamente, se avete idee che vorreste sviluppare come tesi siente invitati a contattare i docenti che fanno riferimento al laboratorio e proporle... ben venga l'iniziativa! Comunque vi suggeriamo di andare avanti con la lettura di questa pagina che prima o poi vi servirà ;-).

Quanto segue è una raccolta di informazioni utili alla stesura di un manoscritto che sia degno di chiamarsi tesi e può considerarsi a buon titolo una mini guida alla scrittura della relazione finale di tesi. Non pretende d'essere la guida definitiva: è da considerarsi semplicemente un elenco delle cose che continuiamo a correggere in tutte le tesi e che non sarebbe male "prevenire invece che curare" :-P.

Un grazie particolare va alle persone che hanno donato del tempo prezioso alla raccolta del materiale che segue (in rigoroso ordine alfabetico!): Francesco Amigoni, Andrea Bonarini, Marco Colombetti, Nicola Gatti, Matteo Matteucci, Marcello Restelli, Marco Somalvico... e se abbiamo dimenticato qualcuno segnalatelo, saremo ben felici di aggiungere il suo nome!

Aspetti (Molto) Generali

Quanto segue potrebbe sembrare forse superfluo, ma non è male che sia chiaro fin dall'inizio perché guidi la scrittura di ogni singola pagina del vostro manoscritto...

• Cercate di capire fin da subito le regole del gioco: per tale motivo vi consigliamo di leggere il regolamento delle tesi per la Laurea Specialistica che trovate qui.

• Non mettere nella relazione tutto ciò che si conosce, ma solo ciò che è strettamente legato all'argomento trattato e funzionale alla trattazione dello stesso.

• Organizzare i concetti in una struttura razionale. Non lasciare concetti importanti sottintesi. Non ripetere in continuazione i concetti se non esplicitamente richiesto dalla chiarezza della trattazione.

• Rileggere più e più volte quanto si scrive. Fare leggere lo scritto anche ad altre persone che non sono a conoscenza dell'argomento (si suggerisce di rileggere su carta e non a video quanto scritto). Per facilitare il compito a loro (e al vostro relatore che leggerà tutta la tesi almeno una volta, ... usate il correttore ortografico PRIMA di darla da leggere.

La durata di una tesi non e' predeterminata. Di fatto una tesi si puo' dir conclusa quando sono soddisfatti (ovviamente in maniera piu' o meno sfumata) alcuni requisiti:

• quando si hanno dei risultati di cui dar conto nella tesi, che comportino una certa dose di innovazione scientifica o anche solo tecnologica

• quando e' stata scritta e riletta

• quando la documentazione e' completa

• quando e' stata scritta una paginetta su airwiki in inglese con la descrizione della tesi, una demo, tutto il materiale che serve per far funzionare o per capire il contenuto della tesi

Interazione con il relatore/correlatore

Il relatore (o correlatore) è la persona responsabile del vostro operato da tesista. Il suo compito è seguirvi nello svolgimento della stessa e far sì che il risultato finale sia degno di essere letto sia dal punto di vista della forma sia dal punto di vista del contenuto. Ricordate che alla fine starà a lui valutare la tesi e accreditarne i corrispondenti crediti (un tempo questo veniva fatto compilando la seguente scheda che trovate qui... just for you to know...). Ecco alcune buone regole per interagire con il vostro relatore/correlatore:

• Il relatore/correlatore deve rileggere la tesi e quindi deve avere in mano una versione completa della stessa almeno un mese prima della scadenza per la consegna. Ovviamente, deve essere una bozza e non la stesura finale, ma deve avere già la struttura e i contenuti della stesura finale. Ancor meglio se mentre la state scrivendo fate avere i capitoli al vostro relatore/correlatore perché li legga uno alla volta.

• Non date un manoscritto mai riletto da leggere al relatore/correlatore; questi deve potersi concentrare sui contenuti e sulla struttura espositiva, non sulla forma dell'italiano (o inglese nel caso scriviate in inglese, nel qual caso e' meglio se usate oltre al correttore ortografico anche quello grammaticale).

• Il relatore/correlatore deve seguirvi nello svolgimento della tesi dandovi indicazioni e suggerimenti ogni volta che vi bloccate in un qualche punto... ma va da sè che la tesi non deve farla lui ;-)

• Interagite frequentemente con relatore e correlatore/i. Questo può essere fatto in vari modi; si suggerisce un incontro con cadenza almeno quindicinale e un'email alla settimana in cui si descrivono le attività fatte di recente. Qualora non si sia fatto niente di nuovo va benissimo una mail che lo dice, giusto per sapere che esistete e che non vi siete dimenticati di noi poveri relatori/correlatori.

• Alla fine della tesi dovrete consegnarne una copia al relatore in formato cartaceo e in formato digitale (su opportuno CD con titolo della stessa e autori sul CD!). E' carino se consegnate una versione cartacea della tesi anche ai vari correlatori!

Strumenti per la scrittura

Premettiamo che la qualità di una tesi prescinde dallo strumento utilizzato per la sua stesura. Per esperienza passata nostra e di colleghi che vi hanno preceduto suggeriamo di usare LaTeX e a tale scopo forniamo un "pacchetto" con uno stile che già rispetta tutte le indicazioni di formattazione che seguiranno e relative istruzioni su come usarlo. Lo potete scaricare dal seguente link. (NB: sappiamo benissimo che questo link andrebbe messo in un punto molto più visibile della pagina, ma l'intenzione è constringervi a leggere buona parte del contenuto della stessa :-P).

• LaTeX: è un sistema di editing che permette di scrivere documenti in puro formato testo e successivamente di compilarli in un documento Postscript o pdf. Di norma è già installato sui sistemi Linux (pachetto tetex) mentre lo si può scaricare liberamente per sistemi Windows dal sito del progetto MikTex: http://www.miktex.org . Una guida molto nota per la scrittura di documenti LaTeX è questa e comunque è possibile trovarne diverse in rete.

• Editor: essendo LaTeX un linguaggio di formattazione basato su TAG un buon editor che supporti la stesura della tesi è fondamentale. In ambiente Linux si suggeriscono Kile, Emacs, lyx o gedit. In ambiente Windows suggeriamo l'uso di WinEdt (scaricabile dal sito http://www.winedt.com) o TeXnicCenter (scaricabile dal sito http://www.toolscenter.org). Sconsigliamo fortemente Scientific Workplace in quanto il risultato non è LaTeX standard e quindi non è nè portatile nè leggibile!

• Grafici: per il plotting di dati numeri in grafici 2D e 3D suggeriamo gnuplot (http://www.gnuplot.info); esiste sia per Linux sia per Windows e trovate ottimi tutorial in rete su come si usa. Se usate grafici realizzati in Matlab o Excel, tenete conto che tutti gli assi devono essere associati a un'indicazione di cosa contengono e che questi strumenti spesso "autoscalano" il grafico, rendendo due grafici da comparare spesso non confrontabili.

• Immagini vettoriali: per disegnare immagini vettoriali tipo schemi a blocchi o simili suggeriamo l'uso di DIA scaricabile gratuitamente da http://www.gnome.org/projects/dia/. Lo strumento non è potente come xfig (http://www.xfig.org), ma è decisamente più user friendly ed esiste sia per Linux che per Windows!

• Immagini bitmap: Gimp (http://www.gimp.org) è decisamente il miglior software di fotoritocco e grafica bitmap free che esiste. Basti dire che lo scopo del progetto è lo sviluppo di un clone di Photoshop! Esiste sia per Linux che per Windows.

• Citazioni e BibTeX: per gestire il file delle citazioni della tesi suggeriamo di usare jabref (http://jabref.sourceforge.net). E' in java e quindi multipiattaforma.

• Conversione formati immagine: convert sotto Linux è un must!

Ovviamente non vi "impediamo" di usare Word e la suite Office di Microsoft per la scrittura della tesi, ma il tempo speso nell'imparare a usare LaTeX sarà ampiamente ripagato dalla qualità del prodotto finale, dall'acquisizione di una nuova competenza e dalla totale assenza di problemi nella formattazione del testo (anche se vi preannunciamo un minimo di fatica per domare il posizionamento automatico delle figure). Per dimostrarvi la nostra "buona fede" in tal senso forniamo anche uno stile Word per la scrittura di tesi scaricabile dal seguente link. In ogni caso se proprio volete usare Microsoft Word per scrivere la tesi vi suggeriamo di scrivere ogni capitolo in un file separato in modo da limitare la dimensione dell'oggetto maneggiato, soprattutto quando avete figure e grafici con molti punti.

Struttura e contenuto

La struttura di una tesi deve tener presenti alcune semplici regole affinchè la lettura sia facilitata da un filo logico che vede il tema principale della tesi sempre al centro di ogni sua parte. Quindi:

• Devono esserci delle motivazioni per lo stato dell'arte e quindi deve essere funzionale al contenuto della tesi.

• Già dall'indice (e quindi dai titoli di capitoli e paragrafi) si dovrebbe riuscire a capire una linea di ragionamento.

• La lunghezza complessiva della tesi dovrebbe essere di 100-150 pagine + appendici (max 100 pagine).

• La lunghezza media di una frase è di circa 3-5 righe. Non superare mai le 10 :-)

• Inserire degli esempi per rendere più chiara la trattazione.

• Preferire la prima persona plurale (noi...) invece della prima singolare (io...) che è troppo presuntuosa e della forma impersonale (si è fatto ...) che rende difficile cogliere il vostro contributo e distinguerlo da quello di altri, oltre a far perdere forza all'argomentazione.

Esempi e template di tesi sono disponibili link. Non considerate la struttura come intoccabile; anzi, è probabile che se non la modificate vuol dire che non avete chiaro come va strutturata la tesi. Nel caso, rileggete i consigli sopra e parlate col vostro relatore.

Elementi di stile

• Non mettere virgole fra il soggetto e il predicato.
  • Sbagliato: Questo comportamento, ha indotto...
  • Corretto: Questo comportamento ha indotto...

• Rispetto al lavoro svolto, scrivere al passato e non al presente o, peggio, al futuro. In pratica non si usa mai il tempo futuro se non nel capitolo "Conclusioni e sviluppi futuri"!
  • Sbagliato: ... in questa tesi si vuole realizzare un sistema...
  • Corretto: ... in questa tesi è stato realizzato un sistema...

• Scrivere in positivo e non in negativo.
  • Sbagliato: ... il nostro sistema non si propone come una soluzione per il problema A...
  • Corretto: ... il nostro sistema si propone come una soluzione per il problema B...

• Non scrivere come si parla.
  • Sbagliato: ... l'idea suona grossomodo così...
  • Corretto: ... l'idea si può esprimere come segue:...
  • Sbagliato: ... e quindi salire con i valori del parametro...
  • Corretto: ... e quindi aumentare i valori del parametro...
  • Sbagliato: ... tale risultato non è da prendere come un fallimento...
  • Corretto: ... tale risultato non è da considerare un fallimento...

• Scrivere in italiano cercando di eliminare i termini inglesi (nel limite del possibile: per esempio hardware, software e file sono intraducibili).
  • Sbagliato: ... multiagent...
  • Corretto: ... multiagente (oppure: molti agenti)...
  • Sbagliato: ... game theory...
  • Corretto: ... teoria dei giochi...
  • Sbagliato: ... self-interested...
  • Corretto: ... egoista...

• Se si usano delle parole in inglese, non mettere la "s" per il plurale.
  • Sbagliato: ... i robots...
  • Corretto: ... i robot...
  • Sbagliato: ... i pixels...
  • Corretto: ... i pixel...

• Siate precisi e specifici.
  • Sbagliato: Le tecniche che descriveremo potranno essere usate per tutti i tipi di ricostruzione...
  • Corretto: Le tecniche che descriveremo in questa tesi potranno essere usate per tutti i tipi di ricostruzione...
  • Corretto: Le tecniche che descriveremo nel Capitolo 4 potranno essere usate per tutti i tipi di ricostruzione...

• Traducete "return" con restituisce e non con "ritorna":
  • Sbagliato: ... la funzione ritorna un valore...
  • Corretto: ... la funzione restituisce un valore...

• Mantenete la coerenza nel manoscritto. Se ad un certo punto parlate di "ricostruzione virtuale", nelle sezioni seguenti non usate "riassemblaggio virtuale" per denotare lo stesso concetto, ma continuate a usare "ricostruzione virtuale".

• Non usare "calcolatore" ma "elaboratore" o il termine inglese "computer" ormai utilizzato anche in italiano.

• Non si inizia una frase in italiano con "ma" o "però". Inoltre si mette una virgola davanti al "ma".

Elementi di formato

• Non inserire spazi prima della virgola, del punto e virgola, dei due punti, del punto, del punto esclamativo, del punto di domanda; niente spazi tra un articolo e l'apostrofo, e tra l'apostrofo e la parola seguente. Inoltre non mettere spazi dopo la parentesi aperta e prima della parentesi chiusa.
  • Sbagliato: ... dell' interazione...
  • Corretto: ... dell'interazione...
  • Sbagliato: ...( regole o insiemi di regole ) ...
  • Corretto: ... (regole o insiemi di regole)...
  • Sbagliato: ... molto semplici ;...
  • Corretto: ... molto semplici;...

• Non usare le virgolette se non strettamente necessario.
  • Sbagliato: ... mi sono soffermato su alcune "scelte di progetto"...
  • Corretto: ... mi sono soffermato su alcune scelte di progetto...

• Usare le iniziali maiuscole solo per i nomi propri di persona e non per i termini tecnici.
  • Sbagliato: ... Cooperazione...
  • Corretto: ... cooperazione...

• Usare le maiuscole quando si richiamano nel testo figure, capitoli o sezioni indicandole con il numero corrispondente. Non usare le maiuscole quando si fa riferimento a figure, capitoli o sezioni senza indicarle con il loro numero.
  • Sbagliato: ... nella figura 2.1...
  • Corretto: ... nella Figura 2.1...
  • Sbagliato: ... come illustrato nel capitolo 3...
  • Corretto: ... come illustrato nel Capitolo 3...
  • Sbagliato: ... l'algoritmo descritto nella Sezione precedente...
  • Corretto: ... l'algoritmo descritto nella sezione precedente...
  • Sbagliato: Nel presente Capitolo introduciamo il concetto...
  • Corretto: Nel presente capitolo introduciamo il concetto...

• Aggettivo, soggetto e verbo devono concordare in genere e numero.
  • Sbagliato: ... il nostri algoritmo...
  • Corretto: ... il nostro algoritmo...
  • Sbagliato: ... noi ha implementato...
  • Corretto: ... noi abbiamo implementato...

• Usare le lettere accentate.
  • Sbagliato: ... ne questo ne quello...
  • Sbagliato: ... nè questo nè quello...
  • Corretto: ... né questo né quello...
  • Sbagliato: ... poiche...
  • Sbagliato: ... poichè...
  • Corretto: ... poiché...
  • Sbagliato: ... perche...
  • Sbagliato: ... perchè...
  • Corretto: ... perché...

• La consonante eufonica 'd' si aggiunge dopo una congiunzione se il nome dopo inizia con la stessa vocale (fa eccezione la locuzione "ad esempio")
  • Sbagliato: ... ad un certo punto...
  • Corretto: ... a un certo punto...
  • Sbagliato: ... ed altri ancora...
  • Corretto: ... e altri ancora...
  • Sbagliato: ... e eventualmente...
  • Corretto: ... ed eventualmente...
  • Sbagliato: ... a esempio...
  • Corretto: ... ad esempio...

• Per abbreviare "ad esempio" potere utilizzare "e.g.," per abbreviare "cioè" potere utilizzare "i.e.,".

• Usare il corsivo solo la prima volta che si introduce un termine o quando lo si definisce.

• Cominciare un nuovo paragrafo (o capoverso o sezione) con l'iniziale maiuscola. Il primo paragrafo di una sezione non va indentato, i successivi sì.

• Terminare ogni frase con un punto.

• Ogni frase di un elenco puntato o numerato deve chiudersi con una virgola, con un punto e virgola o con un punto (fate una scelta e rispettatela coerentemente in tutto il manoscritto). L'ultima frase dell'elenco si deve chiudere con un punto.

• Tutte le figure (tabelle) devono essere richiamate nel testo. I richiami devono essere uniformi nello stile: per esempio, scegliete se usare "Fig. X.Y" ("Tab. X.Y") oppure "Figura X.Y" ("Tabella X.Y") e mantenete sempre lo stesso formato.

• Il formato delle didascalie di figure e tabelle deve essere uniforme. O tutte iniziano con la maiuscola o tutte iniziano con la minuscola, o tutte terminano con un punto o tutte terminano senza punto, e così via.

• I puntini di sospensione devono essere sempre tre: "...".

• Mantenete uniformità nello scrivere i nomi. Se avete denotato un oggetto come "LonMark", poi scrivetelo sempre così e non, per esempio, "Lonmark".

• Le immagini vanno allineate in alto o in basso alla pagina e non "annegate" nel testo. Inoltre, per quanto posibile, andrebbero messe subito dopo la citazione.

• Indice, capitoli, bibliografia, etc., iniziano sempre nella pagina dx.

Informazioni generali sul formato

Nel caso dello stile LaTeX fornito il formato e l'impaginazione sono già corrette. Qualora si voglia usare uno strumento di editing alternativo si consiglia di attenersi alle seguenti semplici regole di formattazione. In ogni caso, nel paccheto latex per la formattazione che trovate più sopra c'è un file pdf d'esempio.

• La numerazione di sezioni e appendici segue il seguente schema:
  • Sezioni:

1 TITOLO 
1.1 Sottosezione 
1.1.1 Sottosottosezione 
... 

• • Appendici:

A TITOLO 
A.1 Paragrafo appendice 
A.1.1 Sottoparagrafo appendice 
... 

• Figure e tabelle: N.N dove N.N=numero sezione o lettera appendice.numero progressivo nella sezione.

• Si consiglia l'uso dell'header sottolineato in tutte le pagine delle sezioni tranne la prima, header che deve contenere il numero della sezione e il titolo. Si consiglia inoltre il footer sottolineato con il numero della pagina.

• La bibliografia deve contenere nelle sezioni un numero contenuto in parentesi quadre [X], e nella bibliografia lo stesso numero contenuto in parentesi con riportati a fianco gli autori, il titolo, il riferimento (rivista, tesi, rapporto interno, raccolta articoli), l'anno di pubblicazione, l'editore ed eventualmente il numero di pagina.

• Si possono usare caratteri di scrittura a scelta, meglio se True Type, si consiglia una dimensione di 11 o 12 e un interlinea (singola, 1/2 o doppia a piacere). La stampa della tesi finale deve essere fronte e retro.

Producing videos and publishing them

• Usually, at the end of the project, people tend to produce a video and put it on the web. The best way to do this is to produce a video and then send it to Andrea Bonarini to have it published on the YouTube channel of the AIRLab. Then you can put the link wherever you want, hopefully also in the page of your project on AIRWiki, as done, e.g. in ROBOWII