Tietotekniikan ohjelmointityön ohje

Kurssin laajuus on 5 op.

Ohjelmointityön tulos on tietokoneohjalma, ohjelmisto tai ohjelmakirjasto. Työn aiheen voi hankkia myös yritykseltä tai pääainelaitokseltaan. Myös omaa aihetta voi esittää ohjelmointitöiden ohjaajalle. Ohjelmointityön tuloksen on hyvä olla opetuksessa vapaasti käytettävissä.

Ohjelmointityöstä tulee sopia mieluiten ennakkoon vastaavan ohjaajan kanssa sekä toimittaa hänelle työstä lyhyt esikuvaus (katso Ehdotus-luku).

Tietotekniikan ohjelmointitöitä ohjavat lehtori Jonne Itkonen, sekä tutkijatohtori Ville Tirronen. Ohjaajat vastaavat mielellään ohjelmointitöiden suoritusta, mahdollista korvaamista ja aiheita koskeviin kysymyksiin.

Ohjelmointityön aihetta ehdottaneeseen henkilöön kannattaa erityisesti olla yhteydessä, koska hän osaa yleensä parhaiten määrittää ja rajata työn sisältöä sekä sovelluksen rakennetta ja siihen haluttuja ominaisuuksia. Sovelluksen rakennetta ja käyttöliittymää koskettavat oleelliset ratkaisut ja muutokset aiemmin sovittuun tulee hyväksyttää aihetta ehdottaneen henkilön lisäksi ohjaajalla. Tarvittaessa ongelmatilanteissa apua saa myös muilta tietotekniikan laitoksen henkilökunnasta.

Sovelluksia toteutettaessa tulee pitää mielessä kursseilla opetetut hyvän ohjelmointitavan periaatteet. Ohjelmointityön hyväksyminen saattaa hyvinkin olla kiinni niiden noudattamisesta. Lisätietoa hyvistä ohjelmointitavoista voi kysyä ohjelmointityön ohjaajalta ja kurssien luennoitsijoilta.

Versiohallinnan käyttö on pakollista. Tällöin lähdekoodi muutoksineen pysyy tallessa, joten vanhaan versioon on helppo palata. Myös uusia vaihtoehtoja toteutuksille voi helpommin kokeilla, sillä paluu vanhaan onnistuu ongelmitta.

Ohjelmointityön ongelmia pystyy osin välttämään ja hallitsemaan suunnittelun avulla. Ohjelmointityön suunnitelmassa kannattaa kuvien ja tekstin avulla hahmotella toteutettavan ohjelman ja sen osien rakennetta sekä yhteyksiä muihin ohjelmiin, tiedoistoihin, tietokantoihin ja laitteisiin. Lisäksi suunnitelmassa on hyvä kriittisesti tarkastella käytettäviä työkaluja, sekä arvioida millaisia ongelmatilanteita työssä tullaan kohtaamaan. Jo pelkkä vapaalla kädellä paperille hahmoteltu suunnitelma auttaa työssä. Esitä suunnitelma ohjaajalle työn alkuvaiheessa.

Suunnitelmaa ei kuitenkaan aina kannata noudattaa liian orjallisesti, sillä se antaa lähinnä suuntaviivat työlle. Työn edetessä tekijä oppii tuntemaan paremmin aihetta ja työkaluja, jolloin sovelluksen toteuttamiseen saattaa löytyä suunnitelmaa parempia ratkaisuja.

Ongelmien välttämiseksi tulee tekijän ottaa jo ohjelmointia aloittaessaan tavakseen kommentoida tekemänsä ohjelma hyvin, sekä kirjoittaa muistiin perustelut tehdyille valinnoille. Tällöin tekijän on jälkeenpäin helppo palauttaa mieleensä kuhunkin ohjelmakohtaan alunperin suunniteltu toiminto. Lisäksi virheen jäljittäminen kommentoidusta koodista on paljon helpompaa ja nopeampaa. Apua pyydettäessä ohjaaja kieltäytyy jäljittämästä virhettä huonosti kommentoidusta lähdekoodista. Myöskään monimutkainen ja sätösmäinen ohjelmakoodi ei tarkoita sitä, että ohjelmointityö on onnistunut ja erinomainen. Yleensä tällöin on kyse täysin päinvastaisesta.

Ongelmien sattuessa kannattaa rohkeasti ottaa yhteyttä ohjelmointityön ohjaajaan. Usein paras neuvoja on aihetta ehdottanut henkilö.

Tietotekniikan cum laude -ohjelmointitöiden dokumentointiin kuuluvat

• ohjelman tai ohjelmiston kuvaus,
• sovelluksen käyttöohje (ellei se ole integroituna toteutukseen),
• ohjelman lähdekoodi kommentteineen,
• työn tilaajan lyhyt lausunto tietotekniikan laitoksen ulkopuolelle toteutetun ohjelmointityön tapauksessa, sekä
• tekijän itsearviointi ja työn jälkiselvitys.

