Ohjelmiston/palvelun vaatimusmäärittely

Vaatimusmäärittely pohjan versio 1.1 - 24.4.2019

TTOS0800 Kurssi [TOIMEKSIANTO KOODI TÄHÄN]

Sisällysluettelo

Pidä sisällysluettelo kunnossa, eli päivitä sitä tarpeen mukaan! Huomaa MarkDown-ankkurilinkitys

Johdatus

Kerro millaisesta projektista on kyse, hieman taustaa ja aiheeseen olennaisesti liittyviä asioita? Älä käytä harjoitustehtävässä tilaajien oikeita nimiä vaan muuta henkilötiedot ja toimeksiantajan viralliset tiedot

Vaatimusmäärittelytyön toimeksiantaja/tilaaja

Kuka on vaatimusmäärittelyn tilaaja?

Vaatimusmäärittelyn toimittaja

Kerro lyhyesti itsestäsi (tarvittaessa pseudonyyminä) tai esim. kuvitteellisen yrityksen työntekijänä

Palvelukuvaus

Mitä palvelun avulla voidaan tehdä? Mikä sen tehtävä on sidosryhmän kannalta? Kannattaa keskittyä loppukäyttäjiin tai oleellisiin palvelusta hyötyviin sidosryhmiin

Yleinen sidosryhmäkuva (Stakeholder -Map)

Mietitään ensin millaisia käyttäjiä/sidosryhmiä liittyy suunniteltuun palvelukokonaisuuteen? Näitä selkeyttääksemme kerätään kaikki sidosryhmät yhteen sidosryhmä-kuvaan ja tarkastellaan samalla mikä on ko. ryhmän/edustajan palveluun liittyvä motivaatio

Mieti mitä oleellista yllä olevasta kuvasta puuttuu? Yritä tulkita kuvaa nykymuodossaan?

Valitut sidosryhmät ja profiilit (Profiles/Stakeholders)

Valitaan aiemmin määritellystä sidosryhmäkuvauksesta tarkempaan tarkasteluun tärkeäksi koetut sidosryhmät/profiilit. Jokainen valittu sidosryhmä kuvataa itsenäisenä profiilikuvauksena ja tallennetaan omaksi tiedostokseen

Jokainen profiili kuvaus tallennetaan itsenäisenä tiedostona, koska tämä helpottaa tulevaisuudessa niihin viittaamista dokumentaatiossa esim. Loppukäyttäjä - Keijo Korhonen

Muista kirjata kuvauksiin erityisesti sidosryhmän motivaatio! Eli miksi sidosryhmä syy käyttää/soveltaa palvelua

Valitut asiakastarinat

Valitaan tarvittava määrä eri sidosryhmiä/profiileja ja kirjoitetaan auki valitulle profiilille/sidosryhmälle "asiakastarina". Tavoitteena on kuvata sitä, miten valittu profiili/sidosryhmä käytännössä hyödyntää palvelua. Tavoite ei ole kehua sitä vaan käydä läpi syitä palvelun käyttöön ja miten se auttaa ko. sidosryhmää/profiilia.

Muista kirjoittaa tarina auki pelkästään valitun sidosryhmän näkökulmasta (toiset sidosryhmät saattavat esiintyä tarinassa)

Palvelun tärkeimmät asiakaspolut (Customer Journey/Path)

Tarkennetaan tarinaa ja nostetaan oleelliset profiilit tarkasteluun palvelupolun näkökulmasta. Tämän "polun" tarkoituksena on kuvata sitä tapahtumien sarjaa joka käydään läpi palvelua käytettäessä. Palvelupolkuja voi olla useita, mutta tärkeintä on kuvata oleellisimmat aluksi. Palvelu polku kuvauksessa voidaan hyödyntää Swimlane/BluePrint/tilakone-kuvausta tai muuta sopivaksi katsottua visualisointi tapaa. Tärkeää on kuvata polku ja käydä sen avulla eri vaiheet läpi

