TEOKSEN NIMI YHDELLE TAI USEAMMALLE RIVILLE

Transkriptio

1 Opinnäytetyö (AMK) Tietoliikenne ja sähköinen kauppa Suuntautumisvaihtoehto 2009 INSINÖÖRITYÖN KIRJOITUSOHJEET Näitä ohjeita sovelletaan Elektroniikan ja Tietotekniikan koulutusohjelmissa. Ohjeita voi soveltuvin osin käyttää tukena myös tekniikan ylempien AMK-tutkintojen opinnäytetöitä kirjoitettaessa instydoc6.pdf Etunimi Sukunimi TEOKSEN NIMI YHDELLE TAI USEAMMALLE RIVILLE mahdollinen alaotsikko tähän

2 ii OPINNÄYTETYÖ (AMK) TIIVISTELMÄ TURUN AMMATTIKORKEAKOULU Koulutusohjelman nimi Suuntautumisvaihtoehdon nimi Opinnäytetyön valmistumisajankohta Sivumäärä Ohjaaja(t): Tekijä(t) TEOKSEN NIMI (Kirjoita tiivistelmä tähän, maksimi merkkimäärä on 2000). Insinööritutkintoon kuuluu olennaisena osana opinnäytetyö (tässä dokumentissa lyhennettynä muotoon insinöörityö), jossa tarkoituksena on kehittää opiskelijan kykyä itsenäiseen työskentelyyn ja siitä raportointiin. Tässä oppaassa esitetään insinöörityön tyypillinen rakenne ja annetaan ohjeita työn yleisiin muotoseikkoihin teknistieteellisestä näkökulmasta katsottuna. Tyylissä ja rakenteessa on pyritty noudattamaan näitä ohjeita niiltä osin kuin se on mahdollista, jotta tämä opas muistuttaisi ulkoasualtaan tyypillistä insinöörityötä. Oppaassa esitetään lyhyesti tavanomaisia käytäntöjä työn rakenteen ja sisällön osalta. Yksityiskohtaisemmin tarkastellaan alalla vallitsevia käytäntöjä sellaisissa kohdissa, kuten kuvien, taulukoiden, kaavojen, ohjelmakoodin ja viittausten tekemisessä. Oppaaseen on sisällytetty myös joitakin suomen kieleen ja matematiikkaan liittyviä näkökohtia, joissa tekstinkäsittelyohjelmia käytettäessä usein esiintyy ongelmia. Teknistieteellisessä kirjallisuudessa esiintyy monia variaatioita varsinkin muotoseikoissa. Tässä esitetyt käytännöt noudattavat elektroniikka- ja tietotekniikka-alan tyypillisiä tapoja. Niistä voi kuitenkin aina harkitusti poiketa insinöörityötä kirjoitettaessa. Mikä valittu tapa onkin, sitä tulee systemaattisesti noudattaa koko työssä. ASIASANAT: (Kirjoita asiasanat tähän. Etsi asiasanoja esim. yleisestä suomalaisesta asiasanastosta: YSA ) Huomaa, että tiivistelmän paikka on heti kansilehden jälkeen. Tiivistelmän tekstin otsikkotietoineen tulee mahtua yhdelle sivulle. Riviväli tekstissä on 1 ja kirjasinkoko 11 pistettä Arial-fontilla. Tiivistelmän tarkempaa rakennetta on selvitetty tämän dokumentin varsinaisessa tekstiosassa.

3 iii BACHELOR S THESIS ABSTRACT TURKU UNIVERSITY OF APPLIED SCIENCES Degree Programme Specialization Date Number of pages Instructor(s): Author(s) THESIS TITLE (Write the abstract here, maximum number of characters is 2000). In research and development the skill of documentation and writing reports is extremely important. One purpose of the thesis assignment in engineering studies is to improve this skill. In this report some general guidelines are given for writing a good paper. The style used in this report closely imitates the form of the thesis report. Its suggestions to writers about style, convention, and form are presented as editorial choices rather than mechanical prescriptions. KEYWORDS: (Write the keywords here) Englanninkielisen tiivistelmän Abstract ei tarvitse eikä yleensä tule olla sanatarkka käännös suomenkielisestä versiosta. Mikään ei estä lisäämästä englanninkielisen tiivistelmän jälkeen muunkin kielisiä versioita, jos sellaisia tahdot kirjoittaa.

4 iv ALKULAUSE (Kirjoita mahdollinen alkulause tähän. Ellet kirjoita alkulausetta, poista koko sivu). Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc augue metus, tristique a semper accumsan, pretium fringilla arcu. Nullam ut lectus magna. In dictum mollis magna, vitae elementum diam imperdiet ac. Ut orci metus, luctus non suscipit id, varius lobortis risus. Vivamus porta, mauris in tristique pulvinar, lorem dolor molestie eros, sed semper orci turpis et nunc. Pellentesque laoreet luctus odio ut egestas. Mauris quis pretium felis. Donec a turpis risus. Integer vitae turpis a sem vestibulum placerat in ac sapien. Aenean lacinia, dolor facilisis varius hendrerit, neque lacus varius turpis, nec pellentesque nibh ipsum sed erat. Sed ornare ligula ac mi porttitor sed pretium lectus placerat. Aika ja paikka Tekijän nimi Alkulauseen voi jokainen liittää tai olla liittämättä työhön. Siinä voi kertoa taustatietoja työn tekopaikasta, tilaajasta ja ennen kaikkea kiittää työn tekemisessä avustaneita henkilöitä. Insinöörityön kirjoitusohjeet, muutoshistoria: Tämän dokumentin ensimmäinen versio LaTEXilla; TT Päivitetty versio Word 97; TT Liitetty AMK:n kaavakkeet: nimiösivu, tiivistelmäsivut; TT (instydoc4.pdf) Päivitetty versio pdf-muodossa; täydennetty ja korjattu kaikkia lukuja, lisätty ohjeet ohjelmien ja ohjelmakoodin esittämisestä, Internet-lähteisiin viittaaminen sekä luku teknisistä yksityiskohdista; TT, JPP, JR. English translation by JR available (instydoc5.pdf) Päivitetty versio: täydennetty ja korjattu kaikkia lukuja, lisätty insinöörityön tekemiseen liittyviä käytännön asioita sekä kommentteja tekijänoikeuksista; TT (instydoc6.pdf) Kirjoitusohjeet päivitetty vastaamaan AMK:n laatukäytännön mukaista teemaa. TT Tämän materiaalin tulostaminen ja kopiointi paperille sekä kopiointi pdf-muodossa on sallittu!

5 v Sisältö SISÄLTÖ V SYMBOLI- JA LYHENNELUETTELO VI 1. JOHDANTO 1 2. INSINÖÖRITYÖ JA SEN TYYPILLINEN RAKENNE Insinöörityö ja siihen liittyvät rutiinit Insinöörityön nimen ja kielen valinta sekä työn julkisuus Työn rakenne Tiivistelmä ja Abstract Insinöörityön johdanto Työn varsinainen käsittely Työn yhteenveto MUOTOSEIKAT Yleiset muotoseikat Kuvat ja taulukot Kaavat Ohjelmakoodin otteet Viittaukset TEKNISIÄ YKSITYISKOHTIA Suomen kieleen liittyviä yksityiskohtia erikoismerkkien käytöstä Erikoismerkkien kirjoittaminen Microsoft Word-ohjelmalla YHTEENVETO 31 LÄHDELUETTELO 32 LIITTEET 34 Sivunumerointi aloitetaan johdannosta ja tätä edeltävät sivut numeroidaan roomalaisin numeroin tai jätetään numeroimatta. Sisällysluettelon selkeyttä voi parantaa kirjoittamalla pääotsikot isoilla kirjaimilla. Myös sisennystä voi käyttää alalukujen kohdalla. Ammattikorkeakoulun yleisissä ohjeissa kehotetaan listaamaan myös työn kuvat, kuviot ja taulukot. Insinööritöissä tämä ei ole tarpeen, sillä niitä on keskimääräisessä työssä niin paljon, ettei listauksella saavuteta työn kannalta mitään selkiyttävää etua.

