Titus-projektin vaatimusmäärittely

1. Johdanto

Titus-projekti kehitti Jyväskylän yliopiston informaatioteknologian tiedekunnassa kehitettyä TIM-järjestelmää kevään 2018 aikana. Kehitystoimenpiteet kohdistuivat TIM-järjestelmän taulukoihin sekä liitteiden ja tekstiotteiden käsittelyyn.

Aiempi TIM:issä käytetty taulukkomuoto on käyttökelpoinen, mutta käytettävyydeltään hankala. Taulukon koon kasvaessa taulukon käsittely muuttuu haastavaksi ja virhealttiiksi. Titus-projekti kehitti uutta taulukkomuotoa, jossa taulukon sarakkeiden ja rivien määrittely sekä tekstin lisääminen taulukkoon olisi aiempaa helpompaa. Taulukon helpompaan käyttöön kuuluu osaltaan myös Titus-projektissa kehitetty taulukkoeditori.

Taulukoiden ohella Titus-projekti kehitti TIM-järjestelmää tiedekuntaneuvoston kokousasiakirjojen käsittelyyn soveltuvammaksi. Projektin alussa oli jo tiedossa, että pöytäkirjojen osalta liitteiden ja pöytäkirjaotteiden käsittelyssä oli TIM:issä kehitystarpeita. Projektissa TIM-järjestelmään kehitetyt toiminnot palvelevat tiedekuntaneuvoston ohella myös muita TIM-käyttäjiä.

Dokumentin alussa määritellään dokumentissa käytetyt keskeiset käsitteet, minkä jälkeen kuvataan kehitettyä järjestelmää, kehityskohteita ja järjestelmän nykyisiä käyttökohteita ja käyttäjäryhmiä. Dokumentissa kuvataan järjestelmän uutta kohdealuetta ja uusia käyttäjäryhmiä, sekä kuvataan tiedekuntaneuvoston kokousdokumenttien laatimisen prosessia, jota Titus-projektissa kehitetyt toiminnot tukevat. Vaatimusmäärittelyn keskeisintä sisältöä on kehitettäviin toimintoihin liittyvät vaatimukset sekä niiden prioriteetit ja tilat. Vaatimusmäärittelyä käytettiin vaatimusten hallintaan ja seurantaan koko projektin aikana.

Dokumentissa ei kuvata tarkemmin projektin tavoitteita, tarpeita tai ratkaistavia haasteita, joita käsitellään Titus-projektin projektisuunnitelmasta ^[1]. Projektisuunnitelman ohella muita tärkeitä dokumentteja ovat projektiraportti ^[2] ja sovellusraportti ^[3]. Projektin toimintojen kehittämisen ohessa toiminnoille on laadittu sekä käyttöohjeet ^[4] että ohjeet jatkokehittäjiä varten ^[5].

2. Keskeiset käsitteet

Luvussa kuvataan vaatimusmäärittelydokumentissa käytetyt keskeisimmät kohdealueeseen, vaatimusmäärittelyyn, ohjelmointikieliin ja tekniseen toteutukseen liittyvät käsitteet.

2.1 Kohdealueeseen liittyvät käsitteet

Dokumentissa käytetään seuraavia kohdealueen käsitteitä:

• Asiakohta tai listakohta sisältää kaiken yksittäiseen asialistan kohtaan sisältyvän tiedon kokouskutsussa tai pöytäkirjassa esityksineen ja liitteineen sekä pöytäkirjassa päätöksineen.
• Asialista tai esityslista on kokouksessa käsiteltävien asioiden listaus, josta ilmenee kokouksessa käsiteltävät asiat ja asioiden alustava käsittelyjärjestys kokouksen alussa. Informaatioteknologian tiedekunnan tiedekuntaneuvostossa käytetään molempia termejä.
• Asiavalmistelija on henkilö, joka on vastannut kokouskutsun yksittäisen asiakohdan tietojen ja esityksen valmistelusta sekä vastaa kokouksessa asiakohdan esittelystä. Asiavalmistelija vastaa myös pöytäkirjan laatimisesta kyseisen asiakohdan osalta.
• Kokouskutsu on asiakirja, jolla kokous kutsutaan koolle ja joka sisältää tiedon kokouksessa käsiteltävistä asioista liitteineen.
• Kokousvalmistelija on henkilö, joka vastaa tiedekuntaneuvoston kokousten yleisestä valmistelusta sekä kokousdokumenttien kokonaisuuden valmistelusta yhdessä asiavalmistelijoiden kanssa.
• Liite on erillinen dokumentti, joka olennaisilta osin liittyy tietyn asiakohdan käsittelyyn, mutta jonka koko sisältöä ei ole tiedostomuodon tai sisällön laajuuden vuoksi mielekästä kirjata kokonaisuudessaan asialistaan tai pöytäkirjaan.
• Puheenjohtaja johtaa tiedekuntaneuvoston kokouksia. Kokouksien puheenjohtajana toimii pääosin tiedekunnan dekaani ^[6].
• Pöytäkirja on esityslistan pohjalta kokouksesta laadittu virallinen asiakirja, johon on kirjattu muun muassa kokouksen osanottajat, tehdyt päätökset ja keskeiset keskustelunaiheet. Pöytäkirjan järjestys noudattaa kokouksen käsittelyjärjestystä.
• Pöytäkirjaote on pöytäkirjasta otettu yksittäinen asiakohta päätöksineen ja liitteineen.
• Pöytäkirjantarkastaja tarkastaa pöytäkirjan paikkansapitävyyden ennen pöytäkirjan hyväksymistä ja julkistusta. Pöytäkirjantarkastajat valitaan tiedekuntaneuvoston kokouksen alussa. Pöytäkirjantarkastajat hyväksyvät pöytäkirjan allekirjoituksellaan.
• Sihteeri pitää kirjaa kokouksen aikana tehdyistä päätöksistä. Tiedekunnan neuvoston kokouksissa toimivat sihteereinä asiavalmistelijat omien asiakohtiensa osalta.
• Tiedekuntaneuvosto on tiedekunnan hallinnossa ylin päättävä elin ^[6].
• Vesileima tai leima on tiedekuntaneuvoston kokousten pöytäkirjojen liitteisiin joka sivulle erikseen lisättävä tunniste, joka sisältää liitteen tunnistetiedot, mukaan lukien kokouksen päivämäärän, asiakohdan numeron ja liitteen numeron.

2.2 Vaatimusmäärittelyyn liittyvät käsitteet

Dokumentissa käytetään seuraavia vaatimusmäärittelyyn liittyviä käsitteitä:

• Kohderyhmä koostuu kehitettävää ohjelmistoa hyödyntävistä ihmisryhmistä ja organisaatioista.
  
• Kohdealueeseen kuuluvat kehitystyön hyödyntämisalue kuten toimiala, käyttökohde, työtehtävät ja kohderyhmät.
• Kokonaistavoite on organisaation toiminnan sisällön tai laadun kehittämiselle asetettu yleinen tavoite.
• Käyttäjä on ohjelmiston varsinainen loppukäyttäjä.
• Käyttäjärooli tai rooli on käyttäjätyyppi, jolla on tiettyjä vastuita, tehtäviä tai oikeuksia suhteessa käytettävään järjestelmään.
• Käyttäjäryhmä on tietojärjestelmässä määritelty käyttäjien ryhmä, johon voi liittyä myös rooleja.
• Tarve on kehitettävällä järjestelmällä tuettaviin toimenpiteisiin liittyvä kohderyhmän tai organisaation tarvitsema tietojen ja toimintojen kokonaisuus, joka kehittää kohderyhmän toiminnan sisältöä ja laatua.
• Tavoite on organisaation kokonaistavoitteista sekä kohderyhmien tarpeista ja ongelmista johdettu kokonaisuus, jonka saavuttaminen kehittää kohderyhmien toimintaa.
• Toive on kohderyhmään kuuluvan henkilön esittämä tuloksiin tai toiminnon kehittämiseen liittyvä alustava päämäärä.
• Vaatimus on kohdealueen tavoitteesta johdettu yksittäisten tietojen tai toimintojen tarkempi kuvaus.
• Vaatimusmäärittely on dokumentti, jossa esitetään projektiin liittyvät yksittäiset vaatimukset, tavoitteet ja tarpeet sekä kaikki niihin olennaisesti liittyvä kirjallinen ja kuvallinen aineisto.

2.3 Tekniset käsitteet

Dokumentissa käytetään seuraavia ohjelmointiin ja ohjelmointityökaluihin liittyviä käsitteitä:

