Opinnäytteiden kirjoittaminen,
lyhyt oppimäärä

Jukka-Pekka Santanen



Kirjoitusohje 23.8.2000

Jyväskylän yliopisto
tietotekniikan laitos





Tekijä: Jukka-Pekka Santanen.

Yhteystiedot: Sähköposti santanen@mit.jyu.fi ja puh. (014) 260 2756.

Työn nimi: Opinnäytteiden kirjoittaminen, lyhyt oppimäärä.

Title in English: A Short Introduction to Scientific Writing.

Työ: Kirjoitusohje tietotekniikan opiskelijoille.

Sivumäärä: 11

Linja: Ohjelmistotekniikka, opettajalinja, sulautetut järjestelmät, tieteellinen laskenta ja tietoliikenne.

Teettäjä: Jyväskylän yliopisto, tietotekniikan laitos.

Tiivistelmä: Tämä ohje antaa neuvoja hyvän ja sujuvan tieteellisen tekstin kirjoittamiseen. Ohje on pääsääntöisesti tarkoitettu yleiskäyttöiseksi kirjoitusohjeeksi niille opinnäytteille, jotka toteutetaan Jyväskylän yliopiston tietotekniikan laitokselle. Parempilaatuinen tulostettavissa oleva PostScript-muotoinen ohjetiedosto on myös saatavissa.

Avainsanat: Opinnäytteet, tieteelliset tekstit, kirjoittaminen, kirjoitusasu, kirjoitusvirheet.

Keywords: Theses, academic reports, writing, spelling mistakes.




Sisältö

 

1 Johdanto

Tämä kirjoitusohje kuvaa hyvän ja sujuvan tieteellisen tekstin rakennetta sekä antaa vinkkejä yleisten kirjoitus- ja muotoiluvirheiden välttämiseen. Kirjoitusohje on suunniteltu tieteellisen kirjoittamisen näkökulmasta, joten sen neuvot eivät välttämättä sellaisenaan sovellu kaikkeen kirjoittamiseen. Lisäksi eri tieteenaloilla on erilaisia tekstin muotoilutapoja (esimerkiksi lähteiden merkitsemisen suhteen), joten ohjetta ei välttämättä voi soveltaa suoraan Jyväskylän yliopiston tietotekniikan laitoksen ulkopuolelle toteutettaviin opinnäytetöihin.

Ohjeeseen kannattaa tutustua ainakin kirjoitettaessa tietotekniikan LuK- ja pro gradu -tutkielmaa, seminaariesitelmää sekä tietotekniikan cum laude -työprojektin suunnitelmaa ja käsikirjaa. Näihin kirjoitelmiin ohjeessa viitataan opinnäytteinä. Tietotekniikan laitoksella on laadittu erillisiä tutkielmien ja muiden opinnäytteiden sisältöä ja toteuttamista koskevia ohjeita. Näitä ovat mm. ohjeet tietotekniikan pro gradu -tutkielmille [Tietotekniikan laitos] ja LuK-tutkielmille [Männikkö] sekä tietotekniikan cum laude -työprojekteille [Santanen, 2000] ja -harjoitustöille [Santanen, 1999].

Kirjoitusohjeessa on erottumisen vuoksi merkitty kursivoidulla kirjasimella englanninkielisten termivastineiden lisäksi esimerkit. Kursivointi ei kuitenkaan välttämättä ole suositeltu merkintätapa kyseiseen tarkoitukseen, vaan se vain osoittaa kyseisen kohdan olevan esimerkin.

Luvussa 2 käsitellään opinnäytteen suunnittelua ja rakennetta sekä annetaan vihjeitä lukujen sisällöistä. Luku 3 esittelee tieteellisen tekstin merkintätapoja sekä mahdollisuuksia korostaa ja muotoilla oleellisia opinnäytteessä käsiteltäviä asioita. Luku 4 kuvaa taulukkojen, kuvien, esimerkkien, kaavojen ja lauseiden kirjoitusasua, numerointia ja viittaustapoja. Lukuun 5 on kerätty yleisiä opiskelijoiden kirjoitelmissa havaittuja virheitä sekä neuvoja niiden välttämiseksi.  

2 Opinnäytteen rakenne

Luvussa käsitellään opinnäytteen rakennetta ja sen suunnittelua kuvaamalla lähinnä mukaan sisällytettäviä lukuja ja niiden sisältöä. Luvussa käydään läpi myös lähteiden merkintätavat ja niihin viittaaminen.  

2.1 Sisällön ja rakenteen suunnittelu

Opinnäytettä ei kannata aloittaa suoraan ''tyhjältä pöydältä'', vaan sen sisältöä kannattaa suunnitella ennen kirjoittamisen aloittamista. Tämä yleensä vaatii muutamaan lähteeseen tutustumista, ellei aihealue ole kirjoittajalle jo ennestään tuttu. Sisällysluettelon hahmotelma auttaa työn tavoitteiden ja kokonaisuuden hallintaa sekä toimii samalla muistilistana selvitettävistä asioista.

Opinnäytettä suunniteltaessa kannattaa myös ottaa huomioon, keille kyseinen kirjoitelma on suunnattu. Yleensä se kannattaa kirjoittaa hieman vähemmän aihealuetta tunteville kuin sen kohdeyleisön olettaa asiaa hallitsevan. Tällöin asian ymmärtämisen kannalta oleelliset ''perusasiat'' tulevat paremmin selitetyiksi.

Kirjoittajan kannattaa kuitenkin pitää mielessä, että opinnäyte elää koko kirjoitusprosessin ajan. Lopullinen tulos saattaa siten poiketa huomattavastikin alkuperäisestä sisällön ja lukujaon hahmotelmasta.  

