Etusivu>Opinnäytetyöpakki>Insinööri

4.1 Kirjallisen raportin rakenne

Teksti rakentuu normaalin teknisen raportin kaavan mukaisesti. Jäsentelyrunko muodostuu seuraavassa esiteltävistä kohdista. Seuraava esittelyjärjestys osoittaa myös osien sijainnin insinöörityössä.

Nimiö

Nimiösivu on insinöörityön ensimmäinen lehti. Nimiöstä ilmenevät oppilaitos, koulutusala, tekijä, työn nimi, työn laji (insinöörityö) ja tekoaika.

Tiivistelmä ja abstract

Tiivistelmä on nimensä mukaisesti mahdollisimman tiivis, itsenäinen esitys työn sisällöstä. Tiivistelmästä pitää käydä selville työn tarkoitus, menetelmät, tulokset, luotettavuus ja päätelmät. Tiivistelmä kirjoitetaan passiivissa ja muotoillaan siten, että se pystyy kertomaan lukijalle dokumentin merkityksen.

Abstract eli englanninkielinen tiivistelmä esittelee työn kansainväliselle yleisölle. Se ei siis ole suora suomenkielisen tiivistelmän käännös. Englannin kielen opettaja ohjaa sen kirjoittamista.

Alkusanat

Alkusanoissa eli esipuheessa selostetaan lyhyesti insinöörityön taustaa ja tarkoitusta sekä kiitetään työtä edistäneitä henkilöitä ja yhteisöjä. Alkusanat voidaan päivätä. Alkusanat-osa ei ole pakollinen, vaan sen voi jättää pois, jos siihen ei löydy mielekästä sisältöä.

Sisällysluettelo

Sisällysluettelo auttaa lukijaa sisällön hahmottamisessa. Siihen merkitään kaikki numeroidut otsikot ja sivut, joilla kyseiset otsikot ovat. Luettelo kannattaa laatia mallipohjan luettelotoiminnon avulla.

Selkeä rakenne on lukijan kannalta helposti hahmottuva, ei liian sirpaleinen eikä myöskään ylimalkainen. Lukujen otsikot tulee laatia informatiivisiksi ja sisällön kannalta kuvaaviksi.

Symboliluettelo

Jos insinöörityössä esiintyy toistuvasti samoja symboleja tai merkintöjä, ne selitetään symboliluettelossa. Myös työn keskeiset termit voidaan tarvittaessa koota luetteloksi. Sen nimenä voi silloin olla esimerkiksi Lyhenteet ja määritelmät. Tällaiset luettelot eivät ole kaikissa töissä välttämättömiä. Luettelo laaditaan aakkosjärjestykseen. Kirjainlyhenteiden kohdalla selitetään, mistä sanoista lyhenne muodostuu ja mitä se tarkoittaa.

Huomaa, että varsinaisessa tekstissä tulee lyhenteen tai termin ensimmäisen käyttökerran yhteydessä mainita vastaavat asiat, vaikka ne luettelossa ovatkin. Myöhemmillä kerroilla selitteitä ei enää tarvita.

Johdanto

Johdanto on työn ensimmäinen numeroitu luku. Nimensä mukaisesti johdanto johdattaa lukijan aiheeseen ja esittelee työkokonaisuutta. Luvussa valaistaan esimerkiksi asian taustoja ja ongelma-alueita, esitellään työn tilaaja, kuvataan työtä ja sen tavoitteita yleisellä tasolla. Jos tavoitteita ei määritellä tarkasti erillisessä pääluvussa, ne tulee ilmaista jo johdannossa mahdollisimman täsmällisesti. Johdannon avulla lukijalle muodostuu käsitys siitä, minkä vuoksi työ oli tarpeen tehdä. Johdannossa voidaan kertoa myös yleisesti työn vaiheista ja taustaorganisaatioista sekä selvittää keskeisimmät käsitteet. Johdanto ei kuitenkaan kerro työn tuloksista tai analysoi työprosessia päätösvaiheen näkökulmasta. Johdanto on laajuudeltaan 1–2 sivua.
 
Johdanto kuvaa tavallaan lähtötilannetta, ja siksi se on usein mielekästä kirjoittaa preesensissä. Toisaalta raportoinnin näkökulmasta myös mennyt aikamuoto on mahdollinen. Tärkeintä on miettiä ilmaisutapa kokonaisuuden kannalta johdonmukaiseksi.

Käsittely

Käsittely jakaantuu useihin lukuihin. Rakenne ja otsikointi vaihtelee riippuen siitä, mikä on insinöörityön aihe. Sen vuoksi tässä esiteltävät asiat eivät anna ainoaa oikeaa ratkaisua, vaan ne ovat lähinnä esimerkkejä tavallisimmista piirteistä.

Käsittelyosan alussa esitellään alan aikaisempi tietämys, jota työssä on käytetty apuna. Tavoite ja työlle asetetut vaatimukset määritellään tarkasti. Sen jälkeen selostetaan, miten määritellyt tavoitteet tai toiminnot on pyritty saavuttamaan. Asiat selostetaan niin täsmällisesti, että asiantuntija pystyy tekstin perusteella toistamaan kokeen. Kuvauksen apuna käytetään taulukoita ja piirroksia.

Tulokset ja tulosten tarkastelu

Tulokset esitellään täsmällisesti. Tietoja voidaan havainnollistaa taulukoiden ja graafisten esitysten avulla. Tehtävä edellyttää usein testausta, ja silloin kuvataan järjestelmän testiympäristö ja testit tarkasti ja havainnollisesti. Tulosten luotettavuutta ja käyttökelpoisuutta sekä tavoitteiden saavuttamista arvioidaan. Tulosten kriittisen tarkastelun yhteydessä esitetään myös päätelmät, arviot, yleistykset, mahdolliset suositukset sekä jatkotutkimusideat ja -tarpeet. Pohdintaosuutta ja oman työskentelyn kriittistä arviointia pidetään usein prosessin ajatuksellisesti vaativimpana osuutena.

Yhteenveto

Yhteenveto on insinöörityön päätösluku. Se on yleiskatsaus työstä, sen ongelmista, tuloksista ja päätelmistä. Siinä ei esitellä enää uutta tutkimusaineistoa. Yhteenveto eroaa tiivistelmästä siinä, että se ei ole itsenäinen, vaan eräänlainen kertausosa koko tekstiin paneutuneelle lukijalle. Yhteenvedon pituus on tyypillisesti 1-2 sivua.

Lähdeluettelo

Tutkimusperinne ja tekijänoikeuslaki velvoittavat ilmoittamaan käytetyt lähteet täsmällisesti. Lähdeluettelossa annetaan lukijalle käytetyistä lähteistä niin tarkat tiedot, että hän pystyy niiden avulla tarkistamaan työssä käytetyt lainaukset tai hankkimaan itselleen kyseiset teokset. Merkintäperiaatteita kuvataan esimerkiksi Tekniikan viestintä -kirjan luvussa Lähteiden merkintä (10. painos, s. 206–218).

Kajaanin ammattikorkeakoulun tekniikan alalla käytetään numeroviittausjärjestelmää (ns. Vancouverin järjestelmä). Siinä lähteet numeroidaan lähdeluetteloon juoksevasti eli siinä järjestyksessä, missä ne esiintyvät tekstissä.