6 vi Symboli- ja lyhenneluettelo a dbc F f f IF f LO kiihtyvyys desibeliä suhteutettuna kantoaallon tehoon voima taajuus välitaajuus paikallisoskillaattorin taajuus I virta I s diodin kyllästysvirta 23 k Boltzmannin vakio ( 1,38 10 J/K) L MOSFETin kanavan pituus m massa N taajuuden jakajan jakosuhde S diodiliitoksen pinta-ala t aika heijastuskerroin seostusprofiilista riippuva vakio o liitospotentiaali reaaliosa rinnankytkentä DAC DSB DSP IF Java URL digitaali-analogiamuunnin (Digital to Analog Converter) kaksisivukaistainen (Double Sideband) digitaalinen signaalinkäsittely (Digital Signal Processing) välitaajuus (Intermediate Frequency) Sun Microsystemsin luoma olio-ohjelmointikieli Internetissä olevan sivuston tai tiedoston sekä niiden käyttöön tarvittavan yhteyskäytännön yksilöivä tunnus, WWW-sivun osoite (Uniform Resource Locator) Tämän luettelon laatimisessa noudatetaan seuraavia sääntöjä: 1. aluksi esitetään roomalaiset kirjaimet aakkosjärjestyksessä, 2. tätä seuraavat kreikkalaiset kirjaimet ja mahdolliset erikoismerkit, 3. mikäli sama kirjain esiintyy sekä isona että pienenä, aloitetaan isoista, 4. lopuksi esitetään lyhenteet ja termit. Lyhenteet tulevat usein vieraasta kielestä, kuten englannista tai ranskasta. Tällöin ei riitä pelkkä lyhenteen aukaisu kyseisellä kielellä, vaan lyhenne on käännettävä suomeksi. Lyhenteitä voi myös selittää vapaalla suomen kielellä, kuten esim. URL yllä.

7 1 1. Johdanto Keskeisen osan insinöörityöstä muodostaa työn dokumentti, joka on kirjan muotoon sidottu laaja raportti suoritetusta suunnittelu- tai tutkimustyöstä. Monille opiskelijoille insinöörityön kirjoittaminen on osoittautunut hyvin työlääksi prosessiksi. Ongelmia on ilmennyt erityisesti työn sisältöön liittyvissä yksityiskohdissa ja muotoseikoissa. Insinöörityön aihe vaikuttaa merkittävästi siitä tehtävän dokumentin sisältöön. Systemaattista menetelmää, jolla selviää kaikesta, niin multimediaan kuin elektroniikan laitesuunnitteluunkin liittyvästä dokumentoinnista, ei siten ole mahdollista esittää. Työn karkea runko on kuitenkin kaikissa insinööritöissä samankaltainen. Lisäksi työhön kuuluu osia, joissa tulee esittää määrättyjä asioita. Näitä osia ovat esimerkiksi johdanto, yhteenveto sekä työn tiivistelmä. Tämä dokumentti pyrkii helpottamaan erityisesti näiden osien kirjoittamista. Monissa muotoseikoissa, kuten esimerkiksi viittausten ja matemaattisten kaavojen esittämisessä tai jopa sivujen numeroinnissa, esiintyy eri tieteiden aloilla toisistaan olennaisesti eroavia tapoja. Ammattikorkeakouluissa, joissa koulutusalat ulottuvat ihmistieteistä tekniikkaan ja taiteeseen, ei yhtä kaikilla aloilla käytettävää ohjetta ole tarkoituksenmukaista luoda. Tässä dokumentissa annetut ohjeet pohjautuvat elektroniikan ja tietotekniikan alalla vallitsevaan käytäntöön asioiden esittämiseksi. Ohjeet pätevät vain kyseisiin koulutusohjelmiin tehtävissä insinööritöissä. Ohjeet sisältävät monia yksityiskohtia ja variaatioita, joista voit harkitusti poiketa, jos niin sovit työsi ohjaajan kanssa. Joissakin muotoseikoissa on toki yhtenäisen ulkoasun saamiseksi noudatettava ammattikorkeakoulussa vallitsevaa käytäntöä. Näitä ovat opinnäytetyön kansien väri sekä nimiö- ja tiivistelmäsivun rakenne. Tämän dokumentin (pdf-muotoisessa) ulkoasussa on pyritty noudattamaan insinöörityön muotoseikkoja. Dokumentin luvussa 2 käsitellään lyhyesti insinöörityötä ja siihen liittyviä käytännön rutiineja sekä työn karkeaa sisältöä. Luku 3 keskittyy tärkeimpiin muotoseikkoihin mm. tekstin, kuvien, kaavojen, ohjelmakoodin ja viitteiden osalta. Luvussa 4 esitetään sellaisia teknistieteellisille raporteille olennaisia yksityiskohtia, joissa on aiemmissa insinööritöissä esiintynyt ongelmia. Tämän dokumentin kirjoittamisessa on käytetty Arial-fonttia, mutta jos työ sisältää kaavoja ja symboleita ovat Cambria tai Times New Roman ehdottomasti suositeltavampia! Jos käytät kaavaeditoria, tarkista myös mitä kirjasintyylejä se tukee. Tekstin ja kaavojen tulee olla samalla kirjasintyylillä tehtyjä!

8 2 2. Insinöörityö ja sen tyypillinen rakenne Tässä luvussa tarkastellaan insinöörityötä ja siihen liittyviä rutiineja sekä työstä laadittavan raportin tyypillistä sisältöä ja rakennetta. Lisäksi annetaan vinkkejä siihen, mitä työn keskeisimmissä osissa: johdannossa, yhteenvedossa ja tiivistelmässä, tulee esittää. 2.1 Insinöörityö ja siihen liittyvät rutiinit Insinöörityö sisältyy insinööri (AMK) -tutkinnon loppuvaiheen opintoihin. Laajuudeltaan se on 18 opintopistettä, mikä käytännössä tarkoittaa noin kolmen kuukauden täyspäiväistä työpanosta, jos opiskelija keskittyy pelkästään insinöörityön tekemiseen. Käytännössä työn aiheeseen perehtyminen, työn toteutus (esim. tehtäväksi saadun laitteen suunnittelu, rakentelu ja testaus mahdollisine iterointeineen) sekä varsinaisen raportin kirjoittaminen vaatii usein huomattavasti pidemmän ajan. Työn ohjaaja(t) Tyypillisesti opiskelija pyrkii etsimään insinöörityön aiheen yrityksistä, eli ammattikorkeakoulun ulkopuolelta. Insinöörityöllä on aina vähintään yksi ohjaaja ammattikorkeakoulussa. Tämä on normaalisti suuntautumisvaihtoehdosta vastaava yliopettaja. Yrityksessä työllä voi olla myös toinen ohjaaja, jollaisena yleensä toimii lähin esimies tai projektikollega, joka on itse tehnyt insinöörityön tai jonkin tiedekorkeakoulun opinnäytteen. Tämän ohjaajan tehtävänä on auttaa päivittäisissä työssä esiin tulevissa ongelmissa. Ohjaajana toimiva opettaja puolestaan tarkastelee insinöörityötä, sen tavoitteita ja niiden toteutumista yleisemmällä tasolla. Hän myös huolehtii yhdessä äidinkielen opettajan kanssa siitä, että insinöörityö kirjallisena tuotteena täyttää opinnäytteelle asetettavat minimivaatimukset. Aiheen hyväksyttäminen, tapaamiset ohjaajan kanssa ja seminaarit Insinöörityön aihetta valittaessa on syytä hyvissä ajoin keskustella potentiaalisesta työn aiheesta ja/tai hyväksyttää kyseinen aihe suuntautumisvaihtoehdosta vastaavan yliopettajan kanssa. Hänen kanssaan on hyvä keskustella myös työn tavoitteiden asettelusta ja aiheen mahdollisesta rajaamisesta, jotta insinöörityö saataisiin järkevällä aikataululla suoritettua ja ennen kaikkea dokumentoitua kirjan muotoon.