2.2 Opinnäytteen luvut

Luvussa kuvataan opinnäytteeseen kuuluvia lukuja ja niiden sisältöä sijoitusjärjestyksessä. Kansisivulla tulee yleensä mainita opinnäytteen nimi, tekijöiden nimet, mihin (opintojaksoon) työ liittyy, päivämäärä sekä opinnäytteen ''kustantaja'' (ts. hyväksyvä yliopisto ja laitos). Kansisivulle kannattaa sijoittaa ensin oleellisimmat tiedot isommalla kirjasimella (katso tämän ohjeen kansisivua).

Tiivistelmä (engl. abstract) kuvaa lyhyesti (2-5 lausetta) opinnäytteen (ja/tai mahdollisen aiheen) sisältöä. Jo pelkän tiivistelmän tulisi antaa lukijalle melko hyvä käsitys tekstin sisällöstä tai ainakin sen aihealueesta. Tietotekniikan LuK- ja pro gradu -tutkielmien tiivistelmien yhteyteen kannattaa tämän ohjeen tiivistelmäsivun mukaisesti kirjata myös tekijän nimi ja yhteystiedot, työn nimi suomeksi ja englanniksi, työn sivumäärä, kyseessä oleva opinnäyte ja linja, työn teettäjä sekä avainsanat (engl. keywords) suomeksi ja englanniksi.

Työhön voi halutessaan liittää luvun Esipuhe, Lukijalle tai Saatesanat (engl. preface tai acknowledgements). Lukuun sisällytetään yleensä mahdolliset rahoittajille, ohjaajille, ystäville ja perheelle suunnatut kiitokset, jotka tieteellisissä lehtiartikkeleissa toisinaan kirjoitetaan artikkelin loppuun (katso luvun 6 loppu). Mahdolliset muistokirjoitukset kannattaa myös sijoittaa tähän lukuun. Luvussa voi myös lyhyesti kuvata tutkimuksen tai opinnäytteen käytännön taustoja eli sitä, miten aihe on tullut tekijän tietoon. Itse aiheen taustatiedot kannattaa sen sijaan liittää johdantolukuun. Esipuhe ei tulisi olla sivua pidempi. Tiivistelmä ja esipuhe voivat olla myös päinvastaisessa järjestyksessä.

Sisältö eli sisällysluettelo (engl. contents tai table of contents) on luettelo luvuista ja alaluvuista alkaen johdannosta ja päättyen liitteisiin. Opinnäytteen rakenteen esiintuomisessa eritasoiset luvut kannattaa kirjoittaa eri kirjasintyyleillä tai -koilla, jonka lisäksi alaluvut voi myös sisentää. Sisällysluettelon tulee sisältää lukujen numerot ja sivunumerot. Sisällysluettelon perään voi halutessaan liittää erilliset luettelot opinnäytteen kuvista, taulukoista, esimerkeistä, termeistä ja/tai symboleista.

Johdanto (engl. introduction) on ensimmäinen varsinainen luku, joten lukujen numerointi aloitetaan siitä. Johdanto sisältää opinnäytteen sisällön ja taustojen yleisen kuvauksen. Johdannossa myös kuvataan lyhyesti (yleensä yhdellä lauseella) kunkin luvun (toisinaan myös tärkeimpien alalukujen) sisältö (esim. Luvussa 3... tai ...neljännessä luvussa). Vaikka osalla kirjoittajista on tapana kirjoittaa johdanto useiden sivujen pituiseksi, 1/2-2 sivun mittainen lyhyt johdanto on yleensä suositeltavampi. Liian pitkä johdanto kannattaakin pilkkoa johdannon ohella esimerkiksi aiheen taustaa tai historiaa käsitteleväksi luvuksi. Johdannon yhteyteen tai ennen sitä liitetään toisinaan myös symboli- ja/tai termiluettelo, jos niille ei ole varattu omaa lukuaan tai niitä ei esitetä liitteissä.

Luvuissa 2,...,N-1 käsitellään itse aihetta. Liian lyhyitä tai pitkiä lukuja (engl. chapter) tai alalukuja (engl. section tai subsection) tulee välttää muotoilemalla tekstin ja lukujen rakennetta. Lukujen pituuksien ja alalukujen määrän tulisi siis mielellään olla mahdollisimman hyvin ''tasapainossa'' keskenään. Luvun ja sen ensimmäisen alaluvun otsikoiden väliin tulee sijoittaa vähintään yksi lauseellinen sidostekstiä (ns. luvun johdanto), jossa kuvataan esimerkiksi luvun sisältöä. Toisinaan ensimmäisen alaluvun alkuun kaavailtu kappale soveltuu hyvin kyseisen luvun johdantokappaleeksi.

Lukujen numeroinnissa ei suositella käytettävän yli kolmitasoisia alalukuja, joten esimerkiksi luvulle 1.2.3 ei tulisi kirjoittaa enää alalukuja. Luvuissa tulee yleisesti viitata käytettyihin lähteisiin vähintään luvun ''johdantokappaleen'' lopussa. Lisäksi yksittäisiin ja tarkastelun kannalta oleellisiin lähteisiin kannattaa viitata luvun sisällä kyseisessä asian käsittelykohdassa. Kappaleissa kannattaa tarvittaessa viitata opinnäytteen lukuihin, kuviin, taulukoihin, esimerkkeihin ja kaavoihin sekä lauseisiin ja todistuksiin niiden numeroilla (katso luvut 3.3 ja 4.1). Tällöin lukija helpommin yhdistää kappaleessa käsiteltävän asian kyseessä olevaan kohtaan.

