Vaatimusmaarittely - Haxxori/kaatopaikka GitHub Wiki

Dokumentista

Tämä dokumentti on "elävä"-dokumentti, joka päivittyy jatkuvasti. Se on karkea vaatimusmäärittelydokumentin runko, jota voi käyttää projektien vaatimusmäärittelyn pohjana. Rakennetta saa ja pitää muokata! Tavoitteena on luoda dokumentti, joka yhdistää palvelumuotoilun ja ohjelmistosuunnittelun saumattomasti yhteen. Tekijä ei ota mitään vastuuta dokumentin sisällöstä.

tv:NarsuMan

XXXXXX-palvelun/ohjelmiston vaatimusmäärittely

Dokumentin versionumero X.Y

Materiaalin luokittelu

Salattu/Julkinen

Oikeudet

Kuka omistaa dokumentin?

Sisältö

Sisällysluettelo ?

Johdatus

  • Mikä on tämän dokumentin tehtävä?
  • Mihin se liittyy ?
  • Tärkeätä tietää
  • Oleellista lukijalle ?

Lyhyt tuote/palvelukuvaus/asiakastarina

  • Mitä määritetyltä palvelulta odotetaan? lyhyesti
  • Asiakastarina

Tilaaja

  • Kuka on tilaaja, yhteistiedot ?
  • Jos tiedot on projektisuunnitelmassa, niin linkit tänne!

Toimittaja

  • Kuka on toimittaja, yhteistiedot ?
  • Jos tiedot on projektisuunnitelmassa, niin linkit tänne!

Aikataulu

  • Mitä alustavasti tullaan tekemään ja milloin ?
  • Kannattaa viedä osaksi projektisuunnitelmaa ?
Etappi Alkaa Loppuu
Profiiliasiakastapaamiset 1.2.2017 12.2.2017 P3
Sidosryhmä tapaaminen 13.2.2017 P4
Esi-katselmointi 25.2.2017 P1
Vaatimusmäärittely luovutetaan 28.2.2017 12.2.2017 P1

Palvelun/ohjelmiston tunnistetut sidosryhmät ja asiakkaat (Stakeholders and customers)

Sidosryhmät (Stakeholders)

Sidosryhmät (esimerkkejä)

  • Linkki sidosryhmän omaan sivuun
  • Mungo consulting Oy, Palvelun tarjoaja
  • RahoittajaA, yrityksen osakas, Bankoman Oy, osakkeen omistaja 55 %
  • RahoittajaB, Yrityksen osakas, Mauri Bosse, omistaa 5 %
  • TuotantotiimiA, em. yrityksen työntekijät, Kalle, Kille, Pelle ja Pöppö
  • SuurAsiakasA, NordMan Oy, yritysasiakas
  • SuurAsiakasB, Bill Cates Ikkunatehdas, yritysasiakas
  • Bad Man, kiusantekijä
  • Snake Consulting Oy, kilpailija

Tunnistetut asiakasprofiilit

Asiakasprofiilit (Customer Profiles)

Esimerkkejä! korvatkaa

  • Asiakas 1, Mauno Mainio, 67, eläkeläinen, Vierumäki, kotosin Pohjois-Savosta (Matematiikan opettaja)
  • Asiakas 2, Riku Rikas, 30, IT Yrittäjä, asuinpaikka tuntematon, kotoisin nomands land
  • Asiakas 3, Siiri Koikkalainen 99, suurmummo, Hankasalmi, (Sokea)
  • Asiakas 4, John Rambu, 55, tuntematon, Helsinki, (Bad Man)

Voi olla toisaalta järkevää luoda oma sivu jokaiselle asiakasprofiileille..

Sidosryhmäkartta (Stakeholder map)

Yleinen palvelun asiakaspolku (General Customer Journey)

Käydään läpi asiakaspolku, jossa käytetään nimettyjä sidosryhmien edustajia

Palvelun osa-aluejako (Service Domain areas)

Millaisiin osa-alueiseiin voidaan ohjelmisto/palvelu voidaan jakaa.

Onko olemassa erilaisia tuoteversioita eri ympäristöihin, mitä?

  • Työpöytäversio ?
  • Mobiiliversio ?
  • Kenttäversio

ohjelmiston osa-alueita/lohkoja?

  • Hallintapaneeli ?
  • Tietokanta-palvelut ?
  • Käyttöliittymät ?
  • Autentikointi ?
  • Laskutus ?

Tärkeimmät asiakaspolut (Customer Journey Maps) valituiden asiakasprofiilien näkökulmasta

  • Tarkennetaan kuvausta tehtävän mukaisesti ?

Asiakaspolku käytöönotto [asiakasprofiili_1] näkökulmasta

  • lorem ipsum
  • Blue Print-kuva ?

Asiakaspolku tuotteen takuukorjaus [asiakasprofiili_2] näkökulmasta

  • lorem ipsum
  • Blue Print-kuva ?

Asiakaspolku tuotten uudelleenasennus [asiakasprofiili_3] näkökulmasta

  • lorem ipsum
  • Blue Print-kuva ?

Tärkeimmät piirteet/ominaisuudet (Features)

Ominaisuus 1

  • Kuvaus
  • Ominaisuuteen liittyvät vaatimukset ?
  • UI-Näkymä ?
  • Testauksessa huomioitavaa

Ominaisuus 2

  • Kuvaus
  • Ominaisuuteen liittyvät vaatimukset ?
  • UI-Näkymä ?
  • Testauksessa huomioitavaa

Ominaisuus 3

  • Kuvaus
  • Ominaisuuteen liittyvät vaatimukset ?
  • UI-Näkymä ?
  • Prototyyppi näkymä?
  • Testauksessa huomioitavaa