Asiakaspolkukua on hyvä lähteä luonnostelemaan esim. asiakastarinan pohjalta. Polkuja kannattaa määritellä tarvittaessa useampia eri tilanteiden näkökulmasta. Yhteen kuvaukseen ei kannata upottaa liikaa tapahtumia

Palvelupolkujen kuvaukseen voidaan hyödyntää myös erillisiä työkaluja. Mieti onko mahdollista hyödynnetään jotain ulkopuolista palvelua kuvauksen apuna?

Työkalu esimerkkejä

Tärkeimmät käyttötapaukset (General Use Cases)

Käyttötapaukset (Use Case) on hyvä erottaa käyttötarkoituksesta (Use Case)! Yleensä palvelusta ensi kertaa keskusteltaessa puhutaan sen eri käyttötarkoituksista, eli sitä mihin ohjelmistoa/palvelua voidaan hyödyntää. Kun puhutaan palvelun määrittelystä käyttötapauksien kannalta on kyseessä eri asia. Käyttötapauksessa keskitytään tarkastelmaan palvelun käyttöä varsin rajatussa tilanteessa. On oleellista kirjata alkuvaiheessa tärkeimmät käyttötapaukset yhteen kuvaukseen. Tähän hyödynnetään UML- Use Case-diagrammia.

Millaisia ovat tärkeimmät käyttötapaukset (Use Caset) tuotteeseen/palveluun liittyen? Muista, ettei käyttötapauksella ei tarkoiteta käyttökohdetta/soveltamiskohdetta

On hyvä kerätä tärkeimmät käyttötapaukset yhteen Use Case-kuvaukseen, josta on helpompi tarkastella järjestelmää. Laajemmassa järjestelmässä saattaa olla useita satoja käyttötilanteita.

uml diagram

Alustavat Käyttäjätarinat - User Story

NYT HUOMIO! Tähän kohtaan kannattaa keskittyä vasta kun kaikki muut osiot on käyty läpi! Kyseessä ei ole käyttäjätarina vaan ketterään kehittämiseen liittyvä Käyttötarina - User Story. Sen avulla kuvataan palveluun liittyvää toiminnallisuutta, joka halutaa siinä olevan.

Esimerkki User Story issuesta #1

Ohjelmiston/palvelun tekniset vaatimukset

Ohjelmistoja ja palveluita suunniteltaessa usein tulevat esiin vaatimukset, jotka liittyvät eri teknologioihin, laitteistoon ja fyysiseen rakenteeseen. Näiden rinnalla pohditaan mitä toiminnallisuuksia ratkaisun tulee pitää sisällään. Tästä johtuen kannattaa alkuvaiheessa pyrkiä tunnistamaan puhtaasti tekniset vaatimukset ja kirjata ne vaatimusmäärittelyyn. Liiallinen keskittyminen alussa teknisten vaatimusten kirjaamiseen ei välttämättä ole kannattavaa, koska suunnittelun aikana ohjelmistoa/palvelun tekniset vaatimukset tarkentuvat ja tarpeet saattavat muuttua. Kehityskäytössä näppärä ratkaisu voi osoittatua kalliiksi, kun se tuotteistetaan.

Teknisiä järjestelmävaatimuksia

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
SYSTEM-HW-REQ-0002 System Technical Requirement Palvelun tärkeimpien palvelujen on oltava vähintään kahdennettu N+1
SYSTEM-HW-REQ-0003 System Technical Requirement Palvelimen muistikapasiteeti >16GB
SYSTEM-HW-REQ-0004 System Technical Requirement Prosessori Intel/AMD x64
SYSTEM-HW-REQ-0005 System Technical Requirement Palvelimen fyysinen sijainti on oltava kotimaassa (Suomi)
SYSTEM-HW-REQ-0005 System Technical Requirement Verkkoyhteyden nopeus >100MB/s
SYSTEM-HW-REQ-0005 System Technical Requirement Laitekaapin suositeltava koko 1m X 1m X 2m

Arkkitehtuuriin/teknologiaan liityvät vaatimukset