Yhteenveto (engl. concluding remarks tai conclusions) sisältää opinnäytteen yhteenvedon lisäksi yleensä jatkotoimenpiteiden ja suunnitelmien kuvauksia. Yhteenveto on yleisesti pituudeltaan 1/2-2 sivua. Yhteenveto on yleensä viimeinen numeroitava luku.

Lähteissä tai Lähdeluettelossa (engl. references) esitellään työssä käytetyt lähteet. Lähteiden kirjoitusasua lähdeluettelossa ja lukuihin sijoitetuissa lähdeviittauksissa kuvataan tarkemmin luvuissa 2.3 ja 2.4. Lähdeluetteloon ei yleensä liitetä lukunumeroa etenkin, jos kyseessä on laajahko opinnäyte. Lähteiden yhteyteen voi toisinaan olla järkevää lisätä Lisämateriaalia-kohta. Siinä mainitaan aiheeseen liittyvät lisätietoa sisältävät kirjat, artikkelit ja muut dokumentit, joita ei kuitenkaan ole suoranaisesti käytetty lähteinä.

Hakemisto (engl. index) tai Sanasto (engl. glossary) on toisinaan perusteltua toteuttaa erityisesti laajojen opinnäytteiden ja käyttöohjetyylisten kirjoitelmien tapauksessa. Tällöin lukija löytää tiedon helpommin ja nopeammin hakemistoa ja sisällysluetteloa käyttämällä.

Liitteisiin (engl. appendix) sijoitetaan yleisesti opinnäytteen kokonaisuuden kannalta vähemmän tärkeää lisäinformaatiota. Monesti liitteet sisältävät aiheeseen liittyviä esimerkkejä, algoritmeja tai ohjelmien osia. Myös vähemmän oleellisten matemaattisten todistusten sijoittaminen liitteisiin on toisinaan perusteltua. Luettelo työssä käytetyistä termeistä voidaan sijoittaa oman luvun sijaan liitteiden yhteyteen. Liiteotsikoinnissa käytetään joko numerointia tai kirjaimia tyyliin Liite 1. Lisäinformaatiota.  

2.3 Lähdeluettelo

Lähteiden kirjoitusasu lähdeluettelossa ja lähdeviittausten merkintätapa luvuissa eroavat eri tieteenaloilla. Lisäksi lehtien ja konferenssien suosituksissa on eroja. Tämän ja seuraavan alaluvun lähdemerkintöjä koskevat ohjeet ovat yleisesti hyväksyttyjä ainakin Jyväskylän yliopiston tietotekniikan laitoksen opinnäytteissä.

Lähdeluettelon lähteet yleensä järjestetään tekijän nimen mukaiseen aakkosjärjestykseen. Yritysten ja organisaatioiden julkistamien verkkolähteiden ja käyttöohjeiden yhteydessä ei ole yleensä mainittu dokumentin laatineita henkilöitä. Tällöin kannattaa tekijäksi kirjata kyseinen yritys tai organisaatio.

Yleinen lähteen kirjoitusasu lähdeluettelossa (katso luku 7) on kirjan (ns. monografian, engl. monograph) ja tutkielman tapauksessa

ja lehtiartikkelin tapauksessa Raportin (engl. report; esimerkiksi jokin tietotekniikan laitoksen julkaisusarjoista) tapauksessa suositeltu kirjoitusasu on kokoomateoksen (engl. proceedings tai collections; siis kirja koostuu useista eri kirjoittajien artikkeleista) tapauksessa ja tietoverkosta löydetyn dokumentin tapauksessa Jos tietoverkosta löydetystä lähteestä ei löydy päiväystä tai vuotta, lukupäiväys kannattaa kirjoittaa muotoon viitattu 23.8.2000.

Usean tekijän lähteen tapauksessa kaksi viimeksi mainittua tekijää voi erottaa toisistaan ja- tai and-sanalla ja muut tekijät pilkuilla. Lähdeluettelotietoihin voi halutessaan sisällyttää myös kirjojen tapauksessa kansainvälisen ISBN-standardinumeron ja kausijulkaisuissa (mm. aikakauslehdet) ISSN-standardinumeron.  

2.4 Lähdeviittaukset

Lähteisiin viitataan lukujen sisällä yleensä (normaalilla kirjasintyylillä) Viittauksiin kannattaa joissain tapauksissa liittää sivun, luvun, kuvan, taulukon, kaavan tai esimerkin numero, jolloin lukijan on huomattavasti helpompi löytää oikea viittauskohta lähdeteoksesta.

Jos lähteellä on useampi tekijä, kannattaa sukunimiviittaukseen sisällyttää joko vain ensimmäisenä mainittu tekijä tai lisätä ko. tekijän perään vielä teksti ym. (lat. et al.). Jos sama tekijä on tehnyt useita lähteitä, sukunimiviittaukseen kannattaa liittää myös vuosiluku. Samana vuonna tehdyt saman tekijän lähdeviittaukset tulee sukunimiviittauksen yhteydessä erottaa toisistaan vuosiluvun perään kirjoitetulla kirjaimella (katso eo. esimerkit).  

2.5 Lukijan huomioiminen

On syytä painottaa kansisivun lisäksi tiivistelmän, johdannon ja yhteenvedon tärkeyttä tekstissä. Lukuisia raportteja läpikäyvä lukija tai tiedon etsijä arvostaa näitä kolmea lukua, joiden avulla hän pystyy nopeasti hahmottamaan työn sisällön ja merkityksen itselleen.

