Tekijä: jkahkoPäiväys: 12.03.2002 18.16


1 Yleistä

Erikoistyön aiheena on tehdä vaatimusmäärittelyn(VM) laatimis- ja ylläpito-ohjelma. Sen avulla vaatimusmäärittely laaditaan hierarkisena rakenteena ja kuhunkin vaatimukseen liittyy varsinaisen tekstin lisäksi joukko määriteltävissä olevia muita ominaisuuksia. Vaatimusmäärittelystä voidaan tulostaa erilaisia raportteja, joissa tulostettavat asiat voidaan määritellä sekä vaatimuksen ominaisuuksien perusteella että tulostukseen mukaan otettavien vaatimusten perusteella. Vaatimusmäärittelyä voidaan laatia useamman henkilön toimesta. Tällöin lopputulos kootaan yhdeksi kokonaisuudeksi kunkin henkilön laatimista osakokonaisuuksista.

Tässä dokumentissa kuvataan ne ominaisuudet, jotka ohjelmalla halutaan olevan. Dokumentin lukijan oletetaan tuntevan sovellusalueen ja ATK-alan yleisesti käytössä olevan perustermistön.

2 Viitteet

2.1 Viittausmekanismi

Ulkoinen viittaus on muotoa /XX, a.b.c/, missä XX on viitattavan dokumentin kirjainlyhenne ja a.b.c on alakohdan numero. Dokumenteista käytetyt kirjainlyhenteet on esitetty kohdassa 2.2. Sisäinen viittaus on muotoa a.b.c, missä a.b.c on dokumentin alakohdan numero.

2.2 Viitatut dokumentit

Normatiiviset viitteet:

Muut viitteet:
/TK/Tehtävän kuvaus: Hajanaisia vaatimuksia VM:n laatimis/ylläpitotyökalulle, Jorma Sajaniemi 2.11.2001

3 Määritelmät

ASCII American Standard Code for Information Interchange, tietokoneissa käytettävä merkistö.
GIF Graphics Interchange Format, kuvatiedostomuoto.
Hierarkia Vaatimusmäärittelyn rakenne, koostuminen yksittäisistä vaatimuksista. Osien keskinäiset suhteet. 
HTML Hypertext Markup Language, internetsivujen luontiin käytetty kuvauskieli.
JPG (JPEG) Joint Photographic Experts Group,  pakkausmenetelmä ja kuvatiedostomuoto (JFIF =JPEG File Interchange Format).
Tcl/Tk Tool Command Language/ Tool Kit, komentojonokieli merkkipohjaisten ohjelmien ohjelmointiin / työkalu graafisten käyttöliittymien laadintaan. 
VM Vaatimusmäärittely, järjestelmän avulla laadittava dokumentti. Tässä myös järjestelmän avulla laadittava ja ylläpidettävä tietojoukko. 
XML Extensible Markup Language. Metakieli, jolla voidaan luoda dokumenttien rakenteen määrittämiseen käytettäviä kieliä.
XML-processor  XML-jäsennin, joka lukee XML-dokumentin ja tarjoaa sovellukselle rajapinnan dokumentin sisältöön ja rakenteeseen. 


Raportin muodostamisperusteet

Raportin esitystapa:

Otsikot ja vaatimukset

Vaatimusten valintaperusteet:

Kaikki

Valituista vaatimuksista esitettävät tiedot:

Nimi
Kuvaus


4 Toiminnallisuus

4.1 Toimintovaatimukset

4.1.1 Aseta kieli

Kuvaus: Käyttäjä voi valita järjestelmän käyttöliittymän kieleksi suomen tai englannin. Järjestelmän oletuskielenä on suomi.

4.1.2 Avaa VM

Kuvaus: Käyttäjä voi avata aiemmin luodun vaatimusmäärittelyn, jolloin järjestelmä näyttää sen hierarkisen sisällysluettelon ja siihen liitettyjen, tallennettujen vaatimusten nimet. Käyttäjä voi valita näytössä näkyvän hierarkiatasojen syvyyden avaamalla tai sulkemalla haluamansa tason sisällysluettelosta valitsemalla. Järjestelmä lukee sisällysluettelon järjestelmän ulkopuolella laaditusta hierarkiatiedostosta. Käyttäjä ei voi muokata hierarkista rakennetta järjestelmässä.

4.1.3 Lisää vaatimus