Nämä voidaan kirjata myös tekniset vaatimukset

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
ARCH-REQ-0002 Technical Requirement Palvelun tärkeimpien palvelujen on oltava vähintään kahdennettu N+1
ARCH-REQ-0003 Technical Requirement Palvelimen muistikapasiteeti >16GB
ARCH-REQ-0004 Technical Requirement Prosessori Intel/AMD x64
ARCH-REQ-0005 Technical Requirement Palvelimen fyysinen sijainti on oltava kotimaassa (Suomi)
ARCH-REQ-0005 Technical Requirement Verkkoyhteyden nopeus >100MB/s
ARCH-REQ-0005 Technical Requirement Laitekaapin suositeltava koko 1m X 1m X 2m

Rajoitteet (Key Requirements and restrictions)

Eri ohjelmistojena/palvelujen toteutusta ja käyttöä ohjaavat usein lait ja säädökset. Näiden edellyttämät vaatimukset kirjataan yleensä rajoitteina ja niiden vaikutus koskee usein koko ohjelmiston/järjestelmän toteuttamista. Tästä syystä ne kannattaa tunnistaa ja selvittää ajoissa, koska vaikutus saataa olla varsin ratkaiseva pitemmällä tähtäimella. Esimerkkinä EU GDPR-säädös.

Id Vaatimuksen kuvaus kategoria Vastuullinen
CONSTRAINT-REQ-S00000 Constrain Palvelun kirjautumisprosessin on noudatettava AC5-2009-käytäntöä Kirjautuminen ft1
CONSTRAINT-REQ-S00001 Constrain
CONSTRAINT-REQ-S00002 Constrain
CONSTRAINT-REQ-S00003 Constrain
CONSTRAINT-REQ-S00004 Constrain
CONSTRAINT-REQ-S00005 Constrain
CONSTRAINT-REQ-S00006 Constrain

Toiminnalliset vaatimukset (Functional Requirements)

Mitä ovat toiminnalliset vaatimukset? Toiminnallisilla vaatimuksilla kuvataan ohjelmistolta/järjestelmältä vaadittua toimintaa Toiminnalliset vaatimukset ovat helpoimmin tunnistettavia. Vältä useamman vaatimuksen kirjaamista samaan lauseeseen! Jokainen vaatimus erikseen.. Voit esittää ne taulukossa tai viitata yhteen laajempaan kokonaisuuteen

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
FUNCTIONAL-REQ-C0001 Functional Requirement Käyttäjänä (Asiakas Profiilit 1-4) voin kirjautua käyttäen Facebook-tunnuksia Kirjautuminen ft1
FUNCTIONAL-REQ-C0002 Functional Requirement
FUNCTIONAL-REQ-C0003 Functional Requirement
FUNCTIONAL-REQ-C0004 Functional Requirement
FUNCTIONAL-REQ-C0005 Functional Requirement
FUNCTIONAL-REQ-C0006 Functional Requirement
FUNCTIONAL-REQ-C0007 Functional Requirement
FUNCTIONAL-REQ-C0008 Functional Requirement
FUNCTIONAL-REQ-C0009 Functional Requirement
FUNCTIONAL-REQ-C0010 Functional Requirement

Palveluun liittyvät tärkeimmät ei-toiminnalliset vaatimukset (Non Functional Requirements)

Mitä olivat ei-toiminnalliset vaatimukset? Voit esittää eri vaatimuksia erillisessä taulukossa tai viitata tässä yhteen laajempaan taulukkoon. Ei-toiminnalliset vaatimukset sisältää laajan joukko eri näkökulmia ohjelmiostotuotteeseen liittyen. Tärkeimmät kirjoittajan näkökulmasta ovat seuraavat: Suorituskyky, käytettävyys, tietoturva ja ylläpidettävyys

Suorituskyky? (Performance)