Ominaisuus 4

  • Kuvaus
  • Ominaisuuteen liittyvät vaatimukset ?
  • UI-Näkymä ?
  • Prototyyppi näkymä?
  • Testauksessa huomioitavaa

Käyttötapaukset

Tärkeimmät käyttötapaukset kuvana

Käyttötapaus 1

Käyttötapaus 2

Käyttötapaus 3

Käyttötapaus 4

Riskit (Risks)

  • Tunnistetaan ohjelmistoon/palveluun liittyviä riskejä..
  • Riskienhallinta
Vaatimus ID Kuvaus Tyyppi Osa-alue Vastuullinen Prioriteetti
RISK001 Käyttäjämäärän äkillinen lisääntyminen, esim poikkeustilanteen aikana - P1
RISK002 Palvelun käytettävyys heikkenee kovan kuormituksen aikana Toiminnnallinen P5
RISK003 Heikon verkkoyhteyden vaikutus palvelun käyttöön Toiminnnallinen - P3
  • Miten taulukoita luetaan: P1 = Erittäin tärkeä, P3 = Oleellinen, P5 = Triviaali

Yleiset vaatimukset (Functional Requirements)

  • Tässä osiossa voidaan nostaa esiin huomioitavia tärkeitä vaatimuksia, jotka on hyvä pitää mielessä!
Vaatimus ID Kuvaus Tyyppi Osa-alue Vastuullinen Prioriteetti
YVA0001 Palvelun täytyy toimia Android versiosssa 4.x alkaen Tekninen "ASAP"-tuotantotiimi P1
YVA0002 Palvelun täytyy toimia Windows Phonessa totetutus "ASAP"-tuotantotiimi P2
YVA0003 Palvelun täytyy toimia Windows 95:ssa, koska johtajalla on moinen koneessaan! totetuts "ASAP"-tuotantotiimi P5

Tunnistetut toiminnnalliset vaatimukset (Functional Requirements)

Vaatimus ID Kuvaus Tyyppi Osa-alue Vastuullinen Prioriteetti
VAT0001 Toiminnnallinen "ASAP"-tuotantotiimi P1
VAT0002 Käyttäjä voi tarvittaessa vaihtaa salasanansa Toiminnnallinen "ASAP"-tuotantotiimi P5
VAT0003 Salasanan vaihdon jälkeen ei käyttäjän tarvitse kirjautua uudestaan Toiminnnallinen "ASAP"-tuotantotiimi P3
  • Miten taulukoita luetaan: P1 = Erittäin tärkeä, P3 = Oleellinen, P5 = Triviaali

Tunnistetut laadulliset /ei-toiminnalliset vaatimukset (Non-Functional Requirements)

Vaatimus ID Kuvaus Tyyppi Osa-alue Vastuullinen Prioriteetti
VAL0201 Palvelun pitää skaalatua hetkellisesti 1000 käyttäjälle Skaalautuvuus "ASAP"-tuotantotiimi P1
VAL0202 Palvelun saatavuus on oltava 99.1 % Stabiilisuus "ASAP"-tuotantotiimi P5
VAL0203 Käyttäjän tiedot on salattavat Tietoturva "ASAP"-tuotantotiimi P3
  • Miten taulukoita luetaan: P1 = Erittäin tärkeä, P3 = Oleellinen, P5 = Triviaali

Käytettävyys

  • Mitä on otettava huomioon ?
  • Asiakkaan toiveet ?
  • Teknologiset osa-alueet/asiat, jotka vaikuttavat käytettävyyteen?

Käyttöliittymä prototyyppi

Prototyypin esittely

  • Linkit prototyyppi ympäristöön
  • Tarvittavat tiedot prototyypin tarkasteluun

Palvelun/ohjelmiston arkkitehtuuri

  • Tämä osio voidaan sisällyttää osaksi teknistä suunnittelua.
  • Vaatimusmäärittelyssä voi kuitenkin olla hyvä tarvittaessa kuvata yleistä totetutusta ja siihen liittyviä ongelmakohtia

Luokkaehdokkaat (Class proposal)

  • Yleensä osa tarkempaa suunnittelua

  • Voidaan viitata linkeillä...

  • Tunnistetut luokkaehdokkaat

Luokkamalli (Class Diagram)

  • Ainoastaan karkea kuvaus tarpeen ?

Toiminta kuvaus (Sequence Diagram)

  • Sekvenssikuvalla on aika kätevä esittää muutakin

Sijoittelunäkymä (Deployment diagram

  • Vaatimusmäärittelyssä tämä saattaa olla yksi hyödyllisimpiä UML-kuvauksia ?
  • Miten ohjelmisto/palvelu tulee karkeasti toimimaan osana vanhaa totetutusta..
  • Miten olemassa oleva järjestelmä tulee karkeasti toimimaan

Riskiperustainen esi-testaussuunnitelma

Tunnistetut riskit ja testikohtee

  • Riski -> Testaustarve
  • Vaatimus -> Testaustarve

Julkaisusuunnitelma ja priorisointi

Julkaisujärjestys ei aina ole lineaarinen. Ks. Kriittinen polku Joskus se saattaa tuntua siltä: Release Plan

Toiminnallisuudet ja toteuttamisjärjestys

  • Ominaisuus 1 - Maaliskuu 2019
  • Ominaisuus 3 - Huhtikuu 2019
  • Ominaisuus 5 - Toukokuu 2019
  • Ominaisuus 2 - Syyskuu 2019

Priorisointi

  • Miten taulukoita luetaan: P1 = Erittäin tärkeä, P3 = Oleellinen, P5 = Triviaali

Standardit ja lähteet

  • ISTQB
  • IPMA
  • etc..

Lähteet

Lähteitä