Kuvaus: Käyttäjä voi lisätä uuden vaatimuksen sisällysluettelosta valitsemaansa kohtaan. Järjestelmä avaa uuden ikkunan, jossa käyttäjä voi kirjoittaa vaatimukseen liittyvän tekstin sekä määrittää muut vaatimukseen liittyvät tiedot. Käyttäjä voi halutessaan kumota tekemänsä lisäykset ja sulkea ikkunan tallentamatta vaatimusta. Käyttäjä voi tallentaa tekemänsä lisäykset napsauttamalla 'tallenna' -painiketta. Tallentamisen jälkeen vaatimus voidaan poistaa vain erillisen toiminnon (ks. 4.1.5) kautta. Näytössä voi olla yhtäaikaa auki useiden eri vaatimusten ikkunoita. Vain yksi vaatimusikkuna voi olla kerrallaan aktiivinen, jolloin käyttäjä voi muokata sen sisältöä. Käyttäjä voi valita aktiivisen ikkunan, jolloin järjestelmä tuo sen näyttölle päällimmäiseksi. Järjestelmä näyttää sisällysluettelossa korostettuna sen vaatimuksen nimen, joka on aktiivinen. Tarvittaessa järjestelmä hakee pitkästä sisällysluettelosta näkyville sen kohdan, jossa korostetun vaatimuksen nimi sijaitsee.

4.1.4 Muokkaa vaatimus

Kuvaus: Käyttäjä voi valita sisällysluettelosta aiemmin tallennetun vaatimuksen muokattavaksi. Järjestelmä avaa uuden tai nostaa esiin jo olemassa olevan ikkunan, jossa näytetään vaatimuksesta tallennetut tiedot. Käyttäjä voi tehdä tässä ikkunassa vaatimukseen haluamansa muutokset. Käyttäjä voi halutessaan kumota tekemänsä muutokset ja sulkea ikkunan tallentamatta vaatimusta. Käyttäjä voi tallentaa tekemänsä muutokset napsauttamalla 'tallenna' -painiketta.

4.1.5 Muokkaa tekstiä editorissa

Kuvaus: Käyttäjä voi muokata vaatimuksen 'Kuvaus' -tekstikentän sisältöä editorilla. Järjestelmä avaa vaatimuksen tekstikentän sisällön määritelyssä oletuseditorissa, jolloin käyttäjä voi tuottaa esim. editorin tukemana HTML-tekstiä ja lisätä tekstiin kuvamäärityksiä. Kun käyttäjä sulkee editorin, siirtää järjestelmä editorissa laaditun tekstin vaatimusikkunan 'Kuvaus' -tekstikenttään.

4.1.6 Näytä luokituksen perusteet

Kuvaus: Järjestelmä näyttää selitystekstin vaatimuksen tietoihin sisältyvän luokituksen perusteista.

4.1.7 Poista vaatimus

Kuvaus: Käyttäjä voi poistaa VM:stä näytössä aktiivisena olevan vaatimuksen. Järjestelmä päivittää sisällysluettelon ja poistaa vaatimuksen näytöltä. Poiston jälkeen sitä ei voi enää palauttaa. Seuraavan tiedostoon tallennuksen yhteydessä poisto päivittyy myös tallennettuun vaatimustiedostoon.

4.1.8 Muuta sijaintia hierarkiassa

Kuvaus: Käyttäjä voi muuttaa sisällysluettelosta valitsemansa vaatimuksen sijaintia hierarkiassa. Järjestelmä tallentaa vaatimuksen uuden sijainnin ja päivittää sisällysluettelon näytössä.

4.1.9 Muuta järjestystä hierarkiassa

Kuvaus: Käyttäjä voi muuttaa hierarkiassa samaan kohtaan liittyvien vaatimusten keskinäistä järjestystä. Järjestelmä tallentaa vaatimusten uuden järjestyksen ja päivittää sisällysluettelon näytössä.

4.1.10 Tallenna VM

Kuvaus: Järjestelmä tallentaa VM:n tiedot.

4.1.11 Luo raportti

Kuvaus: Käyttäjä voi luoda laaditusta vaatimusmäärittelystä raportteja, joissa esitettävät asiat käyttäjä voi määritellä.