Voit esittää eri vaatimuksia erillisessä taulukossa tai viitata tässä yhteen laajempaan taulukkoon.. Miten hyvin palvelu/komponentti tai muu osa-alue palvelusta suoriutuu kuormituksen aikana? Mitkä ovat pullonkaulat. Mihin vaatimuksiin palvelun tulee kyetä vastaamaan?

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
PERFORMANCE-REQ-0000 Non-Functional Performance Kirjautuminen on mahdollista yhtäaikaa 100 käyttäjällä (100 request/s) Kirjautuminen ft1
PERFORMANCE-REQ-0001 Non-Functional Performance
PERFORMANCE-REQ-0002 Non-Functional Performance
PERFORMANCE-REQ-0003 Non-Functional Performance
PERFORMANCE-REQ-0004 Non-Functional Performance
PERFORMANCE-REQ-0005 Non-Functional Performance

Tietoturva?

Voit esittää eri vaatimuksia erillisessä taulukossa tai viitata tässä yhteen laajempaan taulukkoon..

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
SECURITY-REQ-0001 Non-Functional Security Salasanassa on käytettävä vähintään MD5-tason salausta, koska standardi XY112 sitä edellyttää Kirjautuminen ft1
SECURITY-REQ-0002 Non-Functional Security
SECURITY-REQ-0003 Non-Functional Security
SECURITY-REQ-0004 Non-Functional Security
SECURITY-REQ-0005 Non-Functional Security
SECURITY-REQ-0006 Non-Functional Security
SECURITY-REQ-0007 Non-Functional Security
SECURITY-REQ-0008 Non-Functional Security
SECURITY-REQ-0009 Non-Functional Security
SECURITY-REQ-0010 Non-Functional Security

Käytettävyys

Voit esittää eri vaatimuksia erillisessä taulukossa tai viitata tässä yhteen laajempaan taulukkoon.. Käytettävyys

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
USABILITY-REQ-0000 Non-Functional Usability Käyttöliittymän on toimittava myös ääniohjattuna, koska käyttäjillä saattaa olla näkövammoja Kirjautuminen ft1
USABILITY-REQ-0001 Non-Functional Usability
USABILITY-REQ-0002 Non-Functional Usability
USABILITY-REQ-0003 Non-Functional Usability
USABILITY-REQ-0004 Non-Functional Usability
USABILITY-REQ-0005 Non-Functional Usability

Testattavuus/Ylläpidettävyys

Voit esittää eri vaatimuksia erillisessä taulukossa tai viitata tässä yhteen laajempaan taulukkoon.. Lisätietoa

VaatimusID Tyyppi Kuvaus Ominaisuus johon vaikuttaa
TESTABILITY-REQ-0000 Non-Functional Testability Käyttäjärekisteri on kyettävä palauttamaan alkutilaan ennen testien ajoa Kirjautuminen ft1
TESTABILITY-REQ-0001 Non-Functional Testability
TESTABILITY-REQ-0002 Non-Functional Testability
TESTABILITY-REQ-0003 Non-Functional Testability
TESTABILITY-REQ-0004 Non-Functional Testability
TESTABILITY-REQ-0005 Non-Functional Testability

Tähän kirjataan vaatimuksia, joiden merkitys tulee esiin vasta tuotteen julkaisun jälkeen. Miten tuotteen ylläpidettävyyttä parannetaan? Mitä pitää ottaa huomioon, että ylläpidettävyys on helpompaa

Id Vaatimuksen kuvaus kategoria Vastuullinen
MAINT-REQ00x Vaatimus? Ylläpito Kuka vastaa
MAINT-REQ00x Vaatimus? Tekninen Kuka vastaa
MAINT-REQ00x Vaatimus? Käytettävyys Kuka vastaa
MAINT-REQ00x Vaatimus? Käytettävyys Kuka vastaa
MAINT-REQ00x Vaatimus? Käytettävyys Kuka vastaa

Tärkeimmät tunnistetut ominaisuudet/piirteet (Features)