Työ ja dokumentit palautetaan käyttämällä versionhallintapalvelua, esimerkiksi yliopiston YouSource-versiohallintapalvelua, tai jotain muuta julkista ja avointa palvelua. Suosimme git-pohjaisia versiohallintajärjestelmiä, mutta muutkin vastaavasti saatavilla ja käytettävissä olevat kelpaavat.

Huomaathan myös, että hyvä ohjelmointitapa edellyttää versionhallinnan käyttöä myös työn aikana. Jos näin ei ole tehty, työ hylätään välittömästi.

Aiheen hyväksyminen Tietotekniikan ohjelmointityöksi edellyttää lyhyen esikuvauksen toimittamista ohjelmointitöiden ohjaajalle. Kyseinen lyhyt ohjelmointityön aiheen kuvaus tulee sisältää

• ohjelmointityön nimen,
• tekijän nimen, yhteystiedot ja pääaineen,
• tiedon siitä, että kyseessä on Tietotekniikan ohjelmointityö,
• päivämäärän,
• ohjelmointityön sisällön lyhyen kuvauksen,
• kuvauksen ohjelman oletetusta rakenteesta ja käytetyistä työkaluista,
• arvion työssä esiintyvistä ongelmakohdista, sekä
• työn arvioidun aikataulun.

Esikuvaus on ohjelmointityön tekijälle eduksi, sillä se toimii ''sopimuksena'' ohjelmointityön tekijän ja ohjaajan välillä. Lisäksi se varmistaa tiedon kulun ohjelmointitöiden ohjaajan mahdollisen vaihtumisen yhteydessä.

Jos tarjoat ohjelmointityöksi jo aiemmin valmistunutta ohjelmaa varmista, että siitä on saatavilla esikuvaus, tai että vastaavat asiat löytyvät muusta dokumentaatiosta. Toivomme myös, että ohjelma lähdekoodeineen on opetuksessa vapaasti käytettävissä.

Esikuvaus täydennetään lopulliseksi kuvaukseksi työn aikana.

Tekijän itsearvion tulee sisältää seuraavat kohdat.

• Tiivistelmä ohjelmointityöstä.
• Sisällysluettelo.
• Tehtävän kuvaus, tausta ja tavoitteet.
• Käytännön toteutus.
• Oman työn arviointi.
• Työssä käytetyt lähteet, kuten kirjat, artikkelit ja WWW-sivut.
• Ylläpitäjän tarvitsemat tiedot ja ohjeet.
• Sovelluksen mahdollinen jatkokehitys sekä ohjeet jatkokehittäjälle.
• Yhteenveto.

Selkeä käyttöohje ottaa huomioon eri käyttäjäryhmät, joille ohjelma on tarkoitettu. Vaikka käyttöohje on lähinnä suunnattu sovelluksen käyttäjille, tulee työselosteeseen sisällyttää ohjeet myös sovelluksen ylläpitäjiä ja muokkaajia varten. Älä unohda esimerkkejä ja varoituksia tilanteista, joissa ohjelma saattaa kaatua. Käyttöohje voidaan, kuten nykyisin on usein tapana, liittää myös ohjelmaan itseensä.

Jos emme saa ohjelmaa käännettyä, koottua ja käytettyä, hylätään ohjelmointityö välittömästi.

Jotta ohjelmointityöllä olisi myös opettavaista sisältöä, arvioi omaa toimintaasi työn aikana. Pohdi mm. seuraavia kysymyksiä:

• Kuinka alkuperäinen tavoite toteutui (muutokset)?
• Mikä oli vaikeaa ja mitä opit? Mitä tekisit toisin, jos aloittaisit alusta?
• Olivatko kohtaamasi ongelmakohdat samat kuin esikuvauksessa olettamasi?
• Saako ohjelman jotenkin kaatumaan? Miksi ohjelma tällöin kaatuu?
• Miten valitsemasi työkalut vaikuttivat tulokseen?
• Pitikö aikataulusi? Millä tavalla olisit voinut parantaa arviotasi.
• Vastasiko kokemuksesi sitä, mitä luennoilla ja kirjallisuudessa on on aiheesta esitetty? Miten? Miksi ei?

Kunkin lähdekooditiedoston alussa tulee esitellä tiedoston yleinen käyttötarkoitus sekä mainita tekijät ja päiväys.

Jos hyödynnät työssäsi olemassaolevaa lähdekoodia (esim. kurssien luentomateriaalin ja ohjelmointiten esimerkkikoodeja), sen tekijä on aina mainittava kyseisen lähdekooditiedoston alussa. Lisäksi kyseiseltä tekijältä tulee pyytää lupa koodin käyttöön, ettei työssään rikkoisi hänen tekijänoikeuksiaan. Joissain tapauksissa tekijä on koodinsa alussa maininnut oikeuksistaan ja koodin hyödyntämisen ehdoista. Epäselvissä tapauksissa kannattaa kysyä neuvoa ohjelmointityön ohjaajalta.

Ohjelmalistaukset kommentteineen tulee toimittaa tarkastettavaksi yousource-versionhallintapalvelun tai vastaavan julkisen ja avoimen palvelun kautta. Jos et ole käyttänyt versiohallintaa, emme tarkasta työtäsi.

Toivomme, että ohjelma on opetuksessa vapaasti käytettävissä.