Kandidaatintyön tarkistuslista Erno Salminen Tampereen Teknillinen Yliopisto 2013-01-07
Tarkoitus = Älä palauta kuraa Lyhyt lista asioista, jotka usein menevät pieleen ekalla yrityksellä 1. Rakenne: johdanto ja oma osuus 2. Kuvat ja taulukot 3. Lyhenteet ja engl.kieliset termi 4. Viitteet 5. Yhteenveto Nämä kämmäämällä voi erinomaisen helposti kiristää tarkastajien hermoja
Miten aloitan kirjoittamisen Haet tiedekunnan dokumenttipohjan Siisteyttä ja mielenterveyttä arvostavat käyttävät Latexia Luot työlle rakenteen, ts. 1. ja 2. otsikot ja generoit sisällysluettelon Hahmottelet esim. ransk.viivoilla kunkin luvun avainasiat Hahmottelet mistä asioista tarvitset kuvia ja taulukoita Etsit esim. 5-15 asiaankuluvaa viitettä
Johdanto Kerro työsi tavoitteet Tämä kandidaatintyö käsittelee videokuvan käsittelyyn liittyvän algoritmin nopeuttamista...tavoitteena on saavuttaa perustasoisella uudella tietokoneella suoritusnopeus 40 megapikseliä sekunnissa, kun se aiemmassa prototyypissä on n. 10 megapikseliä sekunnissa. Laita heti alkuun kuva mihin työsi liittyy Lukija on heti kärryillä mitä tuleman pitää Mielellään jo 1. sivulle Näytä ympäristö oleellisilta osin (muut ohjelmat, laitteet, ihmiset jne.) ja laita oma osuutesi keskelle Kuvaa mitä menee sisään ja mitä tulee ulos
Esimerkkejä aihealueen kuvaamisesta [Petteri Aimonen, Videokuvan keskihajonnan laskennan nopeusoptimointi SSE2-käskykannan avulla, kandidaatintyö, TTY, 2010] [Marko Viitanen, H.264 liikkeenestimoinnin testaus ja optimointi, kandidaatintyö, TTY, 2010]
Esimerkkejä aihealueen kuvaamisesta (2) ES: Huomaa kuinka kuvakaappaukset selventävät aihepiiriä verrattuna geneerisiin laatikoihin! [Veini Lehkonen, Katsaus OpenCore-sivuston vapaasti jaettaviin valmiisiin VHDL-kielisiin aritmetiikka- ja järjestelmäpiiriprojekteihi, kandidaatintyö, TTY, 2010]
Oma osuus Muista korostaa mikä on itse tehtyä ja mikä saatiin valmiina Esimerkiksi lohkokaaviossa korosta paksummalla viivalla tai eri värillä ise suunnittelmasi osat Paritöissä pitää erotella tekijöiden omat osuudet (pari lausetta piisaa) Sivumääräisesti oman työn kuvaus pitää olla yli puolet, miel. esim. ¾ sivuista Yo. ohjeet eivät suoraan sovellu kirjallisuusselvityksiin, mutta niissäkin pitää olla selkeästi omaa pohdintaa, yhteeenvetoa, ja/tai kehitysehdotuksia
Hyvä esimerkki oman osuuden merkkaamisesta Selitä värit ja symbolit (esim. erityyppiset nuolet tai viivatyypit) [Antti Kojo, Langattoman sensoriverkon käyttäjärajapinta, kandidaatintyö, TTY, 2009]
Sivubudjetti Älä jaarittele taustoja liian pitkälti ( Jo muinaiset roomalaiset ) Älä myöskään hyppää heti 1. sivulla yksityiskohtien syövereihin Kuvaile taustat niiltä osin, kuin ne liittyvät työhön Aloita yksinkertaisilla kansantajuisille asioilla Lisää vähitellen yksityikohtia Lopeta yksinkertaisilla kokoavilla kommenteilla
Esimerkki sivubudjetista 1. Johdanto 1-2s 2. Taustat, teoriat, valmiit osat 3-6s 3. Ratkaisun perusidea, vaihtoehdot 2-3s 4. Oma tuotos tarkemmin 5-7s 5. Tulokset 2-4s 6. Yhteenveto 1s Yhteensä15-25sivua +tiivistelmä+lyhennelista+viitteet+optionaaliset liitteet
Kuvat, taulukot, yms.
Kuvat ja taulukot Suosi kuvia ja taulukoita. Mielummin paljon kuin vähän. Suositeltava yhteismäärä >10 kpl per kandityö Kaikkiin viitataan tekstissä Kuva 1 esittää toteutetun järjestelmän... Kaikista selitetään tekstissä mitä pitäisi nähdä ja oppia Kaikilla on numeroitu nimi (= kuvateksti, engl. caption) Mieluiten juokseva numerointi 1,2,3... Mainitse oleellisimmat jutut myös kuvatekstissä Kuva/taulukon ja kuvatekstin on mahduttava yhdelle sivulle Kuvan alla, mutta taulukon yläpuolella
Kuvat ja taulukot (2) Tarkastajalla saattaa olla vahvat mielipiteet siitä kuinka kuvat tehdään... Ks. ehdottomasti myös: Erno Salminen, Practical advice for writing publications, lecture notes on course TKT-9617 Scientic publishing, Tampere University of Technology, 2011, [online], http://www.cs.tut.fi/~ege/misc/salminen_fig ures_styles_v14.pdf
Kuvat ja taulukot (3) Valokuvat (ja kuvakaappaukset) ovat parhaita! Varsinkin yhdistettyinä periaatekuviin Varmista, että suunta on sama (esim. valotiivis osa molemmissa vasemmalla) [Antti Alhonen, Elokuvalaboratorion digitaaliset säätöjärjestelmät, kandidaatintyö, TTY, 2009] Hyvä kuvateksti!
Taulukkoihin vain vähän viivoja Älä tuhlaa mustetta ylimääräisiin viivoihin, jos taulukko pysyy luettavana ilmankin Tosin vaakaviivoja kannattaa käyttää jos solun teksti vie monta riviä Esim. 4-5 rivin välein, kun taulukossa on tosi monta riviä Samoin pystyviivojakin kannattaa käyttää nimen ja tulosten välissä eri kategorioihin kuuluvien tulosten välillä Tapa Tulos1 Tulos2 Tapa Tulos1 Tulos2 Tapa Tulos1 Tulos2 asd 1.0 11 asd 1.0 11 asd 1 11 sdf 2 22 sdf 2 22 sdf 2 22 fgh 4 1 fgh 4 1 fgh 4 1 Versio 1. Liikaa viivaa Versio 2. Viivat korjattu Versio 3. Kirjasintyyli ja asemointi ok
Valokuvien annotointi Merkitse tekstilaatikoilla valokuviin mikä osa on mikäkin Kuva 2.1. [Janne Kulmala ja Juho Järvinen, Doom FPGA-kehityslaustalla, kandidaatintyö, TTY, 2010] Kuva 2.2. [Harri Hannula, ARM-prosessorin energiankulutuksen mittausjärjestelmän toteutus, kandidaatintyö, TTY, 2008]
Lyhenteet Kaikki lyhenteet pitää avata ensimmäisellä mainitsemiskerralla, pl. SI-yksiköt Esim. Piiri koostuu IP-lohkoista (engl. Intellectual property)... Tämän lisäksi niistä ja käytetyistä symboleista kootaan lista työn alkuun Lista on aakkosjärjestyksessä. Paitsi heillä, jotka perustelevat vapaamuotoisella, n. 5-8 sivuisella, esseellä poikkeavan järjestyksensä Lyhenne/termi ja sen selite erotetaan sarkaimella (engl. tabulator) Kannattaa lisätä lyhyt suomenkielinen selvennös Selvennös EI yleensä ole sanatarkka suomennos, siispä IP-lohko on mielummin uudelleenkäytettävä lohko kuin älyllinen omaisuus, vrt. peliohjain vs. ilotikku
Ulkomaiset termit Työ tehdään suomeksi, joten pääsääntönä on käyttää suomenkielisiä termejä Monesti pitää kuitenkin mainita mistä englanninkielisestä termistä on kyse Erityisesti kun suomennat itse Erityisesti kun kuvissa esintyy engl.kielisiä sanoja Esim. Isäntälaite (kuvassa master) aloittaa siirron... Aina ei löydy kätevää suomennosta, mutta ummikkojenkin pitää ymmärtää tekstisi Esim. Handsfree toiminto (sananmukaisesti kädet vapaana) Huomaa välilyönti ennen yhdysviivaa, kun alkuosa koostuu useammasta sanasta, Esim. Place and route vaihe, tee se itse periaate
Ulkomaiset termit (2) Varsinkin 1. käyttökerralla engl.kielisen lyhenteitä kannattaa selittää suomenkielisellä sanalla esim. UART-liityntä eikä pelkkä UART Pitää olla väliviiva eli yhdysmerkki Myöh. käyttökerroilla voi selitteen jättää välillä pois Yhdysmerkki tulee listan kaikkiin sanoihin: Käytetään sekä UARTettä SPI-liityntöjä Tarkenne voi olla myös edessä Tiedostojärjestelmä FAT32 tukee Osa termeistä/nimistä kannattaa kursivoida tai erottaa fontilla Suoritus alkaa tilasta initialize_system Käyttäjä suorittaa komennot./configure ja./make Vältä runsasta ulk. termien, lyhenteiden ja versionumeroiden käyttöä ja korvaa ne ajoittain yleiskielisillä termeillä
Värikäs esimerkki Työ toteutettiin Alteran FPGA-piirille (engl. Field Programmable Gate Array) Cyclone II EP2C35 [ref]. Suunnittelu syntesoitiin Quartus-ohjelmalla (ver 9.1 SP2) [ref] FPGA:n perusidea on Piirin sisällä 4 lohkon ryhmiä Nimet taivutetaan suoraan (*) ilman kaksoispistettä (*) paitsi kikkailunimien, kuten Versalles n, tapauksessa 1. kerralla lyhenteisiin ja nimiin lisätään väliviivalla yleiskielinen tarkenne 1. kerralla lyhenteet avataan Laitteista ja ohjelmista mainitaan tarkka versio Viitteitä käytetään runsaasti Lyhenteet taivutetaan kaksoispisteen kera Lyhenteitä ja vierasperäisä sanoja kannattaa välillä kiertää yleiskielisellä termillä, jos asiayhteys on selvä Numeroa ei tarvitse taivuttaa, jos seuraava sanaa määrää sijamuodon. Juuri mitään lukuarvoja ei kannata kirjoittaa kirjaimin, siispä 4 eikä neljän
Viitteet Oltava oikein muotoiltuina heti ensimmäisestä palautuksesta lähtien Sopiva määrä esim. >10 kpl Mielummin kirjoja, lehti- ja konfenressiartikkeleita, datalehtiä ja manuaaleja kuin satunnaisia www-löytöjä Ks. esim. http://ieeexplore.ieee.org/xplore/dynhome.jsp?tag=1 Muotoile johdonmukaisesti Viitetietojen copy-pastettaminen satunnaisista paikoista ei siis missään nimessä käy Annettujen viitetietojen järjestys aina samalla tavalla esim. nimi, otsikko, julkaisufoorumi, sivut, vuosi Vaikka kielikeskus sanoisi mitä, niin viite on sadasti nätimpi osana virkettä, eli siis ennen pistettä [Salminen, 2011].
Viitteiden muotoilu: perustarkitukset Oikeasti viittaat kaikkiin tekstissä Ristiviittaukset ovat kunnossa, ei siis: Rosenbaumin menetelmä [??] on parempi kuin Harrisin [REF!not found] Mieluiten ensimmäisen kirjoittajan sukunimen mukainen aakkosjärjestys Viittausjärjestyskin käy, muut tavat eivät käy Tekijä: mieluiten muotoa X. Öllquist eikä Xavier Öllquist tai Öllquist, X. Eka tyyli paras, aakkostetaan silti Ö:n kohdalle Työn otsikko: Aikakoneen suunnittelu ja toteutus vs. sama ilman hipsuja Konferenssin tiedot: In proc. ISCAS vs. In ISCAS vs. ISCAS vs. International Symposium on Circuits and Systems Paikkatieto vai ei Kuukausi vai ei Sivut ilmoitettu vai ei Julkaisija vai ei
Viitteiden muotoilu (2) : www Pelkkä URL ei kertakaikkiaan käy Koita löytää tekijä ja otsikko vaikka kyseessä olisikin www-linkki Linkit vanhenevat ääntä nopeammin, muut tiedot eivät joten niitten avulla dokumentti voi löytyä vielä myöhemminkin Engl.kielisiä suht ok esimerkkejä [1] Nanoscale Integration and Modeling Group, Predictive technology model, Arizona State University, [online], http://www.eas.asu.edu/ptm/, 2006. [2] Wikipedia contributors, "Field-programmable gate array," Wikipedia - The Free Encyclopedia, [online], accessed March 24, 2010.
Yhteenveto Työn tärkein sivu! Saavutettiinko työn tavoitteet? Mitkä olivat tärkeimmät tulokset? Mitä työvaiheita oli? Kauanko niihin kului aikaa (summittainen arvio, esim. 10h-resoluutiolla) (Paljonko ovat suunnitellun laitteen kustannukset?) Mitkä asiat onnistuivat? Mitkä asiat olisit voinut tehdä paremmin? Mitä voisi jatkossa parantaa?
Esimerkki yhteenvedosta Tavoite saavutettiin! Ei jää epälseväksi. Hyvä. Taulukko kertoo pikavilkaisulla kaiken oleellisen työstä. Hyvä. Ihan parasta olisi aloittaa työn tarkoituksella (nyk. 2. rivi) Eksakteja tuloksia kompleksisuudesta. Hyvä. Laadullinen analyysi. Hyvä. [Petteri Aimonen, Videokuvan keskihajonnan laskennan nopeusoptimointi SSE2-käskykannan avulla, kandidaatintyö, TTY, 2010]
Esimerkki yhteenvedosta (2) Työtä voi joku muukin hyödyntää! Hinta-arvio, jos joku haluaa rakentaa samanlaisen [Petri Österman, Polkupyörän automaattivaihteisto, kandidaatintyö, TTY, 2010]
Luettavaa Kielitioimiston ohjeita http://www.kotus.fi/index.phtml?s=297 Jukka Korpelan ohjeita http://www.cs.tut.fi/~jkorpela/suomi/indeksi.ht ml