Mainittujen lukujen huolellisella valmistelulla kirjoittaja voi houkutella lukijan perehtymään tarkemmin työhön sen sijaan, että lukija heittäisi sen suoraan paperinkeräykseen. Kiireistä lukijaa saattaa erityisesti ärsyttää se, että hän tuhlaa aikaansa materiaaliin tutustumiseen ennenkuin havaitsee tekstin itselleen yhdentekeväksi. Seuraavalla kerralla ko. kirjoittajan kirjoitelma saattaa jäädä kyseiseltä lukijalta kokonaan lukematta tai lukijalla on kielteinen ennakkokäsitys sekä kirjoittajasta että kirjoitelman sisällön laadusta.

Aiheeseen liittyvien termien ja symbolien selittäminen antaa lukijalle kirjoittajasta erittäin miellyttävän kuvan. Materiaali on tällöin lukijalle paljon ymmärrettävämmässä muodossa, kun epäselvät termit voi tarkistaa suoraan opinnäytteen hakemistosta tai sanastosta. Termit selityksineen kannattaa joissain tapauksissa koota joko omaan lukuunsa tai liitteisiin.

Toisinaan lukija kannattaa ''johdattaa'' seuraavan luvun tai alaluvun aiheeseen esimerkiksi seuraavankaltaisella luvun loppuun sijoitettavalla lauseella: Seuraavassa luvussa tarkastellaan yleisiä tapoja merkitä ja tuoda esille opinnäytteissä käsiteltäviä asioita.  

3. Asioiden esilletuonti ja merkintätapoja

Pelkistä samalla kirjasimella kirjoitetuista tekstikappaleista koostuva opinnäyte saattaa tuntua lukijasta monotoniselta ja hieman tylsältä läpikäytäväksi. Oleellisia asioita kannattaakin tuoda esille eri kirjasintyylien ja listojen avulla. Lisäksi korostettujen termien ja listojen avulla lukija saa helpommin yleiskäsityksen kappaleiden sisällöstä.  

3.1 Kirjasintyylit ja -koot

Tärkeiden sanojen ja lauseiden esiintuomisessa kannattaa käyttää normaalitekstistä eroavaa kirjasintyyliä, joista vahvennus on yleisimmin käytetty. Kursivoinnin avulla saa hyvin tuotua esille mm. lainaukset, termien englanninkieliset vastineet ja sovellusten käyttöliittymien tekstit. Matemaattiset kaavat kannattaa kirjoittaa erottuvalla ''matemaattisella'' kirjasimella (esimerkiksi Ax=b).

Tekstin sekaan sijoitetut ohjelman osat, käskyt, muuttujat ja parametrien arvot kannattaa kirjoittaa mahdollisimman paljon ohjelmakoodia muistuttavalla tasavälisellä kirjasimella. Omalle rivilleen sijoitettavat käskyt tai usean rivin mittaiset koodinpätkät kannattaa sisentää niiden erottumisen parantamiseksi tekstikappaleista seuraavasti:

jos kaipaat palautetta opinnäytteesi kieliasusta niin
pyydä ensin ystävääsi käymään se läpi
jos loppuu

Tekstikappaleista poikkeavia kirjasinkokoja kannattanee käyttää lähinnä vain lukujen otsikoissa sekä ala- ja yläindekseissä. Kappaleiden sisällä käytettynä kyseinen tehokeino saattaa nimittäin ''ottaa liikaa lukijan silmään'' ja siten laskea tekstin luettavuutta. Lisäksi tulee aina muistaa säilyttää ''kohtuus kaikessa'' eli liian monen kirjasintyylin ja -koon käyttö antaa tekstistä levottoman kuvan ja siten yleensä hankaloittaa lukemista.

 

3.2 Listat ja luettelot

Listojen ja luetteloiden avulla kirjoittaja pystyy korostamaan käsiteltävän asian ominaisuuksia ja vaihtoehtoja sekä niiden järjestystä. Ne tulee sisentää tekstikappaleista ja sisennyksen avulla kannattaa erotella toisistaan myös sisäkkäiset listat (vrt. ohjelmakoodin sisennys). Listan alkioiden järjestys kannattaa suunnitella. Sopivia tapoja ovat mm. aakkos- ja tärkeys- sekä aika- ja vaihejärjestys.

Teksti ei saa muodostua pelkästään listoista esiintulleita asioita, joten ranskalaisten viivojen liiallista käyttöä tulee välttää. Toisinaan listat sen sijaan selkeyttävät ja tukevat tekstiä, joten kultainen keskitie on siis tässäkin tapauksessa hyvä suositus. Käyttöohjetyylisissä kirjoitelmissa hyvällä listojen käytöllä tiedon haku on lukijalle miellyttävää ja nopeaa.

Jos listan avulla kuvataan alkioiden (kuten termien tai parametrien) merkitystä, seuraavantyylinen esitystapa on havainnollinen:

Nimi -kenttään tulee kirjoittaa käyttäjän nimi.
Osoite -kenttään tulee kirjoittaa käyttäjän osoite, joka saattaa jopa jatkua seuraavalle tai seuraaville riveille.
Ja niin edelleen.
Jos listassa esitettävät asiat ovat alkioiden kuvausten sijaan lauseita, ranskalaisten viivojen käyttö on järkevää. Numerointia tai kirjaimia kannattaa käyttää lähinnä vain silloin, kun esitettävillä asioilla on jokin järjestys tai listan kohtiin viitataan muualla tekstissä.  

3.3 Sivujen ja lukujen numerointi

Sivut ja luvut tulee numeroida sekä tekstissä että sisällysluettelossa (katso mallia tästä ohjeesta). Sivuun, lukuun tai alalukuun tulee viitata sen numerolla (esim. Luvussa 3... tai ...(luku 3)). Toisinaan opinnäytteiden viittauksissa näkee virheellisesti puhuttavan ''kappaleesta'', kun itse asiassa viitataan lukuun tai alalukuun.