9 3 Sovi insinöörityön ohjaajan kanssa käytännön rutiineista, kuten mahdollisista välitapaamisista ja dokumentointivaiheessa käsikirjoitusversioiden tarkistuskäytännöistä. Opinnäytetyön tekemistä voidaan ohjata myös seminaareissa. Tällöin opiskelija osallistuu seminaarityöskentelyyn ja esittää työnsä sovitut vaiheet aloitusseminaarissa ja väliseminaareissa. Opiskelija etenee opinnäytetyönsä toteuttamisessa seminaareissa esitettyjen ja ohjaajan hyväksymien suuntaviivojen mukaisesti. Seminaarikäytännöt vaihtelevat jopa suuntautumisvaihtoehdoittain, joten selvitä tämä asia ohjaajasi kanssa. Muista myös, että työn ohjaajilla samoin kuin äidinkielen opettajalla saattaa olla samanaikaisesti useita töitä tarkastettavanaan ja muita opetukseen liittyviä rutiineja hoidettavanaan. Tämän vuoksi on tarkastuskierrokseen varattava riittävästi aikaa erityisesti vuoden kiireisimpinä hetkinä. Tällaisia ovat esimerkiksi loppukevät sekä marras-joulukuu. Käsikirjoitusten tarkastuskierroksilla on liitettävä mukaan myös mahdollinen edellinen kommentoitu versio, jotta ohjaaja näkee työn edistymisen ja muistaa aiemmat kommenttinsa. Kypsyysnäyte Työn loppuvaiheessa on kirjoitettava kypsyysnäyte, joka on konseptiarkin mittainen yleistajuinen kirjallinen esitys insinöörityöhön liittyvästä, ohjaajan määräämästä aiheesta. Kypsyysnäytteellä testataan insinöörityön tekijän suomen (tai ruotsin) kielen hallinta ja se, että työ on tehty itse. Kypsyysnäyte kirjoitetaan koulusivistyksen määräämällä kielellä! Eli esimerkiksi ruotsinkielisen lukion käynyt kirjoittaa sen ruotsin kielellä, eikä suomeksi, vaikka muutoin olisi pääasiassa suomea puhuva! Jos opiskelija on saanut koulusivistyksensä jollakin muulla kielellä kuin suomeksi tai ruotsiksi, koulutuspäällikkö päättää kypsyysnäytteen kielen. Seuraavat ohjeet kypsyysnäytteen kirjoittamisesta ovat ohjeellisia ja käytäntö eri ohjaajilla saattaa poiketa tässä dokumentissa mainitusta: Kypsyysnäytteen voi useimmiten kirjoittaa laboratorion tiloissa ja sen voi yhdistää esimerkiksi samaan kertaan, jolloin pitää työstä suullisen esityksen. Suositeltava aika kirjoittamiseen on kaksi oppituntia, mutta kirjoittamiseen voi käyttää usein enemmänkin aikaa. Kypsyysnäytettä varten opiskelija saa kaksi tai kolme työhön liittyvää aihetta. Näistä aiheesta valitaan yksi, josta kirjoitetaan aivan tavallinen kouluaine. Sopiva kypsyysnäytteen laajuus on noin neljä (tiheäruutuisen) konseptipaperin joka toiselle

10 4 riville käsinkirjoitettua sivua. Kirjoittamista varten on syytä ottaa mukaan konseptipaperia ja kirjoitusvälineet! Kypsyysnäyte arvostellaan periaatteella hyväksytty/hylätty. Hylätyn kypsyysnäytteen voi uusia. Koska kysymys on ennen kaikkia äidinkielen osaamisen hallinnasta, on kypsyysnäytteen kirjoittaminen tehtävä huolella. Kirjoittaessa on syytä tarkistaa, että kirjoitelmassa on otsikko; teksti on jaettu kappaleisiin; välimerkit, isot ja pienet alkukirjaimet, yhdyssanat, päätteet lyhenteissä, pisteet ja pilkut ovat oikein; ja että tekstissä ei ole oikeinkirjoitusvirheitä. Suullinen esitys Insinöörityöstä tulee ennen sen hyväksymistä pitää myös noin 20 minuutin mittainen yleistajuinen suullinen esitys tehdystä työstä ja saavutetuista tuloksista. Sovi työn ohjaajan kanssa tavasta, ajasta ja paikasta. Vaikka esitelmä usein pidetään samalla kertaa, kun kirjoittaa kypsyysnäytteen, niin esitelmä voidaan toki pitää muunakin aikana, esimerkiksi loppuseminaarin yhteydessä. Toisinaan esitelmä voidaan pitää jo esimerkiksi esitutkimusvaiheen jälkeen, jolloin esitelmään valmistumisella voi selkiyttää ja jäsennellä työn sisältöä ja tavoitteita, ja tarvittaessa jopa muuttaa niitä. Esitelmä pidetään yleensä luokassa, jolloin käytössä on vähintäänkin videotykki ja tussi- tai liitutaulu. Esitystä kannattaa havainnollistaa laitteen prototyypillä, ohjelmistodemonstraatiolla tai muulla havaintomateriaalilla. Esitelmän kesto noudattelee (tieteellisissä) konferensseissa käytettyä kaavaa: 20 minuutin esitelmä ja 5 10 minuuttia keskustelua. Ajankäyttö voidaan jakaa esimerkiksi seuraavasti: Käydään läpi esityksen asiasisältö ja rakenne (1 min) Esitellään yritys tai laitos tekniikkapainotteisesti (2 min) Esitetään työn tausta ja reunaehdot (4 min) Kerrotaan työn tekemisestä (10 min) Tehdään yhteenveto ja hahmotellaan tulevaisuus (3 min). Työn arviointi Tutkintosäännön mukaan insinöörityöstä annetaan arvosana asteikolla 0 5. Käsitys, minkä työn ohjaaja ja mahdolliset muut arvioijat saavat tehtävän suorituksesta, perustuu pääosin työstä tehtyyn kirjalliseen selostukseen. Insinöörityö on selostus

11 5 tehdystä työstä, käytetyistä menetelmistä ja työn yhteydessä tehdyistä ratkaisuista perusteluineen. Insinöörityö ei ole käyttöohje tai tuotekäsikirja ja siinä on ehdottomasti vältettävä kuvaamasta pelkästään lopputuloksen ominaisuuksia. Tavoitteena on loogisesti etenevä ja hyvin jäsennelty teksti. Hyvän asiatyylin tärkeimpiä ominaisuuksia ovat täsmällisyys ja havainnollisuus. Tekstikappaleita ei muodosteta toisiaan seuraavista irrallisista virkkeistä, vaan virkkeiden tulee kytkeytyä luontevasti toisiinsa. Koko raportilla tulee olla yhtenäinen juoni, jonka mukaan se etenee. Insinöörityössä käytetään asiatyylistä, toteavaa, passiivimuotoista esitystapaa. Työtä ei siis kirjoiteta minä- tai sinä-muodossa. 2.2 Insinöörityön nimen ja kielen valinta sekä työn julkisuus Insinöörityön nimi Insinöörityön otsikkoa eli nimeä mietittäessä ja valittaessa tulee muistaa, että sen tulee olla lyhyt, ytimekäs ja informatiivinen. Nimen pitää olla myös mahdollisimman yleistajuinen, jotta alaa tuntematonkin pystyy arvioimaan, mihin aihepiiriin työ liittyy. Nimessä tulee välttää lyhenteiden käyttöä. Vaikka lyhenteitä vilisevässä tietotekniikassa ja elektroniikassa tämä vaatimus tuntuu vaikealta, ovat lyhenteet hyväksyttäviä ainoastaan silloin kun ne ovat yleisesti tunnettuja. Tässäkään tapauksessa nimeä ei tule aloittaa lyhenteellä, numerolla tai muulla erikoismerkillä. Nimessä ei myöskään saa mainostaa yrityksen nimeä tai tuotemerkkiä. Kieli Insinöörityö kirjoitetaan yleensä Suomen virallisilla kielillä eli joko suomeksi tai ruotsiksi. Viime vuosina on myös vieraalla kielellä, tavanomaisimmin englanniksi, kirjoittaminen tullut tavalliseksi. Kummassakin tavassa on ongelmansa. Suomeksi kirjoittava joutuu painiskelemaan alan terminologian kanssa. Elektroniikan ja tietotekniikan alalla termit ovat pääosin alkuperältään englantia, mutta ne on esitettävä työssä suomen kielellä. Englanniksi kirjoittava puolestaan havaitsee yleensä, että vieraalla kielellä kirjoittaminen on sittenkin yllättävän hidasta ja hankalaa. Jos kieli on kovin takkuista, insinöörityöntekijän on varauduttava teettämään kielentarkastus joko omalla tai työn teettävän yrityksen kustannuksella ennen kuin työn ohjaaja suostuu edes kommentoimaan käsi-