Kannataa pohtia määrittely vaiheessa ovatko kaikki ominaisuudet tarpeellisia? Osa toiminnallisista vaatimuksista on oletuksena ominaisuuksia. Kannattaa pyrkiä ryhmittelemään tärkeimmät ominaisuudet ensin. Ominaisuuksia voidaa tarkentaa toiminnallisilla vaatimuksilla, jotka ns. laajentavat ominaisuuden kuvausta. Ominaisuudet ovat käytännössä isompia kokonaisuuksia, joista koko palvelu/ohjelmisto on muodostunut. Suomenkielen sana ominaisuus saattaa olla hieman harhaan johtava, koska usein tuotteita esiteltäessä pyritään korostamaan tuotteen ominaisuutena sen "tietoturvallisutta". Tämä ei tarkoita, että kyseessä on tuoteeen ohjelmiston yksi ominaisuus vaan yleinen "suunnittelu filosofia". Tuote voi sisältää ominaisuuksia, joiden myötä sitä voidaan kutsua voidaan tietoturvalliseksi.

Ominaisuus Prioriteetti Muuta
Ominaisuus 1 - Feature 1 Tärkeä
Ominaisuus 2 Tärkeä
Ominaisuus 3 Pakollinen
Ominaisuus 4 Nice to Have
Ominaisuus 5

Palvelu MockUp-prototyyppi

Suunnittellun palvelun/ohjelmiston yleinen näkymä kannataa esitellä MockUp-muodossa. Tarkemmin määritellyissä ominaisuuskuvauksissa voi esitellä tarkemmin jotain toimintoa. MockUp-kuvaus on hyödyllinen apuväline palvelun tilaajan/toimeksiantajan kanssa käydyissä keskusteluissa.

Kokonaispalvelun MockUp-kuva?

Hyväksyntätestit

Kiinnitetään alustavat hyväksyntätestit vaatimuksiin taulukon muodossa.

Hyväksyntätesteissä keskitytään yleisesti asiakkaan/loppukäyttäjän näkökulmaan. Tavoitteena on kelpuuttaa, eli validoida , onko tuote asiakkaan toiveiden mukainen ja täyttääkö se asetetut vaatimukset. Hyväksyntätesteillä voidaan selvittää onko tuote myös riittävän suorituskykyinen, käytettävä tai tietoturvallinen asiakkaiden käyttötarkoitukseen.

VaatimusID Testitapaus Kuvaus
USE-CASE-007,SYSTEM-REQ-0001,SYSTEM-REQ-0004, SYSTEM-REQ-0012 Test Case Id X Hyväksyntätesti
USE-CASE-017,SYSTEM-REQ-0011,SYSTEM-REQ-0004, SYSTEM-REQ-0012 Test Case Id Y Hyväksyntätesti
USE-CASE-011,USE-CASE-013,SYSTEM-REQ-0204, SYSTEM-REQ-0212 Test Case Id Z Hyväksyntätesti
USE-CASE-002,SYSTEM-REQ-0301,SYSTEM-REQ-0304, SYSTEM-REQ-0312 Test Case Id O Hyväksyntätesti

Alustava julkaisusuunnitelma

Julkaisusuunnitelman visualisoidulla muodolla on helpompi esittää ominaisuuksien julkaisut kehityksen aikanan. Alla oleva kuva on luotu käyttäen PlantUML-työkalua. Sen avulla on luoto ns. Gantt-kaavio ominaisuuksien julkaisuajankohdista.

Huomio Alla oleva julkaisusuunnitelman kuva ei näy oikein vaatimusmäärittelydokumentin verkkojulkaisu-sivulla

Oletamme, että tuotteessa on muutamia ominaisuuksia, joiden järjestys on mietitty ennakkoon..

uml diagram

Julkaistavat tuotekokonaisuudet (Konfiguraatio)

Tuotteen/ohjelmiston eri ominaisuuksista kehitetään usein eri versioita ja tämä johtaa usein erilaisiin tuotekokonaisuuksiin. Puhutaan ns. tuotekonfiguraatiosta, jonka avulla pyritään kiinnittämään eri ohjelmiston ominaisuusversiot yhteen version.

Seuraavassa taulukossa on esitelty eri versioissa julkaistavat ominaisuudet taulukon muodossa.