Kansisivuun ei yleensä liitetä sivunumerointia. Lukuihin tiivistelmästä tai esipuheesta aina sisällysluetteloon saakka ei liitetä lainkaan lukunumerointia ja niiden sivunumerointi toteutetaan roomalaisilla numeroilla (I, II, III,...). Lukujen ja sivujen arabialainen numerointi (1, 2, 3,...) aloitetaan perinteisesti siis vasta johdannosta, josta sitä jatketaan opinnäytteen loppuun saakka.

Sivunumeroinnissa kannattaa huomioida myös kaksipuoleinen tulostus. Paperin etusivu tulisi olla pariton ja takasivu parillinen. Lisäksi nidonnan vaatimasta selkämystilasta johtuen ''sisämarginaali'' tulisi olla ''ulkomarginaalia'' suurempi. Tiivistelmä, esipuhe, sisällysluettelo ja johdanto alkavat yleensä paperin etusivulta, joten tyhjien sivujen lisääminen saattaa olla paikallaan (katso tämän ohjeen alun sivujako). Tämä on erityisesti huomioitava siirryttäessä roomalaisesta arabialaiseen sivunumerointiin.

Em. kappaleissa mainitut sivunumeroinnin muutokset saadaan LaTeXissa aikaan muotoilukomennoilla \pagenumbering{Roman}, \pagenumbering{arabic}, \thispagestyle{empty}, \newpage ja \null. Wordin vastaavia sivunumerointiasetuksia on kuvattu Mikrotietokoneiden ohjelmistot -kurssin FAQ-dokumentissa [Heinonen].  

4 Taulukot, kuvat, esimerkit, kaavat ja lauseet

Tekstikappaleiden lisäksi opinnäytteet yleensä sisältävät myös niitä tukevia ja havainnollistavia osia, joihin yleensä liitetään numerointi ja selosteteksti. Kirjoittaja voikin auttaa lukijaa kuvien ja taulukoiden avulla hahmottamaan asiakokonaisuuksia ja yksityiskohtia. Tietotekniikan opinnäytteissä havainnollistavien esimerkkien lisäksi on yleensä tarvetta lauseille ja matemaattisille kaavoille.  

4.1 Numerointi ja selitetekstit

Kuvien, taulukoiden, lauseiden, kaavojen ja esimerkkien tulee selkeästi erottua tekstikappaleista. Lukijan tulee siis olla selvillä siitä, mistä kyseinen osanen alkaa ja mihin se päättyy. Tähän voidaan käyttää ensinnäkin normaalia kappaleväliä suurempaa tyhjää tilaa, jonka lisäksi ko. osaset monesti keskitetään, sisennetään tai kirjoitetaan muusta tekstistä erottuvalla kirjasimella.

Kuva- ja taulukkotekstit sijoitetaan kuvien ja taulukoiden alle tekstikappaleita kapeampina yleensä normaalilla kirjasimella kirjoitettuina. Kuvien ja taulukoiden sekä niihin liittyvien kuva- ja taulukkotekstien tulee olla keskitetyt sivusuunnassa. Sen sijaan vahvennetulla kirjasimella kirjoitetut lause- ja esimerkkitekstit sijoitetaan niiden alkuun vasemmalle tasattuina. Luvuissa 4.2 ja 4.3 on esimerkkejä selitetekstien merkintätavoista.

Kuvat, taulukot, lauseet, kaavat ja esimerkit kannattaa pääosin numeroida niiden selitetekstien yhteydessä, jolloin ne ovat huomattavasti helpommin ja nopeammin löydettävissä (esim. Kuva 1. Kuvateksti.). Lisäksi tällä tavoin kyseisiin osasiin viittaaminen tekstikappaleissa on helppoa (esim. Taulukossa 1 käsitellään korostavia etuliitteitä.).

Riippuen opinnäytteen pituudesta ja em. osasten määrästä numerointi voi olla yksi- tai useampitasoinen. Esimerkiksi runsaasti kaavoja sisältävässä pro gradu -tutkielmassa kaavojen numeroihin kannattaa lisätä luvun ja alaluvun numerot (esimerkiksi luvun 1.2 kolmatta numeroitua kaavaa merkitään tällöin (1.2.3)). Toisaalta parikymmensivuisessa LuK-tutkielmassa tai seminaariesitelmässä lienee järkevämpää käyttää yksitasoista juoksevaa numerointia läpi opinnäytteen.  

4.2 Taulukot ja kuvat

Taulukoihin (engl. table) ja kuviin (engl. figure) tulee siis viitata numeron avulla (katso luku 4.1), joten niiden ei tarvitse välttämättä sijaita tekstissä heti käsittelykappaleen jälkeen. Toisinaan kuvia ja taulukoita kannattaakin hieman siirtää eteenpäin, jolloin kuvan aiheuttama sivun lopussa oleva tyhjä tila saadaan (edes osittain) täytettyä.

Taulukoiden otsikkorivien ja -sarakkeiden tulee olla selkeästi tietoalkioista erottuvia. Hyviä keinoja otsikoiden esilletuontiin on kirjoittaa otsikkoalkioiden tekstit vahvennetulla (tai suuremmalla) kirjasimelle. Lisäksi otsikkorivit ja -sarakkeet voidaan erottaa vahvemmalla viivalla tietoalkioista tai tietoalkioiden väliset viivat voi jättää kokonaan tai osittain pois (katso taulukko 1).

SanaKäyttövuosi KertaluokkaEsimerkki
iso,yli[1700,2000][1,10] Yli-Isotalo (sukunimi)
mega [1950,2000][1,106] megatyttö, megatuutti
multi [1960,2000][1,5] Massey-Ferguson MultiPower
sika [1980,1989][5,10200] sikakaunis, sikasiisti
euro [1995,2000][10-6,106] eurobyrokratia, eurohumppa, eurohinta