12 6 kirjoitusta. Ammattikorkeakoulun kieltenopettajille ei ole varattu resursseja insinöörityön tekstiosan kielen systemaattiseen tarkistukseen ja korjaamiseen. Englanninkielisen tiivistelmän (Abstractin), joutuvat kaikki insinöörityön tekijät laatimaan. Sen kieliasu tulee tarkistuttaa englannin kielen opettajalla. Työn julkisuus, tekijänoikeus ja plagioinnin tarkistus Lain viranomaisten toiminnan julkisuudesta mukaan asiakirja, ja siten myös opinnäytetyö (insinöörityö), tulee julkiseksi sillä hetkellä kuin viranomainen (tässä ammattikorkeakoulu) saa sen. Työstä kirjoitettua dokumenttia ei siis voi hakea luottamukselliseksi, vaikka tekijä tai yritys niin haluaisikin. Siksi aihe on valittava tai rajattava alusta alkaen sellaiseksi, että kaikki insinöörityöhön sisällytettävä materiaali on julkista ja julkaistavaksi sopimaton materiaali jätetään työstä pois. Pienellä miettimisellä tosin strategisesti herkältäkin alueelta tehtävän insinöörityön pystyy rajaamaan ja kirjoittamaan siten, että sen julkistaminen ei ole ongelma. Tekijänoikeudellisessa mielessä opiskelijalla on oikeus kirjoittamaansa teokseen. Siten esimerkiksi koko insinöörityön Internetissä tai muulla tavoin sähköisessä muodossa julkaiseminen pysyy työn tekijän yksinoikeutena, eikä esimerkiksi ammattikorkeakoulu voi sitä ilman tekijän lupaa tehdä eikä velvoittaa siihen. Sähköinen julkaiseminen on kuitenkin suositeltavaa, koska tämä edistää tiedon leviämistä tutkimusalalta ja estää haitallista plagiointia. Ja vaikka koko työtä ei sähköisesti julkaistaisikaan, niin tiivistelmät kuitenkin erillisisinä asiakirjoina aina julkaistaan. Tekijänoikeuskysymykset saattavat koskettaa insinöörityötä myös toisella tavalla. Työtä kirjoittaessa joutuu keräämään aineistoa eri lähteistä. Näihin tulee hyvän tavan mukaisesti aina muistaa viitata, ellei kyseessä ole itsestään selvät tai yleisesti tunnetut asiat. Tekijänoikeuslaki sisältää oikeuden ottaa lainauksia (sitaattioikeus), mikä mahdollistaa asiayhteyteen sopivan tekstin siteeraamisen sellaisenaan tai mieluummin omin sanoin kirjoitettuna kohtuullisessa laajuudessa. Kuvien lainaaminen on ongelmallisempaa, ja esimerkiksi muiden ottamia valokuvia ei voi ilman tekijänoikeuden omistajan lupaa julkaista. Siteeraamista ja siitä tehtäviä viittauksia käsitellään tarkemmin luvussa 3.5 Viittaukset. Turun ammattikorkeakoulun kaikki opinnäytetyöt tarkistetaan Urkund-ohjelmalla, jotta opinnäytetyöntekijät välttyisivät tekijänoikeuksien loukkaamiselta. Urkund ohjelman

13 7 avulla voi turvata myös oman työnsä tekijänoikeuksia. Tarkistetut työt tallennetaan tekijän luvalla tietokantaan, jonka sisältöön uusia töitä verrataan. 2.3 Työn rakenne Insinöörityö jakautuu seuraaviin osiin, joiden järjestys raportissa on tämän luettelon mukainen: 1. nimiösivu, 2. tiivistelmä, 3. englanninkielinen tiivistelmä (Abstract), 4. alkulause (tämä voi puuttua), 5. sisällysluettelo (otsikoituna Sisältö), 6. symboli- ja lyhenneluettelo (tarpeen mukaan), 7. insinöörityön varsinainen tekstiosa ja 8. liitteet (tarpeen mukaan). Nimiösivu ja tiivistelmät laaditaan yhtenäisen formaatin mukaisesti ammattikorkeakoulun määräämään muotoon. Näihin on löydettävissä valmis pohja Turun AMK:n websivuilta. Jotta opinnäytetöiden ulkoasu olisi yhtenäinen, on korkeakoululle jäävät kopiot kansitettava työn tekijän toimesta sinisiin kansiin (ks. erillinen ohjeistus). Alkulause, mikäli sellainen kirjoitetaan, on vapaamuotoinen kirjoitelma, joka sisältää tyypillisesti kiitokset työhön keskeisesti vaikuttaneille henkilöille. Alkulauseessa voi myös kirjoittaa taustatietoja yrityksestä, jossa insinöörityö on tehty. Alkulauseen loppuun on tapana kirjoittaa päiväys ja työn tekijän nimi. Lukemisen helpottamiseksi insinöörityössä tulee olla sisällysluettelo. Tämä otsikoidaan sanalla Sisältö. Siinä listataan yllämainittujen osien lisäksi insinöörityön varsinaisen tekstiosan kaikki pää- ja alaluvut, sekä sivujen numerot, joilta luvut alkavat. Lukujen otsikoiden tulee olla kirjoitettuna täsmälleen samanmuotoisesti kuin varsinaisessa tekstissä. Työtä kirjoitettaessa on tarkkaan harkittava, kuinka pienistä tekstinosista tekee lukuja. Kaksiportainen jaottelu ja lukujen numerointi, jota käytetään tässä dokumentissa, on usein riittävä. Kolmiportainenkin on vielä mahdollinen, mutta tätä useampiportaista numerointia tulee välttää. Pienimmissä osissa, joiden erottuvuutta halutaan parantaa, voidaan käyttää ohjaavia otsikoita, joista löytyy esimerkkejä tämän

14 8 dokumentin luvuissa 2.1 ja 2.2. Ohjaavat otsikot voidaan tarvittaessa alleviivata, lihavoida tai kursivoida. Niitä ei kuitenkaan listata sisällysluettelossa. Symboli- ja lyhenneluettelo tarvitaan lähes kaikissa töissä. Tähän luetteloon on hyvä oppia keräämään kaikki työssä esiintyvät fysikaaliset suureet, symbolit sekä kirjainlyhenteet. Jos luettelo kasvaa kohtuuttoman pitkäksi, voi tyypillisen lukijan todennäköisesti tuntemia perusfysiikan symboleja jättää pois. Sisältö-sivusta sekä Symboli- ja lyhenneluettelosta on esimerkki omalla paikallaan tämän dokumentin alussa. Samaan yhteyteen on liitetty myös tiivistetyt ohjeet kyseisten osien laatimiseksi. Varsinaisen työn tekstiosa alkaa aina johdannolla. Johdantoa seuraa työn käsittely, jonka täsmällinen sisältö riippuu siitä, mitä työssä on tehty. Työn päättää yhteenveto, jossa esitetään työn tuloksista tehdyt johtopäätökset. Yhteenvedon jälkeen tulee vielä lähdeluettelo. Työhön mahdollisesti sisällytettävä ylimääräinen materiaali voidaan laittaa liitteinä työn loppuun. Insinöörityötä kirjoitettaessa kannattaa pitää mielessä, että tieteellisen dokumentin sisällössä tietyillä osilla on lukijan kannalta suurempi merkitys kuin toisilla. Jos insinöörityön osat pitää panna tärkeysjärjestykseen, on lista usein seuraavanlainen: 1. Tiivistelmä/Abstract 2. Yhteenveto 3. Johdanto 4. Tekstiosa Paljon tieteellistä kirjallisuutta lukeva tai tietohakua tekevä tutustuu yleensä ensin työn tiivistelmään selvittääkseen, mitä työssä on tehty, ja mitä tuloksia on saavutettu. Huonosti kirjoitettu tiivistelmä ei yleensä herätä lukijassa kiinnostusta dokumentin tarkempaan läpikäyntiin. Yhteenveto ja johdanto täydentävät tiivistelmästä saatavaa tietoa. Tiivistelmä ja yhteenveto sekä usein myös johdanto kannattaa kirjoittaa vasta sitten, kun työn muut osat ovat jo valmiina, ja jolloin dokumentin lopullinen sisältö on selvillä. Toisaalta alkuun pääsemisen tai ylipäätään työn edistymisen kannalta saattaa olla hyödyllistä kirjoittaa alustava versio johdannosta jo työn varhaisessa vaiheessa.

