Ohjelmiston/palvelun vaatimusmäärittely
Vaatimusmäärittely pohjan versio 1.1 - 24.4.2019
TTOS0800 Kurssi [TOIMEKSIANTO KOODI TÄHÄN]
- Nimimerkki/gitlab tunnus
- Vuosi
- Versionumero X.Y
Sisällysluettelo
Pidä sisällysluettelo kunnossa, eli päivitä sitä tarpeen mukaan! Huomaa MarkDown-ankkurilinkitys
- Johdatus
- Tilaaja
- Toimittaja
- Palvelukuvaus
- Yleinen sidosryhmäkuvaus
- Asiakastarina
- Sidosryhmät ja profiilikuvaukset
- Sidosryhmäkuva
- Palvelu/asiakaspolku
- Alustavat User Story -kuvaukset
- Yleinen käyttötapaus
- Yleiset toiminnalliset vaatimukset
- Yleiset ei-toiminnalliset vaatimukset
- Palvelu MockUp
- Tärkeimmät ominaisuudet
- Julkaisun suunnitelma
- Palvelun/ohjelmiston arkkitehtuuri
- Testaus ja laadunvarmistus
- Lähteet
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)
- Profiili 1: Profiili 1 haluaa tuottaa iloa....
- Profiili 2: Profiili 2 aloitaa aamulla palvelun käytön ...
- Sidosryhmä 1: Sidosryhmä 1:en kannalta palvelun...
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.
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 |