Julkaisu "EarlyAdopter - Versio 1.0"

Ominaisuus Versio Testattavissa Julkaistaan
Feature 1 1.0 x.y.201z x+2,y+3.201z
Feature 2 1.0 x.y.201z x+2,y+3.201z
Feature 3 1.1 x.y.201z x+2,y+3.201z
Feature 4 1.1 x.y.201z x+2,y+3.201z
Feature 5 2.3 x.y.201z x+2,y+3.201z
Feature 6 0.9 x.y.201z x+2,y+3.201z
Feature 7 1.1 x.y.201z x+2,y+3.201z

Seuraavassa julkaisussa on mukana muutamia parannettuja ominaisuuksia, jotka ovat kehittyneet eteenpäin. Näistä on valittu sopiva kokonaisuus asiakas julkaisuun.

Julkaisu "Enhanced - Versio 1.1"

Ominaisuus Versio Testattavissa Julkaistaan
Feature 1 1.1 x.y.201z x+2,y+3.201z
Feature 2 1.1 x.y.201z x+2,y+3.201z
Feature 3 1.2 x.y.201z x+2,y+3.201z
Feature 4 1.4 x.y.201z x+2,y+3.201z
Feature 5 2.6 x.y.201z x+2,y+3.201z
Feature 6 1.2 x.y.201z x+2,y+3.201z
Feature 7 1.1 x.y.201z x+2,y+3.201z

Palvelun/ohjelmiston arkkitehtuuri

Millainen on tekninen toteutus ja miten eri teknologioita tullaan hyödyntämään.

Yleinen sijoittelunäkymä (Deployment diagram )

Sijoittelunäkyvän avulla voi kuvata miten eri palvelu osat toimivat sen ollessa toiminnassa.

Tietokantakuvaus (Database ER-diagram)

Tähän esim alustava ER-kaavio

Testauksen vaatimukset (Testing requirements)

Testattavuus

Millaisia asioita on otettava huomioon tuotteen laadunvarmistamisen kannalta?. Kehityksen aikana ohjelmistotuotteeseen on luotava tarvittavat rajapinnat tai työkalu-ohjelmistoja, joiden avulla voidaan hallita testikohteena olevaa tuoteversiota. Nämä vaatimukset on kirjattava ajoissa, koska ne vaikuttavat ratkaisevasti tuotteen testausmahdollisuuksiin. Esimerkkinä voidaan miettiä logien hallintaa, niiden keräämistä, alkutilanteeseen saattamista.

Id Vaatimuksen kuvaus kategoria Vastuullinen
REQ00x Vaatimus? Testattavuus Kuka vastaa
REQ00x Vaatimus? Testattavuus Kuka vastaa
REQ00x Vaatimus? Testattavuus Kuka vastaa
REQ00x Vaatimus? Testattavuus Kuka vastaa
REQ00x Vaatimus? Testattavuus Kuka vastaa

Tunnistetut riskit ja testikohteet

Millaisia riskeja liittyy tuoteen kehittämiseen, tuotteen markkinoihin, mahdollisiin kilpailijoihin, resursseihin? Nämä on hyvä tunnistaa alkuvaiheessa

Työkalu esimerkki

Vaatimukset yhtenä listana

Tähän osaan voidaan linkittää vaatimuslista, josta kaikki tunnistetut vaatimukset löytyvät

Dokumentit, standardit ja lähteet

Lähteet/Standardit/Suositukset

ID Linkki
JHS 165 ICT http://www.jhs-suositukset.fi/c/document_library/get_file?uuid=b8118ad7-8ee4-459a-a12b-f56655e4ab9d&groupId=14 Vaatimusmäärittely
SO 9241-11 https://fi.wikipedia.org/wiki/K%C3%A4ytett%C3%A4vyys Käytettävyys
ISO9001 https://www.sfs.fi/julkaisut_ja_palvelut/tuotteet_valokeilassa/iso_9000_laadunhallinta/iso_9001_2015 -
- - -