15 9 2.4 Tiivistelmä ja Abstract Insinöörityön, kuten minkä tahansa muunkin tutkielman, tiivistelmä on tärkeä, koska se arkistoidaan (haku)tietokantaan erillisenä dokumenttina. Sen tulee siten toimia itsenäisesti! Tiivistelmän ensisijaisena tarkoituksena on houkutella asiasta kiinnostuneita tutustumaan tarkemmin työhön. Toisaalta hyvä tiivistelmä riittää tietolähteeksi ja korvaa alkuperäisen opinnäytteen, milloin aihe ei ole lukijalle keskeinen. Tiivistelmässä tulee antaa selkeän objektiivinen kuva siitä, mitä työssä tehtiin ja minkälaisia tuloksia saavutettiin. Omien tulosten vähättelyyn ei tule milloinkaan ryhtyä. Tiivistelmän kirjoittamiseen pitää paneutua huolellisesti. Sen kirjoittamiseen käytetyn ajan tulisi olla moninkertainen muun vastaavan pituisen tekstin kirjoittamiseen nähden. Sanamäärällisesti tiivistelmä on lyhyt, maksimissaan noin 150 sanaa. Hyvästä tiivistelmästä tulee aina ilmetä: 1. Johtolauseena kuvaus työn ongelmakentästä, jos se katsotaan tarpeelliseksi. 2. Mitä työssä on tehty? 3. Miten työ on tehty? 4. Mitkä ovat saavutetut (pää)tulokset? 5. Mikä on saavutettujen tulosten merkitys? Tiivistelmän tulee olla johdonmukainen kertomus suoritetusta tutkimuksesta. Siinä tulee käyttää täydellisiä lauseita, jotka luontevasti liittyvät toisiinsa. Kielen tulee olla selkeää ja lauseiden lyhyitä. Tiivistelmän on oltava sisällöltään itsenäinen, niin että se on ymmärrettävissä ilman turvautumista alkuperäiseen työhön tai muihin julkaisuihin. Esimerkki insinöörityön tiivistelmästä [1]: Tässä työssä suunniteltiin, rakennettiin ja testattiin urheilusukelluskäyttöön soveltuva ultraäänipuhelin. Suunnittelun lähtökohtana oli ymmärrettävän puheen siirto noin 20 m:n etäisyyteen asti. Lisäksi laitteen piti olla mahdollisimman yksinkertainen, jotta se olisi kaupallisesti toteutettavissa. Modulaatiomenetelmäksi on valittu 200 khz:n kantoaaltotaajuudella toimiva kapeakaistainen taajuusmodulaatio. Lähettimen kantoaallon taajuus on lukittu kideoskillaattorilla muodostettuun referenssitaajuuteen vaihelukitun silmukan avulla. Lähettimessä käytetään pietsosähköiseen ilmiöön perustuvaa anturia, joka muuttaa sähköisen signaalin ääneksi. Jännitelähteenä on käytetty kahta

16 10 9 V:n akkua, joilla saavutetaan riittävä toiminta-aika ja -varmuus. Lähettimessä käytetään kondensaattorimikrofonia, joka on koteloitu vesitiiviiksi ja painetta kestäväksi. Lähetin käynnistyy automaattisesti puhuttaessa. Vastaanottimessa on samanlainen anturi kuin lähettimessä. Vastaanottimen ilmaisin on toteutettu vaihelukitulla silmukalla, joka ohjaa myös kohinasalpaa. Kohinasalvalla estetään vastaanottimen tarpeeton päällä olo. Vastaanottimen jännitelähteenä on yksi 9 V:n akku. Kaiuttomassa altaassa tehtyjen mittausten perusteella laite toimii moitteettomasti ja kykenee siirtämään signaalin taajuusalueella Hz, joka on riittävä puheen siirrossa. Esimerkin tekstin pituus on noin 150 sanaa. Tekstiosaa analysoitaessa havaitaan ensimmäisen kappaleen käsittelevän kohtaa 2, eli mitä työssä on tehty. Kaksi seuraavaa kappaletta vastaavat pääosin kohdan 3 kysymykseen: miten työ on tehty? Viimeinen kappale käsittelee saavutettuja tuloksia. Kohtiin 1 ja 5 ei suoranaisesti ole puututtu. Suositeltavaa olisi näistäkin jotain kommentoida. Tiivistelmän englanninkielinen versio noudattaa samoja sääntöjä sisällön osalta. Sitä kirjoittaessa tulee muistaa, että suora kääntäminen harvoin onnistuu, koska tällöin saa helposti aikaiseksi huonoa englantia. Vaikka tavoitteena on tässäkin antaa vastaus edellä listattuihin kysymyksiin, voi Abstract poiketa paljon vastaavasta suomenkielisestä versiosta. Seuraavassa on esimerkkinä edellä esitetyn tiivistelmän melko lailla poikkeava englanninkielinen versio [1]: Ultrasonic transmission exceeds other methods such as radiowave or lightwave transmission in underwater communication. This work describes the design, construction and tests of an ultrasonic phone for scuba diving suitable of communicating over a distance of 20 meters. In the design emphasis is placed on economy, simplicity and reliability of operation. It is an easy-to-use apparatus consisting of a separate transmitter and receiver. The modulation used in transmission is a narrowband frequency modulation and the operation of the transmitter is controlled by speech. Piezoelectric transducers are used to convert electric energy into mechanical energy and vice versa. The receiver is equipped with squelch in order to prevent unnecessary noise.

17 11 According to the measurements performed in an anechoic chamber the ultrasonic phone works perfectly being capable of transmitting and receiving speech in the frequency range from 300 to 2800 hertz. Tätä tekstiä analysoitaessa havaitaan ensimmäisessä kappaleessa olevan johdantolause työn ongelmakenttään loppuosan kappaleesta kuvatessa sitä, mitä työssä on tehty. Toinen kappale käsittelee sitä, miten työ on tehty, ja viimeinen kappale esittelee saavutetut tulokset. Saavutettujen tulosten merkitystä ei tosin ole tässäkään kommentoitu. 2.5 Insinöörityön johdanto Tekstiosan sivujen numerointi samoin kuin työn lukujen numerointi alkaa aina johdantoluvusta. Työn kannalta johdannon merkitys on tärkeä. Siinä tulee esitellä työkokonaisuus, ja opastaa lukija työn ongelmakenttään. Periaatteessa johdanto sisältää laveammin esitettynä ainakin samat asiat kuin, mitä tiivistelmän kohdissa 1 3 on esitetty. Johdannossa tulee selvittää lyhyesti yhdellä tai enintään kahdella sivulla: 1. Mikä on työn tai käsiteltävän ongelman tausta ja luonne? 2. Mitä vastaavia töitä on aikaisemmin tehty ja mahdollisesti julkaistu kirjallisuudessa? 3. Mikä on työn tarkoitus, ja mitä tavoitteita työlle asetetaan? 4. Onko jotain työn osaa painotettu erityisesti tai onko joitain kokonaisongelman osia rajattu kokonaan työn ulkopuolelle? 5. Mikä osa työstä on kirjoittajan itsenäistä tuotosta (tärkeää erityisesti ryhmätöissä)? Pyri siihen, että vastaat kaikkiin kysymyksiin! Näiden lisäksi johdannossa voidaan suorittaa katsaus työn sisältöön. Tällöin kerrotaan lyhyesti keskeisimmät asiat, mitä työn luvuissa käsitellään. Tavanomaisena virheenä opiskelijoilla on ollut lisätä johdantoon yksityiskohtainen kuvaus firmasta, jossa työ on tehty. Tällainen ei kuitenkaan kuulu teknistieteellisen dokumentin rakenteeseen. Tarvittaessa tällaiset kuvaukset ja kiitokset voi esittää alkulauseessa.