Taulukko1. Joitain korostavia etuliitteitä vuosien varrelta.

Jos taulukko sopii kokonaisuudessaan yhdelle sivulle, sitä ei tule jakaa sivunvaihdolla. Jos taulukko on useamman sivun mittainen, kunkin taulukon osion alla tulee toistaa taulukkoteksti. Tällöin ensimmäisen sivun taulukkotekstin loppuun kannattaa lisätä sana (jatkuu) ja muiden sivujen taulukkotekstien perään sana (jatkoa). Leveät taulukot voi olla järkevä sijoittaa sivulle 90 astetta käännettynä.  

4.3 Esimerkit, kaavat ja lauseet

Esimerkit (engl. example) kannattaa sisentää normaalitekstistä ja/tai kirjoittaa normaalitekstistä poikkeavalla kirjansintyylillä (kuten koodit tasavälisellä ''koodikirjasintyylillä''). Tärkeimmät esimerkit kannattaa toisinaan numeroida ja nimetä esimerkin eteen tulevalla vahvennetulla esimerkkitekstillä. Tällöin niihin voi näppärästi viitata esimerkin numerolla (katso esimerkki 1).

Matemaattiset kaavat (engl. formula) kannattaa joko sisentää tekstikappaleista tai keskittää sivusuunnassa. Oleellisimpien kaavojen lisäksi tulee numeroida ne, joihin viitataan toisaalla opinnäytteessä. Kaikkiin matemaattisiin kaavoihin ei kuitenkaan tarvitse liittää kaavanumeroa. Kaavanumero sijoitetaan yleensä kaavan oikealle (tai vasemmalla) puolelle pystysuunnassa keskitettynä. Kaavaan viitataan sulkuihin sijoitetulle kaavanumerolla (kuten katso (1)).   

Esimerkki 1 (Oldin ja Kahnin laki) Lain mukaan toimikunnan kokouksen tehokkuus on kääntäen verrannollinen osanottajien määrään ja puheenvuoroihin käytettyyn aikaan [Bloch]. Tämä voidaan esittää matemaattisesti kaavana

                                                P = o / (nt),                                                 (1)

missä P on kokouksen tehokkuus, o toimikuntavakio, n osanottajien määrä ja t puheenvuoroihin käytetty aika.

Lauseet (engl. theorem), seuraukset (engl. corollary) ja apulauseet (engl. lemma) yleensä vähintään numeroidaan ja toisinaan myös nimetään (nimi yleensä suluissa) alussa olevan lausetekstin yhteydessä (katso lause 1). Sekä lauseteksti että todistuksen aloittava Todistus-sana kirjoitetaan yleensä vahvennetulla kirjasimella. Myös mahdolliset huomautukset (engl. remark) kirjoitetaan lauseiden tapaan.  

Lause 1 (Kalabiologin I hokema) Hauki on kala.
Todistus. Ensinnäkin hauet selvästi kuuluvat eläimiin. Todistetaan lause antiteesin avulla eli oletetaan, että hauki ei ole kala. Hauki ei ole selkärangaton, koska sillä on selkäranka. Hauki ei ole myöskään nisäkäs, koska se ei imetä jälkeläisiään. Muiden eläinryhmien läpikäynti on triviaalia, joten se jätetään todistusharjoitukseksi. Läpikäynnin seurauksena voidaan todeta, että hauki ei kuulu yhteenkään eläinryhmään. Tästä johtuen hauki ei siis kuulu eläimiin, joka aiheuttaa ristiriidan. Antiteesin väitös on siten väärä eli hauki on kala.

Esimerkkien, kaavojen ja lauseiden numerointia, selitetekstejä ja ulkoasua on kuvattu tarkemmin luvussa 4.1.

 

5 Ohjeita ja vältettäviä virheitä

Luvussa käsitellään kirjoittajan havaitsemia yleisiä opinnäytteiden kirjoitus- ja muotoiluvirheitä. Opinnäyte tulee tekstin selkeyden ja muokattavuuden takia kirjoittaa jollakin tekstinkäsittelyohjelmalla.

Kirjoittajan tulee lukea ja tarkastaa työnsä huolellisesti aina ennen sen toimittamista tarkastajalle, sillä tekstiä kirjoitettaessa ja muokattaessa syntyy väistämättä virheitä. Jos opinnäytteen toimittamisella ei ole kovaa kiirettä, se kannattaa jättää hautumaan muutamaksi päiväksi. Tämän jälkeen kirjoittaja lukee omaa tekstiään aivan ''uusin silmin'', jolloin virheiden sekä epäloogisuuksien havaitseminen on helpompaa. Opinnäytteensä tarkastuttaminen opiskelijatuttavallaan auttaa myös virheiden jäljittämisessä.  

5.1 Lauserakenteet ja lauseenjäsenet

Jokaisen luvun alussa olevan sidostekstin avulla lukija johdatetaan luvun aihealueeseen. Älä missään nimessä kirjoita luvun ja alaluvun otsikoita allekkain ilman niiden väliin sijoitettua johdantokappaletta. Luvun tai alaluvun otsikkoa ei tule sijoittaa yksinään sivun loppuun, vaan ennen sivunvaihtoa tulee olla vähintään 3-5 riviä tekstiä.

Liian pitkiä lauserakenteita tulee välttää, sillä ne hankaloittavat asian ymmärtämistä. Yli kolmen rivin mittainen virke kannattaa yleensä pilkkoa useammaksi virkkeeksi. Kahta tai useampaa sivulausetta ei tulisi sijoittaa peräkkäin samaan virkkeeseen. Tältä ongelmalta yleensä välttyy muotoilemalla ko. kappaleen kohdan uudelleen.