• CSS (Cascading Style Sheets) on tyyliohje, jota käytetään erityisesti WWW-dokumenteissa sivun ulkoasun muotoilussa.
• Datalohkon avulla hallitaan taulukkoeditorilla syötettyä ja muokattua dataa.
• Dialogi eli dialogi-ikkuna on verkkosivulta aukeava erillinen ikkuna, jonka kautta käyttäjä voi suorittaa dialogiin kytkettyjä toimintoja. TIM:issä esimerkiksi tulostuspainike avaa tulostusdialogin.
• Excel eli Microsoft Office Excel on yleisesti käytössä oleva taulukkolaskentaohjelmisto. Yleisyytensä vuoksi sitä pidetään jonkinasteisena standardina taulukkolaskentaohjelmistojen toiminnoille ja käyttöliittymälle.
• Git on avoimen lähdekoodin hajautettu versiohallintajärjestelmä.
• GitLab on verkkoselainpohjainen Git-versiohallintaohjelmisto, jota käytetään projektissa versiohallintaan.
• HTML on hyperlinkkejä sisältävän tekstin merkintäkieli, jolla voidaan kuvata tekstin rakennetta. Sitä käytetään WWW-ympäristössä.
• Id eli tunniste on yksilöllinen tunniste.
• JavaScript on dynaaminen merkintäkieli, jolla lisätään WWW-sivuille toiminnallisuutta.
• JSON (JavaScript Object Notation) on yksinkertainen tiedostomuoto tiedonvälitykseen. JavaScript-yhteensopivuuden vuoksi se on yleisesti käytössä WWW-pohjaisissa järjestelmissä.
• Kappale-editori on TIM:issä yksittäisen tekstikappaleen muokkaamiseen käytettävä tekstieditori.
• LaTeX on TeXin laajennos. LaTeX-muoto on käyttäjälle selkeämpi, ja TeXiä käytetäänkin nykyisin lähinnä LaTeXin kautta.
• Makro on sääntö, jolla muutetaan syöte haluttuun muotoon.
• Markdown on merkintäkieli, jota TIM-dokumentit käyttävät.
• PDF on dokumenttien alustariippumattomaan esittämiseen tarkoitettu tiedostomuoto.
• Plugin tai liitännäinen on TIM-järjestelmän osa, jolla voidaan lisätä toiminnallisuutta dokumentteihin.
• Preamble (johdanto) on pohjatiedosto, joka mahdollistaa koko kansion dokumenttien määritysten tekemisen kerralla. Preamble lisää kansiossa olevan dokumentin alkuun aina preamble-tiedoston sisällön.
• Taulukkoeditori tarjoaa TIM:issä peruskäyttäjille käyttäjäystävällisemmän vaihtoehdon taulukon muotoiluun ja käyttämiseen.
• Tekstieditori eli tekstinmuokkain on tarkoitettu puhtaan tekstin kirjoittamiseen ja muokkaamiseen. Tekstieditoreissa itsessään ei ole yleensä muotoiluominaisuuksia, eikä merkintäkielillä toteutettuja muotoiluja näytetä tekstieditorissa muotoiluina.
• TeX on tieteellisen tekstin käsittelyyn soveltuva tekstinkäsittely ja -ladontajärjestelmä.
• TIM on Jyväskylän yliopistossa kehitetty vuorovaikutteinen oppimisympäristö.
• YAML (YAML Ain't Markup Language) on merkintäkieli.

3. TIM

Luvussa kuvataan projektissa kehitettyä järjestelmää ja sen aiempia kohderyhmiä.

3.1 TIM-järjestelmä ja kehityskohteet

Titus-projektiryhmän kehityskohteena oli Jyväskylän yliopiston kehittämä vuorovaikutteinen TIM-oppimisympäristö. Se mahdollistaa luentomateriaalien jakamisen, tehtävien tekemisen ja palauttamisen, käyttäjien omien kommenttien ja merkintöjen lisäämisen sekä materiaalien tulostamisen järjestelmästä.

TIM-oppimisympäristön kohdealue ovat tähän asti olleet vuorovaikutteiset oppimateriaalit, joita käyttävät esimerkiksi oppilaitokset. Perinteisesti luentomonisteita on laadittu Microsoft Wordilla, LaTeXilla tai muilla tekstinkäsittelyohjelmistoilla ^[7]. Luentomateriaalien jakamisessa on Jyväskylän yliopistossa käytössä useita erilaisia oppimisympäristöjä, kuten Optima, Moodle ja Koppa, joilla kaikilla on omat etunsa ja haittansa opetus- ja opiskelukäytössä. TIM:istä haluttiin kehittää järjestelmä, jonka avulla pystytään paitsi jakamaan opiskelumateriaalia tehokkaasti, myös mahdollistamaan monipuolinen ja vuorovaikutteinen opiskelu mahdollisimman yksinkertaisesti yhden alustan avulla.

Ensisijaisia kohderyhmiä ovat aiemmin olleet opettajat ja oppilaat. Tällä hetkellä TIM on käytössä useilla kursseilla informaatioteknologian tiedekunnassa. Lisäksi TIM:iä lienee kokeiltu tai käytetty myös bio- ja ympäristötieteiden, filosofian, fysiikan, kasvatustieteiden, liikunnan, matematiikan ja tilastotieteen kursseilla.

Projektissa kehitetyt ominaisuudet mahdollistavat kohdealueen laajentamisen koskemaan myös informaatioteknologian tiedekunnan tiedekuntaneuvoston materiaaleja. Kohderyhmä laajeni tiedekunnan hallinnolliseen henkilökuntaan ja tiedekuntaneuvostoon. Uuden kohdealueen ja uusien käyttäjäryhmien tavoittaminen vaati TIM:iin lukuisia pieniä uusia toimintoja ja vanhojen toimintojen kehittämistä. Uudet toiminnot sekä jo olemassa olevien toimintojen muokkaaminen ja edelleen kehittäminen palvelee myös edellä mainittuja käyttäjäryhmiä.

3.2 Käyttäjäryhmät ja käyttöoikeudet

TIM:iä on aiemmin hyödynnetty ennen kaikkea opetuskäytössä. TIM:in käyttäjäryhmät ovat jaettavissa henkilöstöön ja opiskelijoihin sekä muihin mahdollisiin käyttäjiin. Käyttäjäryhmiä on mahdollista jakaa myös kirjautumistoiminnon perusteella. Henkilöstö ja opiskelijat pystyvät kirjautumaan järjestelmään, kun kirjautumattomien käyttäjien toiminnot ovat rajoittuneemmat.

Henkilöstön rooli on TIM:issä perinteisesti ollut opiskelumateriaalien laatiminen TIM:iin. Luentomateriaalien laatimisen ohella opettajat voivat laatia TIM:iin tehtäviä ja kokeita sekä tarkistaa ja pisteyttää niitä.

Opiskelijat, joilla on käyttöoikeudet kurssialueelle, voivat TIM:issä paitsi lukea materiaaleja ja tehdä tehtäviä, myös osaltaan osallistua materiaalien laatimiseen sivuille. Opiskelijoiden mahdollisuudet muodostaa aineistoa kurssille ovat kurssikohtaista. Kansion tai sivun oikeuksien hallinnasta vastaa yleensä kurssin opettaja.

Käyttäjäryhmissä on olennaisessa roolissa oikeuksien hallinta, joista vastaa sivun tai kansion ylläpitäjä. TIM:issä on käytössä neljän tasoisia käyttöoikeuksia: view-, edit-, manage ja owner-oikeudet. Oikeuksia pystyy asettamaan yksittäisille kirjautuneille käyttäjille tai kokonaisille käyttäjäryhmille.

TIM:in käyttäjäryhmät, käyttöoikeudet ja niiden molempien hallinta soveltuu hyvin TIM:in kohdealueen laajentamiseen koskemaan myös tiedekuntaneuvoston kokousdokumenttien laatimista ja jakamista. Tiedekuntaneuvoston dokumenttien kannalta on olennaista, että erilaisia käyttäjiä ja käyttäjätasoja voidaan hallita helposti. Tiedekuntaneuvoston kokousdokumenteissa ja niiden oikeuksien hallinnassa täytyy huomioida seuraavat mahdolliset käyttäjäryhmät:

• tiedekuntaneuvostoon kuulumattomat käyttäjät,
• tiedekuntaneuvoston jäsenet,
• pöytäkirjantarkastajat ja
• kokousdokumenttien laatijat.

Kokousdokumenttien laatijoilla täytyy olla oikeudet laatia ja muokata dokumentteja sekä hallita dokumenttien julkisuutta. Kokousdokumentit eivät voi keskeneräisinä olla muiden kuin laatijoidensa saatavilla. Kokousdokumenttien laatijat julkistavat kokousdokumentit tiedekuntaneuvostolle, kun kokousdokumentit on katsottu valmiiksi. Pöytäkirjantarkastajille voidaan antaa pääsy pöytäkirjoihin ennen kuin ne ovat julkistettu koko tiedekuntaneuvostolle. Tiedekuntaneuvostoon kuulumattomilla on oikeus lukea kokouskutsu ja pöytäkirjat niiden kokousten ja dokumenttien julkistamisen jälkeen, mutta tiedekuntaneuvostoon kuulumattomat eivät saa nähdä kokousdokumenttien liitetiedostoja.

4. Informaatioteknologian tiedekunnan tiedekuntaneuvoston toiminta

Titus-projektissa kehitettyillä toiminnoilla tuetaan informaatioteknologian tiedekunnan tiedekuntaneuvoston kokousten työnkulkua kokouskutsujen ja pöytäkirjojen laatimisen osalta. Tiedekuntaneuvosto ei vielä käytä TIM:iä kokouksiin liittyvien materiaalien ylläpitämisessä ja jakamisessa, mutta siirtymää TIM:in käyttöön on pyritty tukemaan tiedekuntaneuvoston tarpeisiin kehitetyillä toiminnoilla sekä perehdyttämällä keskeisiä henkilöitä TIM:in käyttöön.

4.1 Informaatioteknologian tiedekunnan tiedekuntaneuvosto

Informaatioteknologian tiedekunnan hallintoon osallistuvat tiedekuntaneuvosto, dekaani, varadekaanit, hallintopäällikkö ja tiedekunnan hallintohenkilöstö. Tiedekuntaneuvostoa ja tiedekunnan työskentelyä johtaa dekaani. Tiedekuntaneuvostoon kuuluu dekaanin ohella professoreja, muuta opetus- ja tutkimushenkilöstöä sekä opiskelijajäseniä ja kaksi tiedekunnan ulkopuolista jäsentä. Informaatioteknologian tiedekunnassa tiedekuntaneuvosto kokoontuu säännöllisesti noin kerran kuussa. ^[8]

Tiedekuntaneuvoston tehtävät on määrätty yliopiston johtosäännössä ^[6]. Tiedekunnan ylimpänä hallintoelimenä sillä on yhtenä tärkeimmistä tehtävistä hyväksyä tiedekunnan toiminta- ja taloussuunnitelmat sekä päättää tiedekunnan talousarviosta. Tiedekuntaneuvosto arvioi ja kehittää tiedekunnassa annettavaa koulutusta, tehtävää tutkimusta ja yhteiskunnallista vuorovaikutusta. Tiedekuntaneuvosto tekee niihin liittyen esityksiä sekä laatii lausuntoja. Tiedekuntaneuvosto vaikuttaa myös opetussuunnitelmiin, opiskelijoiden valintaperusteisiin ja henkilöstövalintoihin sekä vastaa dosentin ja kunniatohtorin arvojen myöntämisestä.

4.2 Kokousten dokumenttien laatimisen prosessin nykytila

Tiedekuntaneuvoston kokousten sekä kokouksiin liittyvien dokumenttien valmisteluun ja käsittelyyn osallistuu useita henkilöitä tiedekunnan hallinnossa. Tiedekuntaneuvoston kokousprosessi on jaettavissa seuraaviin osa-alueisiin:

1. kokouksen valmistelu,
2. kokouskutsun laatiminen,
3. kokous,
4. pöytäkirjan laatiminen,
5. pöytäkirjan tarkastaminen ja
6. pöytäkirjan julkistaminen.

Kokouksen valmistelu pitää sisällään kokouksen tilan ja kahvituksen varaamisen, kokouksesta tiedottamisen sekä kokouskutsun lähettämisen jälkeen tiedekuntaneuvoston jäsenten poissaoloilmoitusten seuraamisen kokouksen peruuntumisen varalta. Kokoustilojen ja kahvitusten varaaminen hoidetaan usein useammalle kokoukselle yhdellä kertaa.

Kokouskutsun laatimiseen osallistuvat kokousvalmistelijan ohella asiavalmistelijat, ilmoittaja ja tiedottaja. Kokouskutsu koostuu asialistasta, asiakohdista liitteineen sekä ilmoitusasioista. Kokousvalmistelija vastaa kokouskutsun kokonaisuudesta ja numeroinnista. Asiavalmistelijat vastaavat asiakohtien koostamisesta ja ilmoittaja ilmoitusasioiden koostamisesta kokouskutsuun. Tiedottaja vastaa yhdessä kokousvalmistelijan kanssa kokouskutsun lähettämisestä tiedekuntaneuvostolle sekä kokouksesta tiedottamisesta tiedekunnan henkilöstölle. Kokouskutsu laaditaan pääosin Microsoft Word -tekstinkäsittelyohjelmalla. PDF-tiedostoiksi muutetut yksittäiset asiakohdat ja asiakohtia koskevat liitetiedostot tallennetaan yhteiselle verkkolevylle. Tiedottaja hakee tarvittavat tiedostot verkkolevyltä sekä lisää liitteisiin PDF-työkalulla vesileimat ennen tiedostojen yhdistämistä kokouskutsuksi. Ilmoitusasioiden laatimisessa käytetään Microsoft Excel -ohjelmistoa. Kokouskutsun valmistelun prosessi on kuvattu työnkulkukaaviossa kuvassa 1.

Kokouksen prosessia ei ole työnkulkukaavioissa erikseen kuvattu. Kokous noudattaa virallisten organisaatioiden ja lakisääteisten toimielinten kokouksille ominaista kaavaa. Kokous alkaa kokouksen avaamisella, kokouksen laillisuuden ja päätösvaltaisuuden toteamisella sekä pöytäkirjantarkastajien, sihteerien ja pöytäkirjanpitäjien valitsemisella. Kokouksen alussa todetaan esityslistan järjestys ja sovitaan mahdollisista muutoksista esityslistan käsittelyjärjestykseen, minkä jälkeen kokous käydään asiakohtien mukaisessa järjestyksessä. Kokouksen aikana sihteerit ja pöytäkirjanpitäjät pitävät kirjaa kokouksen läsnäolijoista, kokouksessa käydystä keskustelusta sekä tehdyistä päätöksistä. Kukin sihteeri ja pöytäkirjanpitäjä tekee muistiinpanoja kokouksesta itselleen ominaisilla työvälineillä ja -tavoilla.

Pöytäkirjan laatimisen prosessi on kuvattu työnkulkukaaviossa kuvassa 2. Pöytäkirjan laatimiseen osallistuvat kokousvalmistelija, asiavalmistelijat, tiedottaja ja tiedekuntaneuvosto. Kokousvalmistelija vastaa läsnäolijoiden sekä pöytäkirjantarkastajien ja -pitäjien merkitsemisestä. Asiavalmistelijat vastaavat kokouskutsun asiakohtien muuttamisesta pöytäkirjan asiakohdiksi sekä läsnäolijoiden merkitsemisestä asiakohdittain. Kokousdokumentit laaditaan pääosin Microsoft Word -tekstinkäsittelyohjelmalla sekä tallennetaan PDF-tiedostoina yhteiselle verkkolevylle. Tiedottaja koostaa erillisistä dokumenteista yhtenäisen pöytäkirjan sekä koostaa liitteistä yhden liitetiedoston siten, että jokaiseen liitteeseen on merkittynä liitteiden tunnistetiedot. Tiedottaja lähettää dokumentin pöytäkirjantarkastajille tarkastettavaksi.

Pöytäkirjan tarkastamisen suorittaa kokouksessa pöytäkirjantarkastajiksi valitut henkilöt. Pöytäkirjantarkastajat varmistavat ennen kaikkea pöytäkirjaan kirjattujen päätösten vastaavan sitä, mitä kokouksessa on sovittu ja keskusteltu. Mikäli pöytäkirjantarkastajat huomaavat pöytäkirjassa jotain huomautettavaa, palautuu pöytäkirja tiedottajan kautta asiavalmistelijoille korjattavaksi. Pöytäkirjantarkastajat allekirjoittavat hyväksytyn pöytäkirjan. Allekirjoitettu pöytäkirja arkistoidaan.

Pöytäkirjan julkistaminen tapahtuu vasta pöytäkirjan hyväksymisen jälkeen. Pöytäkirjasta julkistetaan kaksi versiota, joista julkisesti saataville asetetaan pöytäkirja ilman liitteitä ja tiedekuntaneuvoston saataville pöytäkirja liitteineen. Tiedottaja ottaa tarvittaessa pöytäkirjan yksittäisistä asiakohdista pöytäkirjaotteita lähetettäväksi asianosaisille. Tiedottaja ilmoittaa pöytäkirjan julkistamisesta tiedekuntaneuvostolle, henkilökunnalle sekä muille sovituille tahoille.

4.3 Kokousdokumenttien laatiminen TIM:iä apuna käyttäen

Tiedekuntaneuvoston kokousdokumenttien TIM-järjestelmällä laatimisen yksi saavutettavista eduista on työkalujen väheneminen. TIM:issä kokousdokumentit voi laatia Wordin sijaan suoraan TIM:iin, jossa useampi asiavalmistelija voi työstää samaa dokumenttia yhtä aikaa. Dokumenttien julkistaminen ja julkisuuden hallinta onnistuu myös, sillä dokumentteja ei tarvitse siirtää muihin verkkopalveluihin julkistamista varten. Tarvittaessa TIM:istä saa dokumentit helposti muutettua PDF-tiedostoiksi tulostamista ja arkistointia varten. Projektissa kehitettävät ominaisuudet mahdollistavat liitetiedostojen tallentamisen suoraan TIM:iin, jolloin myös liitteiden leimaamiseen ei tarvita erillistä ohjelmistoa.

Prosessin tavoitetilana oli vähentää käytettyjen työkalujen ohella myös prosessin vaiheita. TIM:issä tämä onnistuu käytettävien työkalujen sekä kokousdokumenttiin tarvittavien erillisten tiedostojen määrän vähentämisellä. Aiemmin jokainen asiavalmistelija on valmistellut omat asiakohtansa erillisinä tekstitiedoistoina, jotka on muutettu PDF-tiedostoiksi ja lopulta yhdistetty yhdeksi suureksi tiedostoksi. TIM sallii dokumentin yhtäaikaisen muokkaamisen, jolloin erillisiä tiedostoja (muita kuin liitetiedostoja) ei varsinaisesti tarvita kokousdokumenttien laatimisessa.

Kuvissa 3 ja 4 on kuvattu kokousdokumenttien työnkulkua TIM:illä toteutettuna, kun TIM:iin on toteutettu projektissa suunnitellut työkalut ja ominaisuudet.

5. Vaatimusten prioriteetit ja tilat

Vaatimusmäärittelydokumentissa vaatimukset on taulukoitu toimintokokonaisuuksien mukaan. Vaatimuksissa käytetään seuraavia prioriteetteja:

• Välttämätön vaatimus on pakollinen sovelluksen toiminnan kannalta.
• Tärkeä vaatimus tuo lisäarvoa käyttäjälle, mutta sovellus on käytettävissä ilman sitäkin.
• Mahdollinen vaatimus on hoidettavissa muulla tavalla tai sen tuoma lisäarvo on vähäinen suhteessa vaatimuksen toteuttamisen vaatimiin resursseihin.
• Idea-tasolle määritellyn vaatimuksen tarve ei ole vielä kunnolla tiedossa tai sen tarve on niin vähäinen, että vaatimuksen toteutus on riippuvainen muilta vaatimuksilta ylijäävistä resursseista.
• Hylätty vaatimus on todettu tarpeettomaksi.

Vaatimusmäärittelydokumentissa seurataan dokumenttien prioriteettien ohella vaatimusten toteutumia tilojen avulla. Vaatimusten tilat ovat seuraavat:

• Löytyy TIM:istä vaatimus on jo aiemmin toteutettu.
• Hyväksytty vaatimus on toteutettu, testattu ja hyväksytty.
• Testattu vaatimus on toteutettu ja testattu, mutta ei hyväksytty.
• Toteutettu vaatimus on toteutettu, mutta ei testattu.
• Kesken olevan vaatimuksen toteuttaminen on aloitettu.
• Toteuttamatta olevan vaatimuksen toteutusta ei ole aloitettu.
• Ei toteuteta tarkoittaa, että tilaajan kanssa on sovittu, ettei vaatimusta toteuteta Titus-projektin puitteissa.

6. Taulukon tasot ja näkymät

Titus-projektin yhtenä päätavoitteista on kehittää TIM:iin uusi taulukkomuoto. Nykyinen taulukkomuoto on peruskäyttäjän näkökulmasta muotoiluiltaan hieman haastava, virhealtis ja hidaskäyttöinen. Taulukkomuodon kehitys tukee niin IT-tiedekunnan tiedekuntaneuvoston pöytäkirjojen laatimisprosessia kuin palvelee muitakin TIM-käyttäjiä.

Titus-projektin puitteissa kehitettiin taulukkoeditoria taulukon solujen sisällön nopeampaan muokkaamiseen. Rajallisten ajallisten resurssien vuoksi taulukkoeditoria ei kehitetty solujen sisällön muokkaamista pidemmälle.

6.1 Taulukon tasot

Uutta taulukkomuotoa kehitetään neljän eri tason kautta, ja taulukoita tulee pystyä käyttämään ja muokkaamaan käytännössä kolmessa näkymässä. Tasot etenevät karkeasta toteutuksesta kohti edistyneempää editoria. Taulukoiden tasoja on kuvattu taulukossa 1.

Taulukko 1: Taulukoiden tasot.

6.2 Taulukoiden näkymät

Taulukoiden eri tasot ja niiden muokkaaminen näyttäytyvät hieman eri tavoin eri näkymissä. Ensimmäinen näkymistä on ns. normaali TIM:in näkymä tai lukunäkymä. Kyseisellä sivulla TIM-dokumenttia luetaan, ja sivun päällä ei ole nähtävissä mitään editoreja. Näkymästä päästään vasemman reunan valikon kautta normaaliin kappale-editorinäkymään muokkaamaan taulukkoa tekstimuodossa. Kuvassa 5 näkyy lukunäkymän päälle avattu kappale-editori.

Solujen tietosisällön muokkausnäkymä mahdollistaa taulukon sisällön ja rakenteen muokkaamisen. Toiminnallisuuden saa käyttöön tekstin vasemman laidan valikosta komentoa painamalla, jolloin sivun päälle avautuu erillinen dialogi tai yksinkertainen editori välttämättömimpien muokkausten tekemiseksi. Näkymää hyödynnetään solujen ja taulukon rakenteen editoinnissa käyttöliittymässä. Kappale-editorista ja sen käytöstä kerrotaan tarkemmin TIM-ohjeissa ^[9].

Taulukon muokkausnäkymä antaisi taulukon rakenteen editoinnin ja taulukkolaskennan tasolla käyttöön entistä paremman editorin, jossa olisi mahdollisesti enemmän painikkeita ja valikoita, ns. "Excel TIM:issä". Näkymän voisi käynnistää esimerkiksi tekstin muokkauksen editorin kautta advanced view -valinnan avulla. Titus-projektissa ei kehitetä editoria taulukon rakenteen editointiin tai taulukkolaskentaan.

Taulukoiden näkymät on kuvattu taulukossa 2.

Taulukko 2: Taulukoiden näkymät.

7. Taulukon vaatimukset

Taulukon vaatimukset jakautuvat taulukkomuotoa koskeviin vaatimuksiin, taulukoiden eri muokkaustapojen vaatimuksiin sekä läsnäolijataulukoiden vaatimuksiin. Suurimpaan osaan vaatimuksista liittyy myös vaatimus taulukon käännettävyydestä LaTeX-muotoon tulostettaessa.

7.1 Taulukon muokkaaminen kappale-editorilla

Taulukon yksinkertaisin taso mahdollistaa taulukon käyttämisen ja muokkaamisen TIM:in oman kappale-editorin kautta, jolloin taulukkoa käytetään, täytetään ja muokataan muokkaamalla YAML-koodia.

Taulukkomuotoon liittyy runsaasti taulukon eri elementtejä koskevia vaatimuksia, mikä aiheuttaa vaatimuksissa toisteisuutta. Taulukon elementeillä tarkoitetaan taulukkoa itseään ja taulukon osista riviä, saraketta ja solua. Vaatimuksien prioriteetit ja toteutusmahdollisuudet eroavat jonkin verran eri elementeillä, joten toisteisuus on välttämätöntä ja perusteltua.

Samoja ominaisuuksia näkyy vaatimuksissa myös sen takia, että niiden on toteuduttava paitsi taulukkomuodon rakenteessa myös HTML:llä verkkosivunäkymässä. Lisäksi niiden on oltava käännettävissä LaTeXiksi dokumentin tulostamista varten.

7.1.1 Taulukon ominaisuudet

Käyttäjä voi määritellä taulukon osille ominaisuuksia. Samat ominaisuudet ovat pääosin määritettävissä niin yksittäisille soluille kuin koko taulukolle kerrallaan. Taulukossa 3 näkyvät prioriteetteineen ne ominaisuudet, joita käyttäjä voi määritellä koko taulukolle.

Taulukko 3: Taulukon ominaisuudet.

Tulostusta varten taulukko on pystyttävä muuttamaan LaTeX-muotoon. Taulukon ominaisuuksia on huomioitava muuntamisessa taulukon 4 mukaisesti. LaTeXin toimintalogiikka poikkeaa HTML:stä, minkä johdosta kaikkien ominaisuuksien toteuttaminen HTML:ää vastaavasti ei ole mahdollista tai käytännöllistä LaTeX-muodossa.

Taulukko 4: Taulukon ominaisuudet LaTeXilla.

7.1.2 Solun ominaisuudet

Käyttäjä voi määritellä taulukon 5 mukaisesti ominaisuuksia yksittäisille soluille. Ominaisuudet koskevat niin taulukkomuotoa kuin taulukon esittämistä HTML:ssä.

Taulukko 5: Solun ominaisuudet.

Tulostusta varten solun ominaisuuksia on huomioitava LaTeX-muodossa taulukon 6 mukaisesti. LaTeXin toimintalogiikka poikkeaa HTML:stä, minkä johdosta kaikkien soluun liittyvien ominaisuuksien toteuttaminen HTML:ää vastaavasti ei ole mahdollista tai käytännöllistä LaTeXilla.

Taulukko 6: Solun ominaisuudet LaTeXilla.

¹ Jäljellä olevat bugit, virheet ja ongelmat ovat siirretty jatkokehitykseen. Ongelmat on kuvattu dokumenteissa TimTable - ohjeet jatkokehittäjille ^[10] ja Titus-projektin toiminnallisen uusintatestauksen raportti ^[11].

7.1.3 Sarakkeen ominaisuudet

Käyttäjä voi määritellä yksittäiselle sarakkeelle tai sarakkeiden joukolle ominaisuuksia taulukon 7 vaatimusten mukaisesti.

Taulukko 7: Sarakkeen ominaisuudet.

Tulostusta varten sarakkeen ominaisuuksia on huomioitava LaTeX-muodossa taulukon 8 mukaisesti. LaTeXin toimintalogiikka poikkeaa HTML:stä, minkä johdosta kaikkien sarakkeen ominaisuuksien toteuttaminen HTML:ää vastaavasti ei ole mahdollista tai käytännöllistä LaTeXilla.

Taulukko 8: Sarakkeen ominaisuudet LaTeXilla.

7.1.4 Rivin ominaisuudet

Käyttäjä voi määritellä ominaisuuksia erikseen riville taulukon 9 vaatimusten mukaisesti .

Taulukko 9: Rivin ominaisuudet.

Tulostusta varten rivin ominaisuuksia on huomioitava LaTeX-muodossa taulukon 10 mukaisesti. LaTeXin toimintalogiikka poikkeaa HTML:stä, ja sen johdosta kaikkien ominaisuuksien toteuttaminen HTML:ää vastaavasti ei ole mahdollista tai käytännöllistä LaTeXilla.

Taulukko 10: Rivin ominaisuudet LaTeXilla.

¹ Jäljellä olevat bugit, virheet ja ongelmat ovat siirretty jatkokehitykseen. Ongelmat ovat kuvattu dokumenteissa TimTable - ohjeet jatkokehittäjille ^[10] ja Titus-projektin toiminnallisen uusintatestauksen raportti ^[11].

7.2 Solujen sisällön muokkaus taulukon muokkaustilassa

Taulukon solujen sisältöä on pystyttävä muokkaamaan yksinkertaisella taulukkoeditorilla. Taulukkoeditoriin ja solujen sisällön muokkaamiseen liittyvät vaatimukset esitetään taulukossa 11. Taulukossa on kuvattuna myös toisilleen vaihtoehtoisia vaatimuksia. Vaihtoehtoiset vaatimukset on yksilöity vaatimusnumeron perässä olevalla kirjaimella, kuten vaatimukset 9.1a- 9.1e taulukossa 11.

Taulukko 11: Taulukkoeditorin ja solujen sisällön muokkaamisen vaatimukset.

Solun sisältämien tietojen käsittelyyn liittyvät vaatimukset ovat taulukossa 12.

Taulukko 12: Solun sisältämien tietojen käsittely.

7.3 Taulukon rakenteen muokkaus taulukkoeditorissa

Taulukon rakennetta olisi tarkoitus kappale-editorin ohella pystyä muokkaamaan taulukkoeditorissa. Monet taulukon rakenteeseen ja elementteihin liittyvistä vaatimuksista jätettiin ideatasolle johtuen projektin rajallisista resursseista. Vaatimuksia voinee hyödyntää mahdollisesti taulukon jatkokehityksessä.

Taulukon rakennetta voidaan muokata taulukkoeditorissa lähinnä sarakkeiden ja rivien avulla. Taulukkoeditorin sarakkeiden muokkaustoimintojen vaatimukset ovat taulukossa 13.

Taulukko 13: Vaatimukset sarakkeiden muokkaustoiminnoille taulukkoeditorissa.

Taulukkoeditorin rivien muokkaustoimintojen vaatimukset ovat taulukossa 14.

Taulukko 14: Vaatimukset rivien muokkaustoiminnoille taulukkoeditorissa.

¹ Titus-projektin puitteissa vaatimusta ei ehditty testaamaan. Toiminto saattaa sisältää bugeja, jotka tulisi huomioida jatkokehityksessä.

7.4 Solun sisällön muokkaus kappale-editorissa

Uudessa taulukkomuodossa halutaan mahdollistaa taulukon mahdollisimman monipuolinen muokkaaminen. Taulukkoeditori mahdollistaa yksittäisen solun sisällön mahdollisimman nopean ja helpon muokkaamisen, kun solun sisällön muokkaaminen kappale-editorin avulla helpottaa etenkin suurempien tekstimassojen käsittelyä solussa. Solun sisällön muokkaamiseen kappale-editorissa liittyvät vaatimukset ovat listattuna taulukossa 15.

Taulukko 15: Solun sisällön muokkaus kappale-editorissa.

Kappale-editoriin liittyvä Advanced view mahdollistaa mm. solun tekstisolun tarkemman muotoilun sekä erilaisten pluginien ja makrojen käytön solun sisällä. Kehittyneempää näkymää ei kehitetty Titus-projektissa.

7.5 Kehittynyt taulukkoeditori

Titus-projektissa ei kehitetty taulukkolaskentatoimintoja tai edistyneempää taulukkoeditoria, jossa taulukon rakenteen ja muotoilujen tekeminen olisi mahdollista. Taulukkolaskentatoiminnot suljettiin alusta alkaen Titus-projektin ulkopuolelle, mutta kehittyneempiä editointimahdollisuuksia harkittiin toteutettavan resurssien niin salliessa. Kehittyneempään editointiin liittyvät toiminnot sovittiin ideatasolle ja jatkokehittäjien harkittavaksi. Kehittyneemmässä taulukon rakenteen editointitilassa olisi eri muokkaustoiminnolle olemassa kattava valikoima työkaluja ja painikkeita, joita käyttäjä voisi käyttää helposti joutumatta turvautumaan markdowniin tai muuhun koodikieleen.

Kehittyneemmässä taulukkoeditorissa olisi mahdollista muotoilla valittujen elementtien tai valittujen alueiden osalta taulukon rakennetta tai solujen sisältöä käyttöliittymässä olevien painikkeiden ja valikoiden avulla. Kaikkia elementtejä koskettavat vaatimukset kehittyneemmän taulukkoeditorin kohdalla on kuvattu taulukossa 16.

Taulukko 16: Vaatimukset kehittyneelle taulukkoeditorille.

Kehittyneessä taulukkoeditorissa tulisi olla mahdollista tehdä toimintoja elementtikohtaisesti erilaisten valikoiden painikkeiden avulla. Vaatimukset rivien muokkaustoiminnoille ovat taulukossa 17.

Taulukko 17: Vaatimukset rivien muokkaustoiminnoille.

Vaatimukset sarakkeiden muokkaustoiminnoille kehittyneessä taulukkoeditorissa on listattu taulukkoon 18.

Taulukko 18: Vaatimukset sarakkeiden muokkaustoiminnoille.

Solujen muokkaustoimintojen vaatimukset kehittyneessä taulukkoeditorissa on listattu taulukkoon 19.

Taulukko 19: Solujen muokkaustoimintojen vaatimukset.

7.6 Asiakohtien läsnäolijataulukot

Tiedekuntaneuvoston kokousten pöytäkirjat sisältävät kahdenlaisia taulukoita kokouksissa läsnäolleista tiedekuntaneuvoston jäsenistä. Iso läsnäolijataulukko sisältää kaikki tiedekuntaneuvoston jäsenet sekä tiedon heidän läsnäolostaan eri asiakohdissa. Muut pöytäkirjassa olevat läsnäolijataulukot ovat ns. pieniä asiakohtien läsnäolijataulukoita, jotka sijaitsevat jokaisen asiakohdan alussa. Pieniin läsnäolijataulukoihin merkataan ainoastaan kyseisessä asiakohdassa läsnäolleet henkilöt.

Asiakohtien läsnäolijataulukoiden kohdalla ideana oli mahdollisuus generoida kaikkiin asiakohtiin pienemmät läsnäolijataulukot isomman taulukon merkintöjen pohjalta. Jo projektin alussa idea todettiin haastavaksi tai mahdottomaksi toteuttaa Titus-projektin aikana. Tiedekuntaneuvoston kokousdokumenttien laatimisen helpottamiseksi päätettiin kuitenkin toteuttaa taulukkopohja, jonka avulla asiakohtien taulukoiden lisääminen dokumenttiin olisi nopeaa ja helppoa. Alunperin taulukko sovittiin toteutettavaksi vanhalla taulukkomuodolla, mutta lopulta taulukko päätettiin toteuttaa myös projektin aikana kehitetyllä timTable-muodolla. Läsnäolijataulukoiden vaatimukset ovat taulukossa 20.

Taulukko 20: Läsnäolijataulukon generoinnin vaatimukset.

¹ Läsnäolijataulukon pohja sijoitetaan TIM:in kansiorakenteessa olevan, ylimmän oleellisen kansion preamble-tiedostoon. Tietoja ylläpidetään käsin ja niitä muokataan preamblessa tarvittaessa.

8. Liitteiden käsittelyn vaatimukset

Informaatioteknologian tiedekunnan tiedekuntaneuvoston kokouskutsujen ja pöytäkirjojen liitteiden käsittely ja hallinta tuo TIM:iin lisää uusia tietoja ja toimintoja. Riittävät oikeudet omaavien käyttäjien pitää pystyä lisäämään dokumentteihin suuria liitteitä helposti luettavaksi, lisäämään liitteisiin vesileimoja liitteiden sitomiseksi oikeisiin asiakohtiin sekä yhdistämään liitteitä arkistointia varten.

Monet PDF-liitteiden käsittelyyn liittyvistä vaatimuksista ja toiveista oli jo ennen Titus-projektia toteutettu TIM:issä, mutta toimintoja kehitettiin vielä käyttäjäystävällisemmiksi tai selkeimmiksi tiedekuntaneuvostoa varten. TIM:istä puuttuivat kokonaan mahdollisuudet käsitellä liitteitä niiden lisäämisen jälkeen, joten projektiryhmä toteutti kokonaisuudessaan liitteiden leimaamiseen ja yhdistämiseen liittyvät toiminnot.

8.1 PDF-liitteiden integrointi TIM:iin

PDF-liitteiden lisääminen TIM:iin on ollut mahdollista jo ennen Titus-projektia videopluginin ja sen makron avulla. Yksinkertaisten pdf-tiedostojen lisäämisessä kokousdokumenttien liitteiksi videopluginin käyttö tuntui kuitenkin erikoiselta. PDF-liitteiden integroinnissa yksinkertaistettiin liitteiden lisäämistä tekemällä se intuitiivisemmaksi. Taulukkoon 21 on koottu PDF-liitteiden lisäämisen ja integroinnin vaatimuksia.

Taulukko 21: PDF-liitteiden integrointi TIM:iin.

8.2 Liitteiden leimaus

Tiedekuntaneuvoston kokousdokumenttien liitetiedostojen leimaamisen vaatimukset on koottu taulukkoon 22.

Taulukko 22: Liitteiden leimaus.

8.3 Liitteiden yhdistäminen

Tiedekuntaneuvoston käytänteisiin kuuluu kokouskutsun tai pöytäkirjan liitetiedostojen yhdistäminen yhdeksi suureksi PDF:ksi arkistointia varten. Liitetiedostojen yhdistämisen vaatimukset ovat taulukossa 23.

Taulukko 23: Liitteiden yhdistäminen.

9. Esityslistojen ja pöytäkirjojen muotoilu

Suuri osa kokouskutsuun ja pöytäkirjojen muotoiluun tarvittavista toiminnoista on jo olemassa TIM:issä. Titus-projektissa keskityttiin helppokäyttöisempien ja nopeampien toimintatapojen miettimiseen tiedekuntaneuvoston dokumenttien näkökulmasta. Kehitetyt toiminnot pyrkivät tukemaan ja helpottamaan kokousdokumenttien laatimista.

9.1 Dokumenttien muotoilu

Tiedekuntaneuvoston dokumenttien laatimiseen liittyy paljon irrallisia, yksittäisiä toimintoja ja vaatimuksia. Nämä irralliset vaatimukset on kasattu otsikon dokumenttien muotoilu alle, sekä ne sisältävät muotoilun ohella muitakin yksityiskohtia liittyen dokumentteihin ja niiden asetuksiin. Vaatimukset on listattu taulukkoon 24.

Taulukko 24: Esityslistat ja pöytäkirjat.

¹ Automaattinen numerointi tarkoittaa, että käyttäjän ei tarvitse manuaalisesti ylläpitää juoksevaa numerointia vaan järjestelmä vastaa numeroinnin päivittymisestä otsikoita lisättäessä, poistettaessa ja siirrettäessä.

² Läsnäolijataulukon automaattinen generointi tarkoittaa, että kun kokouskutsu muutetaan pöytäkirjaksi, koko dokumentin yläosan läsnäolijalistasta generoidaan kaikkiin asiakohtiin pienempi taulukko, joka sisältää vain asiakohdissa läsnäolleet henkilöt. Käyttäjän tarvitsee ylläpitää ainoastaan dokumentin alun isoa läsnäolijataulukkoa.

9.2 Kokouskutsusta pöytäkirjaksi -muunnin

Kokouskutsusta pöytäkirjaksi -muuntimen tarkoituksena on helpottaa kokouskutsun kopioimista ja muuttamista pöytäkirjaksi. Jo aiemmassa tiedekuntaneuvoston dokumenttien laatimisen prosessissa oli hyödynnetty kokouskutsua pöytäkirjadokumentin pohjana. Muunnin automatisoi tiettyjen toimintojen toteuttamista ja nopeuttaa dokumenttien laatimisen prosessia erityisesti TIM:issä. Kokouskutsusta pöytäkirjaksi -muuntimen vaatimukset ovat taulukossa 25.

Taulukko 25: Kokouskutsusta pöytäkirjaksi -muunnin.

9.3 Pöytäkirjaotteet

Tiedekuntaneuvoston kokousten pöytäkirjojen yksittäisistä asiakohdista on ajoittain tarpeen ottaa pöytäkirjaotteita asianomaisille henkilöille ja virallisille tahoille. Otteiden ottamista varten Titus-projekti kehitti TIM:iin erillisen toiminnon, jonka vaatimukset on kuvattu taulukossa 26.

Taulukko 26: Pöytäkirjaotteet.

9.4 Mahdolliset jatkokehityksessä huomioitavat ominaisuudet

Tiedekuntaneuvoston kokousdokumentteihin sekä niiden laatimiseen, ylläpitämiseen ja julkistamiseen liittyy suuri määrä yksityiskohtia, joita kaikkia ei mitenkään ehditty huomioimaan Titus-projektissa. Monet näistä yksityiskohdista on aiemmin ennen TIM:in hyödyntämistä hoidettu manuaalisesti, joten Titus-projektissa on oletettu toiminnot hoidettavan jatkossakin manuaalisesti, eikä siten ole lähdetty listaamaan yksityiskohtaisempia vaatimuksia. Toimintoja voidaan kuitenkin harkita automatisoitavaksi, joten niiden huomioiminen voi olla jatkokehityksessä suotavaa.

Projektin ulkopuolelle rajatut yksityiskohdat ovat

• kokouksen valmisteluun liittyvät vaatimukset,
• pöytäkirjan tarkastajien merkitseminen pöytäkirjaan,
• kokouksen puheenjohtajan merkitseminen pöytäkirjaan,
• pöytäkirjojen arkistointi,
• pöytäkirjojen tarkastaminen ja hyväksyminen,
• kokousdokumenttien julkistaminen sekä
• kokousdokumenttien julkisuusaika.

Kokouksen valmistelua muutoin kuin kokousdokumenttien valmistelun osalta kuvattiin lyhyesti luvussa 4.2.

Kokouksissa valitaan erikseen pöytäkirjan tarkastajat, jotka kirjataan myös kokouksen pöytäkirjaan. Pöytäkirjan tarkastajat vaihtuvat, joten heidän merkitsemisensä voi olla mielekästä säilyttää manuaalisena.

Kokouksen puheenjohtaja on yleensä tiedekunnan dekaani, joten puheenjohtajan merkitseminen voisi olla mahdollista automatisoida esimerkiksi preamblen avulla.

Pöytäkirjan arkistoinnin osalta projektissa ei selvitetty, mitä kaikkia yksityiskohtia arkistointiin liittyy liitteiden leimaamisen ja yhdistämisen ohella. Pöytäkirjan arkistointiin saattaa liittyä vielä yksityiskohtia, joiden osalta arkistointia voidaan kehittää ja kätevöittää.

Pöytäkirjojen julkistamiseen ja salassapitoon liittyy paljon yksityiskohtia, joihin ei projektin aikana otettu kantaa. Tiedekuntaneuvoston kokousdokumenttien osalta on tärkeää, että dokumenttien laatimisen aikana dokumentteihin ei pääse käsiksi kukaan muu kuin dokumenttien valmistelijat. Kokouskutsu sisältää usein salassapidettäviä liitteitä, joten kokouskutsun kohdalla on tärkeää, että kokouskutsua ei sen julkistamisen jälkeen pääse näkemään muut kuin tiedekuntaneuvoston jäsenet. Myös pelkkien liitteiden osalta tietoturva tulisi varmistaa. Pöytäkirjoissa on huomioitava, että pöytäkirjoista pitäisi pystyä julkistamaan kaksi erilaista versiota: täysin julkinen versio ilman liitteitä sekä liitteet sisältävä versio, joka julkistetaan ainoastaan tiedekuntaneuvoston jäsenille. Julkisuuden hallinnassa on syytä huomioida myös se, että pöytäkirjantarkastajilla tulisi olla pääsy pöytäkirjoihin niiden laatimisen jälkeen, mutta ennen niiden täyttä julkistamista pöytäkirjojen hyväksymistä varten.

10. Laadulliset vaatimukset

Titus-projekti lähti kehittämään TIM:in olemassaolevia toimintoja sekä täysin uusia toimintoja helpottaakseen ja nopeuttaakseen ennen kaikkea tiedekuntaneuvoston kokousdokumenttien laatimisen prosessia. Koska tavoitteena oli yksinkertaistaa prosessia ja ratkaista aiempaan prosessiin liittyviä ongelmia, on tiettyjen laadullisten vaatimusten huomioiminen oleellista.

Kehitettyjen toimintojen tulisi olla aiempaan prosessiin nähden nopeampia ja helpompia käyttää. Toimintojen tulisi olla siis riittävän helposti löydettävissä, mahdollisimman intuitiivisia käyttää sekä vaikeampien toimintojen osalta kuitenkin mahdollisimman helposti opittavissa. Kehitettyjen toimintojen käytettävyys testattiin, ja käytettävyydessä havaittiin pieniä ongelmia. Käytettävyysongelmia olisi suotavaa huomioida jatkokehityksessä.

Käytettävyyden helpottamiseksi kehitetyistä toiminnoista on laadittu mahdollisimman kattavat käyttöohjeet. Tiedekuntaneuvostoa varten kehitetyistä toiminnoista laadittiin dokumenttien tekijöille omat käyttöohjeensa, joissa huomioidaan Titus-projektiin kuulumattomia, TIM-dokumentteihin ja markdowniin liittyviä yleisempiä ominaisuuksia.

11. Vaatimusten toteutuminen

Luvussa kuvataan Titus-projektissa kehitetyt toiminnot sekä toimintokokonaisuuksien vaatimusten lukumäärät toteutumineen.

11.1 Titus-projektissa kehitetyt toiminnot

PDF-liitteiden integroinnissa kehitettiin PDF-liitteiden lisäämistä ja upotusta dokumenttiin. Toiminnon avulla PDF-liitteet ovat avattavissa ikkunaan suoraan TIM-dokumentissa tai halutessaan erilliseen välilehteen. PDF-liitteiden lisäämisen yhteydessä tapahtuu samalla myös liitteiden leimaus.

Liitteiden leimauksessa liitteiden yläkulmaan voidaan liittää joko liitteen tunnistetiedot tai vapaavalintainen teksti. Leimaamattoman liitteen saa tarvittaessa käyttöön.

Liitteiden yhdistämisessä järjestelmä etsii TIM-dokumentista kaikki uudella liitteiden integrointitoiminnolla lisätyt liitteet ja yhdistää ne yhdeksi suureksi pdf-tiedostoksi. Mikäli dokumentissa on mukana muulla tavoin lisättyjä liitteitä, toiminto jättää ne yhdistämättä ns. koontipdf-tiedostoon. Käyttäjälle palautetaan toiminnosta linkki yhdistettyyn liitetiedostoon.

Kokouskutsusta pöytäkirjaksi -muunnin muuttaa valmiin kokouskutsun pöytäkirjan pohjaksi. Toiminto kopioi alkuperäisen kokouskutsun pöytäkirjan pohjaksi ja muuttaa dokumentin asetukset niin, että pöytäkirjatoiminnot ovat uudessa dokumentissa käytettävissä. Lisäksi toiminto vaihtaa dokumentin nimen ja ylätunnisteet kokouskutsusta pöytäkirjaksi.

Pöytäkirjaotteiden ottamistoiminnossa käyttäjä pystyy luomaan pöytäkirjan asiakohdista pöytäkirjaotteet. Toiminnossa järjestelmä poimii kaikki asiakohdat pöytäkirjadokumentista ja luo niistä omat TIM-dokumentit. Käyttäjälle näytetään koontisivu kaikista pöytäkirjaotteista kerralla, jolloin käyttäjä voi valita haluamansa asiakohdan otteen joko pdf-tiedostona tai TIM-dokumenttina.

Asiakohtainen läsnäolotaulukko lisää ko. painiketta painettaessa vakiomuotoisen pienen läsnäolijataulukon pohjan dokumenttiin. Pohja sisältää kaikki tiedekuntaneuvoston varsinaiset jäsenet, sekä lisäksi kommentteina näkymättömissä kaikki tiedekuntaneuvoston varajäsenet. Läsnäolotaulukon pohja on laadittu suoraan preambleen.

Taulukkomuoto on uusi tapa kirjoittaa taulukoita TIM-dokumentteihin. Taulukkomuoto mahdollistaa muotoiluiltaan aiempaa monipuolisemmat taulukot. Lisäksi se on suunniteltu helpommin ylläpidettäväksi kuin aiemmin käytössä olleet taulukkomuodot.

Taulukkoeditori mahdollistaa uudella taulukkomuodolla kirjoitettujen taulukoiden sisällön helpon ja nopean muokkaamisen. Taulukkoeditorin ominaisuudet saadaan käyttöön taulukon viereisestä pop up -menusta. Taulukon ollessa editointitilassa voi solun sisältöä muokata yksinkertaisella syötekentällä tai kappale-editorilla. Editointitilassa taulukkoon voi myös lisätä rivejä ja sarakkeita helposti omilla painikkeilla.

11.2 Vaatimusten tilojen merkinnän käytänteet

Titus-projektin kehittämien toimintojen vaatimuksia oli yhteensä 292 kappaletta. Vaatimusten suuri määrä selittyy projektissa kehitettyjen eri toimintokokonaisuuksien runsaalla lukumäärällä sekä erityisesti uudella taulukkomuodolla. Uuden taulukkomuodon kehitys sisälsi runsaasti yksityiskohtia, ja vaatimus pystyä kääntämään kaikki halutut ominaisuudet LaTeXiksi PDF-tulostusta varten lähes tuplasi vaatimusten määrän taulukoiden osalta.

Vastaavan ohjaajan suosituksesta vaatimuksien tilaksi ei ole merkitty testattu-tilaa korkeampia tiloja. Vaatimukset jätetään vielä jatkokehittäjien testattavaksi, joten jatkokehittäjät voivat kirjata vaatimuksia tilaan hyväksytty omien testiensä pohjalta.

Titus-projektissa kehitettyjä toimintoja testattiin projektin aikana sekä toiminnallisuustestauksen että käytettävyystestauksen keinoin. Tila testattu viittaa pelkästään toiminnallisuustestaukseen, ts. käytettävyystestauksella ei ole ollut vaikutusta tiloihin. Kaikkiin vaatimuksiin ei ollut toiminnallisuustestauksessa testitapausta, mutta toiminnot useissa tapauksissa todettiin käytössä tai käytettävyystestauksessa toimiviksi. Tämä osaltaan nostaa toteutettujen vaatimusten määrää ja luo osin valheellista kuvaa toimintojen testaamattomuudesta.

Vaatimukset ja toiminnot pyrittiin saamaan projektin aikana mahdollisimman pitkälle toimiviksi ja testatuiksi. Toiminnallisuustestauksessa havaitut bugit tiputtivat kuuden vaatimuksen tilaa toteutetusta tilaan kesken. Kaikkien havaittujen bugien korjaaminen ei ollut projektin resurssien puitteissa mahdollista, tai ongelma tuli syvemmältä TIM:istä, jolloin korjaaminen Titus-projektissa kehitetyissä luokissa tai moduuleissa ei ollut mahdollista. Kesken olevat vaatimukset, joista löydettiin ongelmia, on huomioitu jatkokehittäjien ohjeessa ^[10] sekä toiminnallisuustestauksen raportissa ^[11]. Eniten kesken olevia vaatimuksia liittyi uuden taulukkomuodon LaTeX-muunnokseen.

Projektin tiimoilta suunniteltiin ja mietittiin jatkokehityskohteita, mikä näkyy idea-prioriteetin vaatimusten lukumäärässä. Luonnollisesti runsaan ideoinnin seurauksena idea- ja hylätty-prioriteettien vaatimuksista suurin osa jäi tilaan ei toteuteta tai toteuttamatta.

11.3 Vaatimusten toteutuminen kokonaisuutena

Vaatimusten kokonaistoteuma prioriteeteittain ja tiloittain näkyy taulukossa 27. Vaatimusten toteumat vaatimuskokonaisuuksittain on koottu omiin alalukuihinsa.

Taulukko 27: Vaatimusten toteutuminen prioriteeteittäin ja tiloittain.

11.4 Taulukoiden vaatimusten toteutuminen

Titus-projektissa taulukoihin liittyvät vaatimuskokonaisuudet jaettiin seuraavasti:

• taulukon muokkaaminen kappale-editorilla,
• taulukon LaTeX-muunnos,
• solujen sisällön muokkaus taulukon muokkaustilassa,
• taulukon rakenteen muokkaus taulukkoeditorissa,
• solun sisällön muokkaus kappale-editorissa,
• kehittynyt taulukkoeditori ja
• asiakohtien läsnäolijataulukot.

Taulukoiden vaatimukset olivat Titus-projektissa suurin vaatimuskokonaisuus. Yhteensä taulukoihin liittyviä vaatimuksia oli 210 kappaletta. Suurin osa vaatimuksista oli välttämättömistä mahdollisiin, mutta Titus-projektissa ideoitiin myös mahdollisia jatkokehityskohteita.

Taulukkoihin liittyvistä vaatimuksista noin puolet saatiin projektin aikana toteutettua, ja toteutetuista vaatimuksista suurin osa testattuakin. LaTeX-muunnoksen vaatimukset kasvattivat taulukoiden vaatimusten lukumäärää valtavasti, ja merkittävä osa kesken olevista tai toteuttamattomista vaatimuksista liittyikin juuri LaTeX-muunnokseen.

Taulukoiden vaatimusten kokonaisuuden toteuma on taulukossa 28.

Taulukko 28: Taulukoiden vaatimusten toteutuma.

Taulukon muokkaaminen kappale-editorilla piti sisällään pitkälti taulukon, rivien, sarakkeiden ominaisuuksiin liittyviä vaaatimuksia, jotka kytkeytyvät vahvasti uuteen taulukkomuotoon. Suurin osa vaatimuksista oli prioriteetiltään tärkeitä tai mahdollisia, sekä niistä toteutettiin ja testattiin valtaosa. Kaiken kaikkiaan uusi taulukkomuoto timTable tuli vaatimusten puolesta toteutettua enimmäkseen suunnitellusti.

Kaikki taulukon muokkaamiseen kappale-editorilla liittyvät vaatimukset toteutumineen, pois luettuna LaTeX-muunnokseen liittyvät vaatimukset, on listattuna taulukossa 29.

Taulukko 29: Taulukon muokkaamisen kappale-editorilla vaatimusten toteuma.

TimTablen LaTeX-muunnokseen liittyvien vaatimusten toteuma prioriteeteittäin ja tiloittain on listattuna taulukossa 30. LaTeX-muunnokseen liittyvät haasteet näkyvät selvästi vaatimusten tiloissa.

Taulukko 30: Taulukon LaTeX-muunnoksen vaatimusten toteuma.

Solujen sisällön muokkaus taulukon muokkaustilassa -vaatimuskokonaisuus on verrattain pieni, sillä se sisältää yhteensä vain 23 vaatimusta. Kaikki vaatimuskokonaisuuden välttämättömät, tärkeät ja mahdolliset vaatimukset vähintäänkin toteutettiin projektin aikana ja niistä suurin osa jopa testattiin. Yksikään vaatimuksista ei jäänyt kesken, mutta yhteensä viisi idea- ja hylätty-prioriteetin vaatimusta jätettiin kehityksen ulkopuolelle projektissa.

Taulukko 31: Solujen sisällön muokkaus taulukon muokkaustilassa

Vaatimuskokonaisuus Taulukon rakenteen muokkaus taulukkoeditorissa koostui enimmäkseen ideoinnista ja jatkokehityshaaveista. Titus-projektin puitteissa ei ollut resursseja lähteä toteuttamaan kovinkaan massiivista taulukkoeditoria, joten suurin osa taulukkoeditorin vaatimuksista oli ideoita ja sen vuoksi tilaltaan ei toteuteta. Projektissa huomioitiin ideoituja vaatimuksia kuitenkin mahdollisuuksien mukaan. Taulukon rakenteen muokkaukseen taulukkoeditorissa liittyvät vaatimukset toteutumineen on taulukossa 32.

Taulukko 32: Taulukon rakenteen muokkauksen vaatimuksien toteuma.

Solun sisällön muokkaamiseen kappale-editorissa kuului yhteesä vain kuusi vaatimusta. Kolme vaatimuksista löytyi sellaisenaan TIM:istä eikä vaatinut muokkausta. Loput kolme toteutettiin, ja niistä kaksi testattiin projektin aikana. Vaatimusten toteuma on listattu taulukossa 33.

Taulukko 33: Solun sisällön muokkaamisen vaatimusten toteuma.

Kehittyneen taulukkoeditorin todettiin olevan projektin resurssien ulkopuolella jo projektin alkuvaiheessa. Taulukkoeditoria varten ideoidut vaatimukset haluttiin kuitenkin kirjata ylös jatkokehittäjiä varten. Yhtäkään ideoitua vaatimusta ei lähdetty eikä aiottukaan lähteä toteuttamaan projektin puitteissa. Kehittyneen taulukkoeditorin vaatimusten toteuma on listattu taulukkoon 34.

Taulukko 34: Kehittyneen taulukkoeditorin vaatimusten toteuma.

Asiakohtien läsnäolijataulukkojen vaatimuskokonaisuus on verrattain pieni sisältäen vain 11 vaatimusta. Yksikään vaatimuksista ei jäänyt kesken ja kaikki välttämättömät ja tärkeät vaatimukset tuli projektin aikana vähintäänkin toteutettua. Asiakohtien läsnäolijataulukot olivat niin pieni toiminto, että niiden huomioiminen toiminnallisuustestauksessa jäi vähemmälle. Käytettävyystestauksessa asiakohtaisten läsnäolijataulukoiden havaittiin kuitenkin toimivan niin kuin pitääkin. Asiakohtien läsnäolijataulukoiden vaatimusten toteuma on listattu taulukkoon 35.

Taulukko 35: Asiakohtien läsnäolijataulukoiden vaatimusten toteuma.

11.5 Liitteiden käsittelyn vaatimusten toteutuminen

Liitteiden käsittely koostui kolmesta vaatimuskokonaisuudesta: liitteiden integroimisesta TIM-dokumentteihin, liitteiden leimaamisesta sekä liitteiden yhdistämisestä. Liitteiden käsittelyyn liittyviä vaatimuksia oli yhteensä 50 kappaletta. Noin viidennes vaatimuksista oli välttämättömiä tai tärkeitä, sekä kaikki ne tulivat vähintään toteutettua ja suurin osa jopa testattua. Myös idea- ja hylätty-prioriteettien vaatimuksia oli viidenneksen verran, mikä selittää toteuttamatta- ja ei toteuteta-tilojen määrää vaatimusten toteumassa. Liitteiden käsittelyn vaatimusten toteutuminen prioriteetteineen ja tiloineen näkyy kokonaisuudessaan taulukossa 36.

Taulukko 36: Liitteiden käsittelyn vaatimusten toteutuma.

Liitteiden integrointiin liittyviä vaatimuksia oli vain kuusi kappaletta, mutta kaikki vaatimukset olivat tiedekuntaneuvoston dokumenttien käsittelyn kannalta välttämättömiä. Puolet vaadituista ominaisuuksista ja toiminnoista löytyi sellaisenaan TIM:istä eivätkä ne vaatineet tiedekuntaneuvoston tarpeisiin suurempia muutoksia. Kaikki vaatimukset testattiin ja todettiin toimiviksi. Liitteiden integroinnin vaatimusten toteuma on nähtävillä taulukossa 37.

Taulukko 37: Liitteiden integroinnin vaatimusten toteutuminen tiloittain ja prioriteeteittain.

Tiedekuntaneuvoston tarpeita palvelemaan tehtiin Titus-projektin puitteissa pdf-liitteiden leimaustoiminto. Toimintoon liittyi vaatimuksia yhteensä 29 kappaletta. Vaatimusten joukossa oli paljon ideoita ja hylättyjä vaatimuksia, jotka nostivat ei toteuteta -tilan vaatimusten lukumäärän 14 vaatimukseen. Liitteiden leimauksen vaatimusten toteutuma on taulukossa 38.

Taulukko 38: Liitteiden leimauksen vaatimusten toteutuminen tiloittain ja prioriteeteittain.

Liitteiden yhdistämisen vaatimusten kokonaisuuteen kuuluu 15 vaatimusta, jotka jakautuvat tasaisesti prioriteetteihin välttämätön, tärkeä, idea ja hylätty. Yhtä lukuunottamatta kaikki välttämättömät ja tärkeät vaatimukset testattiin, sekä ainoa testaamaton vaatimus kuitenkin toteutettiin. Yhtään idea- tai hylätty-prioriteetin vaatimusta ei toteutettu Titus-projektissa. Liitteiden yhdistämisen vaatimusten toteuma on taulukossa 39.

Taulukko 39: Liitteiden yhdistämisen vaatimusten toteutuminen tiloittain ja prioriteeteittain.

11.6 Esityslistojen ja pöytäkirjojen muotoilujen vaatimusten toteutuminen

Esityslistojen ja pöytäkirjojen muotoilun vaatimukset muodostuvat seuraavista kokonaisuuksista:

• dokumenttien muotoilu,
• kokouskutsusta pöytäkirjaksi -muunnin ja
• pöytäkirjaotteet.

Esityslistojen ja pöytäkirjojen muotoiluihin kokonaisuutena liittyviä vaatimuksia on yhteensä 32 kappaletta. Näistä 11 oli prioriteetiltaan idea tai hylätty ja ne jäivät Titus-projektin toteutuksen ulkopuolelle. Vaatimuksista 20 oli välttämättömiä tai tärkeitä, ja niistä noin puolet löytyi jo valmiina TIM:istä. Jäljelle jääneistä välttämättömistä ja tärkeistä vaatimuksista toteutettiin kaikki, sekä testattiin kaikki paitsi yksi vaatimus. Esityslistojen ja pöytäkirjojen kokonaisuuteen liittyvien vaatimusten toteuma esitetään on taulukossa 40.

Taulukko 40: Esityslistojen ja pöytäkirjojen muotoilujen vaatimusten kokonaisuuden toteutuma.

Dokumenttien muotoiluun kuuluvia vaatimuksia oli yhteensä 16 kappaletta. Näistä suurin osa (10 kappaletta) löytyi valmiina TIM:istä, ja ne olivat kaikki välttämättömiä. Yhtään välttämätöntä, tärkeää tai mahdollista vaatimusta ei jäänyt toteuttamatta tai testaamatta. Idea-prioriteetin vaatimuksista kaikki neljä jäivät toteutuksen ulkopuolella. Dokumenttien muotoilun vaatimusten toteuma on taulukossa 41.

Taulukko 41: Kokousdokumenttien muotoilujen vaatimusten toteutuma.

Kokouskutsusta pöytäkirjaksi -muuntimen vaatimuksen muodostavat pienen, kahdeksan vaatimuksen kokonaisuuden. Vaatimuksista noin puolet oli välttämättömiä tai tärkeitä, ja ne toteutettiin tai testattiin. Loput vaatimukset olivat prioriteetiltaan ideoita, ja ne sovittiin jätettäväksi tarkoituksella Titus-projektin ulkopuolelle. Kokouskutsusta pöytäkirjaksi -muuntimen vaatimusten tarkempi toteuma on taulukossa 42.

Taulukko 42: Kokouskutsusta pöytäkirjaksi -muuntimen vaatimusten toteutuminen

Pöytäkirjaotteisiin liittyviä vaatimuksia oli yhteensä 8 kappaletta, joista 5 oli välttämättömiä ja 3 hylättyjä. Kaikki välttämättömät vaatimukset toteutettiin ja testattiin projektin puitteissa. Hylättyjä vaatimuksia ei luonnollisestikaan lähdetty toteuttamaan projektin puitteissa. Pöytäkirjaotteiden vaatimusten toteuma on taulukossa 43.

Taulukko 43: Pöytäkirjaotteiden vaatimusten toteutuma.

12. Yhteenveto

Titus-projekti jatkokehitti Jyväskylän yliopiston informaatioteknologian tiedekunnassa kehitettyä vuorovaikutteista TIM-oppimisympäristöä. Titus-projekti laajensi TIM:in kohderyhmää ja kohdealuetta niin, että informaatioteknologian tiedekunnan tiedekuntaneuvosto pystyy hyödyntämään TIM:iä kokousdokumenttien laatimisessa ja julkistamisessa.

Titus-projekti toteutti TIM-järjestelmään tiedekuntaneuvoston kokousdokumenttien laatimista varten seuraavia uusia toimintoja:

• pdf-liitteiden integrointi,
• pdf-liitteiden leimaus,
• pdf-liitteiden yhdistäminen,
• kokouskutsusta pöytäkirjaksi -muunnin,
• pöytäkirjaotteiden ottamistoiminto, sekä
• asiakohtaisen läsnäolotaulukon lisäävä painike.

Näiden lisäksi Titus-projektissa kehitettiin uusi taulukkomuoto, joka on aiempaa taulukkomuotoa monipuolisempi ja ilmaisuvoimaisempi. Taulukon käsittelyä varten kehitettiin myös taulukkoeditori.

Titus-projektissa kirjattiin kehitettäville ominaisuuksille 292 vaatimusta, joista toteutettiin 153 ja testattiin 104. Projektin aikana kaikki välttämättömät vaatimukset toteutettiin sekä pyrittiin mahdollisuuksien mukaan testaamaan ja varmistamaan toimintojen toimivuus mahdollisimman tehokkaasti. Vaatimusten määrää kasvattaa merkittävästi toimintojen ideointi ja vaihtoehtoiset vaatimukset. Monet ideoiduista vaatimuksista hylättiin tai jätettiin prioriteetiltaan ideaksi ja jätettiin tilaan ei toteuteta, jolloin vaatimukset siirtyvät jatkokehittäjien harkittavaksi.