18 Työn varsinainen käsittely Käsittely muodostaa työn varsinaisen rungon, joka jakautuu moniin alalukuihin. Tyypillisesti kaikista töistä tulisi löytyä: 1. Teoriataustan kuvaus, jossa määritellään kaikki keskeiset käsitteet. 2. Työn toteutusosuus, jossa esitetään esim. laitteen suunnittelu ja toiminnan kuvaus. 3. Kokeellinen osuus, joka sisältää esimerkiksi mittaukset ja testaukset. 4. Pohdintaosuus, jossa suoritetaan esimerkiksi laitteen verifiointi ja selvitetään yhteys johdannossa esitettyihin tavoitteisiin. Käsittelytapa ja -järjestys sekä jako lukuihin riippuvat kulloisenkin tehtävän sisällöstä. Tuotekehitys ja tutkimus ovat luonteeltaan erilaisia ja vaativat siten vastaavasti hieman erilaisen käsittelytavan. Tutkimuksessa esimerkiksi lähdetään usein liikkeelle teoriasta ja katsauksesta aikaisempiin töihin ja tutkimuksiin. Tuotekehityksessä lähtökohtana voi olla laitteen spesifikaatiot, eli laitteen toiminnalle asetetut vaatimukset. Tuotekehityksessä olennaisia eroja työn rakenteeseen aiheuttaa myös se, ollaanko tekemässä elektroniikkalaiteen hardware-suunnittelua, ohjelmiston suunnittelua tai peräti multimediaa. Siten tässä dokumentissa ei esitellä sellaista kaavamaista esitystapaa, jota tulee aina noudattaa. Yleissääntönä voi kuitenkin aina käyttää sitä, että alan ammattilaisen tulisi selostuksen perusteella voida suorittaa sama työ uudestaan lausekkeiden, mittaustulosten, numerolaskujen tms. kontrolloimiseksi. Tekstiä kirjoitettaessa tulee pitää mielessä, että kirjoittajan tehtävänä on välittää tietoa mahdollisimman tehokkaasti lukijalle. Työtä tehtäessä monista asioista tulee itsestäänselvyyksiä kirjoittajalle, mutta aihepiiriä vain vähän tuntevalle näistä asioista kirjoittaminen saattaa tuoda olennaista lisävalaistusta. Yleensä myös saman aiheen kanssa painiskelevat asiantuntijat arvostavat selkeyttä ja sitä, että työssä on johdonmukainen esitystapa. Hyvän ja ymmärrettävän sisällön aikaansaamiseksi insinöörityö kannattaa antaa työtä ohjaavan opettajan ja työpaikalla ohjaavan henkilön lisäksi luettavaksi muillekin. Suomenkielistä työtä kirjoitettaessa tulee myös muistaa, että vieraskielisille sanoille on pyrittävä löytämään suomenkieliset vastineet, vaikka ammattislangi käyttäisikin vieraskielistä termiä. Kokemus on osittanut, että tavanomaisia tapoja, joilla dokumentin punainen lanka tehokkaasti tuhotaan, ovat tekstin katkaisevat monien sivujen pituiset vaatimusmäärit-

19 13 telyt (speksaukset) suunniteltavana olevasta laitteesta, ranskalaisin viivoin esitetyt asialistat laitteen tai komponentin ominaisuuksista, pitkät ohjelmakoodin listaukset, datalehtisivut tai hyvin pitkät matemaattisten kaavojen johdot (viimeksi mainittu tosin on harvoin ongelma insinööritöissä). Tekstiosan tulee olla helposti luettavissa. Jos työn kirjoittaja tai toisinaan työn tilaaja kaikesta huolimatta haluaa sisällyttää edellä mainittuja asioita työn dokumenttiin, niin ne voidaan esittää työn liiteosassa. Tulosten esittämisen yhteydessä tai sen jälkeen on aina esitettävä pohdinta tulosten merkityksestä, tarkkuudesta, yhteydestä johdannossa esitettyyn tavoitemäärittelyyn yms. Pohdinnan on oltava objektiivisen kriittistä ja riittävän laajaa, epäolennaisuuksiin ja itsestäänselvyyksiin ei kuitenkaan pidä langeta. Pohdinnan tuloksista syntyvät varsinaiset johtopäätökset, jotka esitetään vielä koottuna työn yhteenvedossa. 2.7 Työn yhteenveto Insinöörityön päättävässä luvussa, eli yhteenvedossa esitetään työstä tehtävät johtopäätökset. Johtopäätöksissä esitellään ensi sijassa vain lopulliset tulokset; mitä seikkoja työn tekijä katsoo omilla tutkimuksillaan saaneensa selville ja miten nämä liittyvät kirjallisuudessa esitettyihin asioihin. Tuloksia on erityisesti pyrittävä vertaamaan mahdollisiin aikaisemmin julkaistuihin tutkimuksiin. Ulkopuoliselle lukijalle työn yhteenveto on tekstiosan tärkein luku, minkä vuoksi sen kirjoittamiseen kannattaa paneutua. Työn suorituksen ja insinöörityön arvostelun kannalta on merkittävää, että työn tekijä osaa kriittisesti arvioida oman työnsä tuloksia. Yhteenvedossa tulisi ilmetä seuraavat asiat: 1. Mitä työssä käsiteltiin ja mitä työ osoitti? 2. Mikä on saavutettujen tulosten merkitys? 3. Mitä mahdollisia rajoitteita, etuja yms. työn tuloksilla on? 4. Missä tuloksia voi soveltaa? 5. Miten työtä voisi jatkaa? Pyri vastaamaan mahdollisimman moniin listan kysymyksiin, ja ainakin kahteen ensimmäiseen. Pidä myös mielessä se, että yhteenvedon tulee olla lyhyt. Siinä tulee keskittyä vain olennaisimpiin tuloksiin. Jos yhden sivun pituus alkaa ylittyä, on todennäköistä, että mennään liian yksityiskohtaiseen asioiden tarkasteluun. Tällainen tulee esittää jo muussa tekstiosassa aikaisemmin.

20 14 3. Muotoseikat Insinöörityön tulee olla ulkoasultaan siisti, huoliteltu ja edustava. Tässä luvussa tarkastellaan tärkeimpiä insinöörityön muotoseikkoja. Yhtenäisen ulkoasun saamiseksi niitä on hyvä noudattaa. Monet muotoiluun liittyvät yksityiskohdat ovat usein makuasioita. Tämän vuoksi joistakin tässä esitetyistä tavoista voidaan myös poiketa, jos se tehdään hyvällä maulla. Valittua tyyliä tai tapaa on käytettävä systemaattisesti koko työssä. Tämä dokumentti tosin rikkoo tätä periaatetta, koska tässä on tarkoituskin esitellä erilaisia tyylejä. 3.1 Yleiset muotoseikat Insinöörityön ulkoasuun ja tekstin asemointiin vaikuttavat yleiset säännöt on esitetty taulukossa 1. Taulukko 1. Insinöörityön yleiset muotoseikat ja kirjasintyyppien (fonttien) pistekoko (pt) Paperin koko Kirjasintyyppi A4 Arial, Times New Roman, tai Cambria Kirjasinkoko teksti pääotsikot alaotsikot kuvatekstit 11 pt (tai 12 pt jos Times New Roman) 16 pt, lihavoitu (bold) kirjasin 12 pt, lihavoitu kirjasin voi olla pienempi, esimerkiksi 10 pt Riviväli 1,5 Reunat Marginaalit Sivunumerointi tasataan vasen 40 mm (tarvitaan työn sidontaa varten), oikea 20 mm, ylä- ja alamarginaali 30 mm alkaa johdantosivulta! liiteluettelo on viimeinen sivu, joka numeroidaan johdantoa edeltävät sivut voi jättää numeroimatta tai ne voidaan numeroida roomalaisin numeroin ensimmäisen sivun numero jätetään usein merkitsemättä Kirjasintyypiksi (fontiksi) sopii parhaiten Arial tai Times New Roman. Arial-fontti on suositeltavin nykyään, ja se soveltuu erityisen hyvin käytettäväksi selkeänä fonttina opinnäytetöissä, jotka sisältävät lähes yksinomaan tekstiä ja kuvia. Mikäli mukana on kui-