Liian pitkiä kappaleita kannattaa myös välttää, joten kappaleet kannattaa muokata yhtenäisiksi ja sopivanpituisiksi kokonaisuuksiksi. Ne tulee lisäksi erottaa toisistaan ensimmäistä riviä sisentämällä tai tyhjällä rivillä. Tarvittaessa tekstikappaleessa käsiteltävän asian voi nostaa esille kirjoittamalla oleellisen termin vahvennetulla kirjasimella.

Pitkät ja hankalat lauserakenteet ovat monesti seurausta englanninkielisen lähdetekstin suorasta sanoittaisesta kääntämisestä suomen kielelle. Useiden sivulauseiden ja pilkkujen käyttö yhdessä virkkeessä viittaa yleensä kyseiseen ''anglikanismiin'', jonka kitkeminen vaatii tekstin hiomista.

Lauseiden tulee sisältää kaikki tarpeelliset lauseenjäsenet oikeissa muodoissaan. Kunkin pää- ja sivulauseen tulee sisältää predikaattiverbi. Usein opinnäytteissä sivulause aloitetaan virheellisesti kysymyssanalla, vaikka se ei olekaan muodoltaan kysyvä. Sanoja missä, millä ja minkä paremmat valinnat saattavat siis olla sanat jossa, jolla ja jonka. Virkettä ei tulisi mielellään aloittaa numerolla, matemaattisella merkillä, symbolilla tai parametrin nimellä.

Suomenkielisessä tieteellisessä tekstissä vältetään minä-muodon käyttöä, ellei erityisesti haluta korostaa omaa mielipidettä tai oman työn tulosta (vrt. toteutettiin vs. toteutin). Sen sijaan englanninkielisessä tekstissä käytetään monesti we-muotoa, vaikka kyseessä olisikin yksittäinen tekijä (kuten Let us consider...).  

5.2 Välimerkit ja lisäpäätteet

Välimerkkien käyttö tuntuu olevan opinnäytteissä monesti ongelmallista, joten muutama ohje lienee paikallaan. Pää- ja sivulauseen väliin tulee sijoittaa pilkku. Jos virkkeessä on runsaasti pilkkuja, se kertoo yleensä virkkeen heikosta luettavuudesta. Esimerkiksi lauseen keskellä olevat ''tarkenteet'' kannattaa pilkkujen sijaan toisinaan erottaa muusta lauseesta sulkeilla (esim. ...käyttöjärjestelmiä (kuten DOS, Unix ja VMS) varten...).

Opinnäytteissä käytetään usein liikaa kaksois- ja puolipistettä, joista päästään eroon tekstiä muokkaamalla (esim. ...ohjaimilla lista, vierityspalkki,...). Lainausmerkkien käytössä tulee huomioida ero suomalaisen (''lainaus'') ja englantilaisen (``quotation'') käytännön välillä.

Sanoihin liitettäviä ''lisäpäätteitä'' (kuten -kin, -han ja -pa) toiset kirjoittajat suosivat aivan liikaa opinnäytteissään (esim. tietotekniikkapa onkin hauskaakin). Sanojen myöskin ja myöskään käyttöä kannattaa välttää, sillä niissähän on periaatteessa yhdistetty kaksi synonyymiä. Vastaavasti kannattaa tarkkailla joidenkin ''lisäsanojen'' (kuten myös, lisäksi, siis, siten, melko, varmasti, ehkä, eräs, yksi, sen sijaan ja tavallisesti) liiallista käyttöä, sillä niiden poistaminen ei välttämättä muuta tai vähennä lauseen sisältöä tai sen merkitystä. Oikein käytettynä kyseiset sanat sen sijaan elävöittävät tekstiä sekä saattavat jopa ilmaista kirjoittajan erilaisia painotuksia käsiteltyjen asioiden osalta.  

5.3 Yhdyssanat, englanninkieliset termit ja lyhenteet

Yhdyssanat näyttävät tuottavan runsaasti hankaluuksia opinnäytteiden kirjoittajille. Näistä virheistä puhutaan nykyisin yleiskielessä toisinaan Lappeen ranta -ilmiönä. (Kirj. huom. Asialla ei liene mitään tekemistä lappeenrantalaisten kanssa.) Kirjoittajan on syytä tarkistaa myös yhdyssanamuotoisten adjektiivien oikeinkirjoitus (esim. käyttöliittymäperustainen).

Englanninkielisten termien ja slangisanojen käyttöä tulee välttää, jos vastaava suomenkielinen termi löytyy. Suomea äidinkielenään puhuva saa yleensä suomenkielisen (''epävirallisemmankin'') termin avulla paljon paremman yleiskäsityksen aiheesta. Samalla jää luettaessa syntyvä ''isän kielen'' käytön tarve vähäisemmäksi. Monesti kuitenkin kannattaa englanninkielinen vastine laittaa kursivoituna sulkuihin suomenkielisen termin perään lyhenteen engl. kera (esim. yhdistelmälista (engl. combobox)).

Kahdessa edellisessä kappaleessa kuvatut virheet moninkertaistuvat yhdyssanoissa, joissa on englanninkielisiä termejä tai erisnimi. Yleisenä ohjeena voidaan käyttää englanninkieliseen termiin liittyvien sanojen määrää. Jos kyseessä on yksi sana, sanat kirjoitetaan yhteen väliviivan kera ilman välilyöntiä (esim. Windows-tyylinen tai Netscape-yhteensopiva). Jos sen sijaan kyseessä on useamman sanan termi, väliviivaa ennen tulee lisätä välilyönti (esim. Delphi 2.0 -pohjainen tai Save As -painike).