Järjestelmä avaa valintaikkunan, josta käyttäjä voi valita ne kriteerit, joiden mukaiset vaatimukset otetaan mukaan raporttiin. Käyttäjä voi myös valita, mitä yksittäisiä vaatimuksen ominaisuuksia raportissa esitetään. Kun käyttäjä on tehnyt määritykset, luo järjestelmä raportin annettujen kriteerien mukaisesti, tallentaa sen käyttäjän määrittämällä nimellä ja avaa sen oletusselaimeen. Käyttäjä voi katsella raporttia selaimessa sekä halutessaan hän voi tulostaa sen käyttäen selaimen tulostustoimintoa. Järjestelmä luo raportin siten, että alkuun sijoitetaan järjestelmän ulkopuolella laaditun aloitustiedoston tiedot sekä käyttäjän valitsemat raportin muodostamisperusteet. Näiden tietojen jälkeen sijoitetaan varsinaisen raportin tiedot. Aloitustiedostossa voidaan esittää VM:n yleisiä tietoja, esimerkiksi projektitietoja, johon VM liittyy sekä projektiin osallistuvien yhteystietoja.

4.1.12 Avaa raportti

Kuvaus: Käyttäjä voi avata aiemmin luodun ja tallennetun raportin. Järjestelmä avaa käyttäjän määrittelemän raportin oletusselaimeen. Käyttäjä voi katsella raporttia selaimessa sekä halutessaan hän voi tulostaa sen käyttäen selaimen tulostustoimintoa.

4.1.13 Näytä aloitusteksti

Kuvaus: Järjestelmä näyttää oletusselaimen uudessa ikkunassa raportin alkuun sijoitettavan aloitustiedoston sisällön.

4.1.14 Avaa ohje

Kuvaus: Järjestelmä avaa html-ohjeen oletusselaimen uuteen ikkunaan.

4.1.15 Sulje VM

Kuvaus: Järjestelmä sulkee ohjelmassa avoinna olevan VM:n. Ennen sulkemista järjestelmä tarkistaa, onko ohjelmassa tallentamattomia tietoja ja ilmoittaa niistä käyttäjälle, jolloin käyttäjä voi ne joko tallentaa, palata vaatimusmäärittelyyn tai hylätä tehdyt muutokset.

4.1.16 Lopeta ohjelma

Kuvaus: Järjestelmä sulkee ohjelman pääikkunan ja lopettaa ohjelman suorituksen. Ennen sulkemista järjestelmä tarkistaa, onko ohjelmassa tallentamattomia tietoja ja ilmoittaa niistä käyttäjälle, jolloin käyttäjä voi ne joko tallentaa, palata ohjelmaan tai hylätä tehdyt muutokset.

4.2 Yhteensopivuus

4.3 Sovellusalueen standardien noudattaminen

4.4 Turvallisuus

4.5 Toimintaympäristö

5 Luotettavuus

5.1 Kypsyys

Kuvaus: Järjestelmän on oltava vakaa.

5.2 Vikasietoisuus

Kuvaus: Ei vaatimuksia.

5.3 Toipumiskyky

Kuvaus: Ei vaatimuksia.

6 Käytettävyys

6.1 Ymmärrettävyys

Kuvaus: Käyttöliittymä toteutetaan suomen ja englannin kielellä. Ohjeet ja muut dokumentit laaditaan ainoastaan suomenkielellä. Käytetyn terminologian tulee olla normaalia eli se noudattaa ko. dokumenteissa yleisesti käytettyä terminologiaa.

6.2 Opittavuus

Kuvaus: Ei vaatimuksia.

6.3 Operoitavuus

Kuvaus: Ei vaatimuksia.

7 Tehokkuus

7.1 Ajankäyttö

Kuvaus: Ei vaatimuksia.

7.2 Muiden resurssien käyttö

Kuvaus: Ei vaatimuksia.

8 Ylläpidettävyys

8.1 Analysoitavuus

Kuvaus: Proseduurit on kommetoitava erikoistyöohjeen mukaisesti.

8.2 Muunneltavuus

Kuvaus: Ei vaatimuksia.

8.3 Stabiilisuus

Kuvaus: Ei vaatimuksia.

8.4 Testattavuus

Kuvaus: Ei vaatimuksia.

9 Siirrettävyys

9.1 Liitettävyys

Kuvaus: Toiminnalle muissa kuin kohdassa 4.5.2 kuvatuissa käyttöjärjestelmäympäristöissä ei aseteta vaatimuksia.

9.2 Asennettavuus

Kuvaus: Järjestelmän dokumentteihin sisältyy erillinen asennusohje, jonka mukaan ohjelmien asennukseen perehtyneen henkilön tulee pystyä asentamaan järjestelmä työasemaan kymmenessä minuutissa.

9.3 Siirrettävyyteen liittyvien standardien noudattaminen

Kuvaus: Tiedostojen on oltava XML-muotoisia siten, että XML-prosessori pystyy ne lukemaan.

9.4 Korvaavuus

Kuvaus: Ei vaatimuksia.