21 15 tenkin runsaasti matematiikkaa ja kaavoja, niin Times New Roman on usein selkeämpi ja kauniimpi. Huomaa, että varsinaisessa tekstissä käytettävään kirjasinkokoon vaikuttaa valittu kirjasintyyppi. Arial-fonttia käytettäessä sopiva kirjasinkoko on 11 pistettä (11 pt). Times New Roman -fontti puolestaan näyttää kirjasinkoolla 12 pistettä tältä, eli suurin piirtein samankokoiselta. Kirjasintyypin valintaan saattaa vaikuttaa keskeisesti myös käytettävä tekstinkäsittelyohjelma. Esimerkiksi Microsoft Word ohjelman uusi kaavaeditori sallii vain Cambria Math -fontin käytön. Tämän vuoksi on loogista käyttää myös työn muussa tekstissä Cambria-fonttia. Cambria-fontilla kirjoittaessa tekstin kokona kannattaa käyttää 11 pistettä, jolloin teksti näyttää tältä. Huomaa, että taulukossa 1 esitetyt kuvatekstien ja otsikoiden kirjasinkokojen pt-arvot pätevät Arialfontille. Mikäli käytät jotain muuta kirjasintyyppiä, suhteuta koot vastaavasti, jotta saat kokonaisuuden näyttämään hyvältä. Muita muotoiluun liittyviä asioita, jotka tulee ottaa huomioon: Työssä ei saa esiintyä firmojen logoja Kappaleita ei sisennetä, vaan ne erotellaan toisistaan jättämällä väliin tyhjää. Tyhjää tilaa kappaleiden väliin saa esim. Microsoft Wordissa tyylin (style) ominaisuuksien määrittelyn kautta. Tyhjien rivien lisääminen rivinsiirtoina sekoittaa ainakin Wordin sivuntaittologiikan. Tutustu tekstinkäsittelyohjelmasi ominaisuuksiin! Kirjasintyypin tai tyylin turhaa vaihtamista tulee välttää. Ainoastaan asian korostamisessa tai tietyissä erikoistapauksissa, kuten kuvien ja taulukoiden nimissä voi käyttää poikkeavaa tyyliä (yleensä kursivoituna italics tai lihavoituna bold). Otsikoiden korostaminen on lukemisen kannalta miellyttävintä suorittaa tekstiin valitun kirjasintyypin kokoa muuttamalla, ei fonttia muuttamalla. Kuvien ja taulukoiden otsikkotekstit voidaan kirjoittaa normaalitekstiin verrattuna hieman pienemmällä kirjasinkoolla (esimerkiksi Arial-fontin tapauksessa kirjasinkoolla 10 pt) luettavuuden tai erottuvuuden parantamiseksi. Lopullinen versio tulostettakoon laserilla tai vastaavalla tulostimella, jolla saadaan pysyvä jälki. Mustesuihkukirjoittimella tulostus ei ole sallittua. 3.2 Kuvat ja taulukot Insinöörityön havainnollisuutta voidaan lisätä käyttämällä tekstin lisäksi sopivia kuvia ja taulukoita. Graafista esitystä kannattaa käyttää aina kuin se on mahdollista, sillä kuvan tai kaavion avulla on usein suhteellisen helppo kiteyttää tulokset. Joskus on perusteltua

22 16 esittää sama aineisto sekä taulukkona että graafisena esityksenä. Taulukko esittää tarkat tiedot ja käyrästö tai jokin muu esitystapa (pylväsdiagrammi, piirakkakaavio) havainnollistaa tulokset ja niiden keskinäiset suhteet, muutokset ajan tai paikan suhteen yms. Muista kuitenkin, että pelkkä kuva ei riitä, vaan aina tarvitaan kypsää analyysiä ja tulkintaa. Ammattikorkeakoulun yleisissä opinnäytetyöohjeissa erotetaan kuva- ja kuvio-sanat tosistaan. Kuvalla tarkoitetaan tällöin esimerkiksi valokuvaa (esim. kuva 3.1) tai piirroskuvaa ja kuviolla vastaavasti erilaisia graafisia kaavioita ja käyrästöjä (esim. kuva 3.2). Käytäntö voi olla toimiva vähän kuvia ja kuvioita käsittävässä esityksessä, mutta tyypillisissä insinööritöissä näitä on paljon, jolloin on selkeämpää nimetä kaikki kuvina, pohtimatta sen enempää sanan tarkempaa merkitystä. Kuva 3.1 Tämä on esimerkki valokuvasta, joka on liitetty tekstiyhteyteen. Valokuvien käytössä tulee ottaa huomioon, että niiden tulee olla omia tai tekijällä täytyy olla lupa niiden käyttöön ja tällöin kuvan oikeudenomistaja, eli usein kuvaaja, tulee mainita. Kuvassa erään projektin mittausryhmä Helsingissä (kuva H. Gylén).

23 17 Kuvassa 3.2 on esimerkki graafisesta esityksestä ja siihen liittyvästä kuvatekstistä. Kuvien numerointi voidaan suorittaa juoksevasti joko koko insinöörityötä ajatellen, tai lukukohtaisesti juoksevasti kuten tässä esimerkissä. Huomaa, että kuvateksti on aina kuvan alla. Kuvatekstit esitetään toisinaan hieman pienemmällä fontilla kuin varsinainen pääteksti erottuvuuden parantamiseksi. Lisäksi kuvan nimi Kuva 3.2 esitetään yleensä lihavoituna. Kuvia liitettäessä tulee aina muistaa viitata siihen tekstiosassa. Kuvia tekstitettäessä tulee pyrkiä siihen, että olennainen asia selviää siitä ilman, että tarvitsee etsiä kuvaan liittyvää kohtaa varsinaisesta tekstiosasta. Luettavuuden helpottamiseksi pitää pyrkiä siihen, että kuva ja siihen liittyvä käsittely tekstiosassa ovat samalla sivulla S S11 S21 S [db] M 1G 1.5G 2G f [Hz] Kuva 3.2 Tämä on puolestaan esimerkki graafisesta kuvasta, joka on liitetty tekstiyhteyteen. Muista määritellä käyrät, jotta kuvista tulee selkeitä. Pyri käyttämään myös erilaisia viivatyyppejä tai värejä, mikäli sekaantumisen vaaraa on. Kuvassa on esitetty erään ylipäästösuodattimen simulaatiotulos. Kuvien piirtäminen tai kopioiminen on nykyisin suhteellisen helppoa. Skannattaessa kuvia tulee kiinnittää huomio kuvien laatuun, jotta työstä saa siistin näköisen. Suurimmat ongelmat insinööritöiden kuvissa ovat esiintyneet resoluutiossa, joka on saattanut oleellisesti heiketä skannauksessa. Myös Internetistä varsinkin tiiviisti pakatuista tiedostoista kopioidut kuvat voivat olla alun alkaen laadultaan erittäin heikkoja (esim. pdf-muodossa olevien datalehtien kuvat). Skannattuja tai muulla tavoin kopioituja kuvia käytettäessä tulee muistaa, että kuvan on oltava helposti luettavissa ja kuvan pienimmistäkin yksityiskohdista on saatava selvää. Skannauksessa tai verkosta