Lyhenteet tuottavat yleisesti hankaluuksia. Lyhenteiden yhteydessä kannattaa tarkastaa, kirjoitetaanko se kokonaan isoilla kirjaimilla, onko vain ensimmäinen kirjain iso vai onko kirjoituskäytäntö jokin toinen. Lyhenteisiin liitettävien päätteiden kirjoitustapa taivutusmuotojen yhteydessä tuntuu olevan myös hankalaa. Peukalosääntönä voidaan käyttää lyhenteen lausuntatapaa. Jos lyhenne lausutaan sanankaltaisena (esim. OLEa tai LANia), kaksoispistettä ei yleensä käytetä. Kaksoispistettä sen sijaan käytetään, kun lyhenne lausutaan kirjaimittain (kuten TCP/IP:tä tai WWW:ssä). Kaksoispisteen ja päätteen sijaan lyhennettä kannattaa toisinaan jatkaa tarkenteella (esim. C-kielellä tai OpenGL-grafiikkarajapinnan).  

6 Yhteenveto

Tässä ohjeessa on annettu neuvoja hyvän ja sujuvan tieteellisen tekstin kirjoittamiseen. Ohje on suunnattu pääasiallisesti tietotekniikan opinnäytteiden kirjoittajille Jyväskylän yliopistossa. Erityisesti on kiinnitetty huomioita tekstin rakenteeseen ja merkintätapoihin sekä kirjoittajan havaitsemiin opiskelijoiden teksteissä toistuviin kirjoitus- ja muotoiluvirheisiin.

Vaikka edellä esitetyt neuvot on kirjoitettu pääosin käskevässä muodossa, kirjoittamisessa on järjenkäyttö aina sallittua. Parhaimmillaan teksteissä tulee esille kirjoittajan persoonallisuus, mutta se ei kuitenkaan saa olla tieteellisissä teksteissä liian hallitsevassa asemassa.

Koska väistämättä tähänkin kirjoitelmaan on eksynyt kirjoitusvirheitä ja epäloogisuuksia, ohjetta päivitetään tarpeen mukaan ja uusien kirjoitelmissa havaittujen virhetyyppien ilmaantuessa. Kirjoittaja (sähköposti santanen@mit.jyu.fi, puh. (014) 260 2756) ottaa tekstiä koskevia kommentteja sekä korjaus- ja lisäysehdotuksia mielellään vastaan.

Lopuksi haluan kiittää erinomaisista tätä ohjetta korjaavista kommenteista Jonne Itkosta, Kaisa Miettistä, Marko Mäkelää, Timo Männikköä ja Timo Nurmea.  

7 Lisämateriaalia

Alpert Sherman R. ja Lam Richard B., The Ultimate Publishable Computer Science Paper for the Latter '90s: A Tip for Authors, Communications of the ACM, No. 1, Vol. 40 (January 1997), sivu 94.

Bloch Arthur, ''Murphyn laki I'', Gummerus kirjapaino Oy, Jyväskylä, 1998.

Ekholm Kai ja Heinisuo Rami, ''Elektronisen viittaamisen opas'' (lisätietoa WWW-sivulta <URL: http://www.jyu.fi/library/julkaisut/elvi/mainos.html>), Jyväskylän yliopiston kirjaston julkaisuja, 1997.

Heinonen Petri, ''FAQ (Frequently Asked Questions) eli toistuvasti esitettyjä kysymyksiä Mikrotietokoneiden ohjelmistot -kurssilla'', saatavilla World Wide Web -muodossa <URL: http://www.mit.jyu.fi/opetus/appro/faq/ohjelmistot.html>, Jyväskylän yliopisto, Tietotekniikan laitos, 31.5.2000.

Higham Nicholas J., ''Handbook of Writing for the Mathematical Sciences'', SIAM (Society for Industrial and Applied Mathematics), Philadelphia, 1993.

Huhtala Kyösti, ''Ohjeita tilastotieteen pro gradu -tutkielman puhtaaksikirjoittamisesta'', Jyväskylän yliopisto, Tilastotieteen laitos, 1997.

May Eva, ''Tiedettä Englanniksi: Akateemisen kirjoittamisen opas'', Kielikeskusmateriaalia, Korkeakoulujen kielikeskus, Jyväskylän yliopisto, n:o 103 (1995).

Männikkö Timo, ''Tietotekniikan LuK-tutkielmat'', saatavilla WWW-muodossa <URL: http://www.mit.jyu.fi/mannikko/luk-ohje.html>, Jyväskylän yliopisto, Tietotekniikan laitos, viitattu 23.8.2000.

Santanen Jukka-Pekka, ''Tietotekniikan cum laude -työprojektien ohje'', saatavilla WWW-muodossa <URL: http://www.mit.jyu.fi/palvelut/tyoprojektit/projohje.html>, Jyväskylän yliopisto, Tietotekniikan laitos, 18.8.2000.

Santanen Jukka-Pekka, ''Tietotekniikan cum laude -harjoitustöiden ohje'', saatavilla WWW-muodossa <URL: http://www.mit.jyu.fi/santanen/info/harjohje.html>, Jyväskylän yliopisto, Tietotekniikan laitos, 5.7.1999.

Tietotekniikan laitos, ''Ohjeita tietotekniikan pro gradu -tutkielman tekijöille'', saatavilla World Wide Web -muodossa <URL: http://www.mit.jyu.fi/progradut/>, Jyväskylän yliopisto, Tietotekniikan laitos, 25.5.2000.



Jyväskylässä 23.8.2000, Jukka-Pekka Santanen (santanen@mit.jyu.fi), Jyväskylän yliopisto, tietotekniikan laitos.