24 18 materiaalia lainattaessa on syytä myös pitää mielessä asianmukaisten viitteiden lisääminen kuvatekstiin, jotta ei sorru plagiointiin. Ohjelman rakennetta kuvattaessa on syytä kiinnittää erityistä huomiota piirrettävän mallin kokoon ja luettavuuteen. Mallinnustyökalulla on helppoa tuottaa A3-kokoisia kuvia (ja miksei suurempiakin), mutta opinnäytetyön luettavuuden kannalta kuvan pitäisi mahtua korkeintaan A5-kokoisena tekstin keskelle. Usein on syytä jättää laajat kokonaiskuvat tyystin pois, ja tyytyä esittämään vain mallin oleelliset osat tekstin keskellä. Tulee myös tarkkaan harkita, kannattaako laajoja kuvia laittaa edes kirjan loppuun liitteiksi. Kuvassa 3.3 on esimerkki ohjelman ULM-luokkakaaviosta. CCarPoolAppUi CCarPoolView CCarPoolYear EditorDlg CCarPoolDriverSelector CCarPoolWeekBrowserView CCarPoolWeekView CCarPoolEngine CCarPoolWeek 0..* TCarPoolRide MCarPoolSched ulecmdhandler CCarPoolScheduler Kuva 3.3 Tämä on esimerkki ohjelman UML-luokkakaaviosta [2]. Juurikaan laajempaa kaaviota ei kannata tunkea tekstin keskelle, ja harvoin liitteeksikään. Graafisten esitysten tekemisessä estetiikka ei ole pahasta. Kuvan tulee näyttää hyvältä! Seuraavassa on esitetty, joitakin muotoseikkoja, mitä kuvia piirrettäessä tai kopioitaessa on hyvä ottaa huomioon: Kuvassa olevan tekstin tulee olla (suunnilleen) samankokoista, kuin mitä kuvatekstissä tai varsinaisessa tekstissä käytetään. Lukemisen helpottamiseksi käyriä piirrettäessä asteikot esitetään yleensä ohuemmalla viivalla kuin varsinaiset käyrät. Tämän tosin varsin harvat piirto-ohjelmat automaattisesti osaavat, vaikka osaavatkin tehdä satoja erilaisia pylväs- ja piirakka-

25 19 kaavioita! Analysointi- tai mittausohjelmien tuottamissa kuvissa on myös harvoin mahdollisuutta vaikuttaa esitystapaan. Asteikkojen helppolukuisuuteen tulee kiinnittää erityistä huomiota. Skaalauksessa tulee käyttää järkeä, jotta ne eivät aiheuttaisi harhaan johtavia mielikuvia. Älä tee kuvista sarjakuvia lisäämällä niihin kehyksiä! Taulukoiden numerointi voidaan tehdä samaan tapaan kuin kuvienkin numerointi, eli arabialaisia numeroita käyttäen (esimerkiksi Taulukko 1 ). Sekä juokseva numerointi (niin kuin tässä dokumentissa) että lukukohtainen numerointi ovat mahdollisia. Taulukkoselosteen teksti, toisin kuin kuvien teksti, sijoitetaan aina taulukon yläpuolelle. 3.3 Kaavat Suureita ja symboleja merkittäessä on käytettävä tekstissä käytetyn kirjasintyypin kursivoitua tyyliä (italics). Tällaisiin symboleihin kuuluvat myös kytkentäkaavion komponenttien nimet, kuten esimerkiksi R 2, IC 12, C OUT. Tämä helpottaa työn luettavuutta. Samaa kirjasintyyliä tulee käyttää myös kaavoissa, eli tässä siis Arial-fonttia: 1 t1 T0 1 v ( t) v( t) dt v( t) dt. (1) T t1 T T0 0 0 Matematiikkaa on usein totuttu esittämään ns. antikva-tyyppisillä kirjasimilla, joissa kirjainrungot ovat päätteellisiä ja niissä on leveyden vaihtelua. Times New Roman ja Cambria ovat esimerkkejä tällaisista kirjasintyypeistä, joten voit harkita erityisesti niiden käyttöä työssäsi. Tekstinkäsittelyohjelman kaavaeditorit saattaavat tosin tehdä huonoa jälkeä tietyillä kirjasintyypeillä, jos ylipäätään sallivat kirjasimen vaihdon. Esimerkiksi yllä Microsoft Wordin vanhan kaavaeditorin oletusasetuksilla integrointirajat pyrkivät ainakin tulostettaessa olemaan osittain integraalimerkin päällä (kaavan oikeanpuoleinen integraalimerkki). Tämän välttämiseksi rajojen sijaintia on syytä muuttaa tai lisätä tyhjää rajojen eteen (vasemman integraalimerkin integrointirajat). Huomaa myös, että matemaattiset operaatiot, kuten sin, log, arctan yms., ovat kuitenkin nimiä, joten niitä ei esitetä kursivoituna. Siten, kirjoitetaan esimerkiksi x A cos t eikä x A cos t. Voit pohtia jälleen helppolukuisuutta! Useimmat kaavaeditorit toimivat tässä suhteessa automaattisesti tunnistaessaan funktion nimen. SI-järjestelmässä suure ilmaistaan lukuarvolla ja yksikön tunnuksella, joiden väliin jätetään tyhjä väli, siis välilyönti, esimerkiksi p = 5 kpa, R LOAD = 82 Ω, a = 73 m/s 2.

26 20 Kaavaeditoria käytettäessä on muistettava, että yksiköiden tunnukset eivät ole symboleita, eikä niitä tule esittää kursivoituna. Usein varsinkin tekniikan kielessä näkee myös kirjoituksia, joissa lukuarvo ja yksikön tunnus on kirjoitettu yhteen. Tämä on kuitenkin suositusten ja standardien vastaista. Välin käyttö selventää ilmaisua. Tyhjän välin pois jättäminen saattaa johtua pelosta, että tekstin muotoilussa tulee rivinvaihto luvun ja yksikön väliin. Tämän voi tarvittaessa estää käyttämällä sitovaa välilyöntiä. Word-tekstinkäsittelyohjelman tapauksessa sitova välilyönti saadaan aikaan, kun välilyöntinäppäintä painettaessa samanaikaisesti pidetään Ctrl- ja Shift-näppäimet painettuina (ks. Taulukko 4.1). Lue myös miinus- ja kertomerkkien oikeista muodoista luvusta 4.1 Kaavoja kirjoitettaessa tulee ottaa huomioon: Mikäli kaavoja on työssä runsaasti tai, jos niihin on tekstissä myöhemmin viittauksia, tulee kaavat numeroida. Tässä voidaan käyttää joko juoksevaa tai lukukohtaista numerointia. Jos kaavoja on vähän, numerointia ei yleensä tarvita. Kaavojen numero laitetaan kaarisulkeiden sisään edellä esitetyn kaavan (1) tavoin. Kaavojen sisentämisen tai keskittämisen voi tehdä hyvän maun mukaan! Kaavat ovat usein osa lausetta, jolloin suomen kielen välimerkkisäännöt pätevät. Pilkut ja pisteet kaavojen perässä ovat tavallisia. Kun symboli tai lyhenne esiintyy kaavassa tai tekstiyhteydessä ensimmäistä kertaa, tulee kertoa mistä on kysymys. Tästä huolimatta saman symbolin tulee olla myös symboliluettelossa. Soveltavana esimerkkinä edellä olevista voidaan kirjoittaa (tällä kertaa Cambria-fonttia käyttäen): Myötäsuuntaisella esijännitteellä pn-diodin I U -ominaiskäyrä on muodoltaan eksponentiaalinen. Diodin virta I riippuu diodin yli vaikuttavasta jännitteestä U D seuraavasti: I qu D I s exp, (2) kt missä I s on diodin kyllästysvirta, q on elektronin varaus ( As), η on diodin ideaalisuuskerroin, k on Boltzmannin vakio ( J/K) ja T on absoluuttinen lämpötila.