Skip to content
Snippets Groups Projects
Code owners
Assign users and groups as approvers for specific file changes. Learn more.
vaatimusmaarittely.md 39.04 KiB

Vaatimusmäärittely runko

Täydennä seuraavat kentät!

  • [SIJOITA TOIMEKSIANNON KOODI TÄHÄN]
  • Nimimerkkisi/gitlab tunnus
  • Dokumentin versionumero X.Y
  • Vaatimusmäärittely pohjan versio 2.1 - 17.09.2020 (NarsuMan)

Ohjeita määrittelytyön tekijälle

Pidä sisällysluettelo kunnossa, eli päivitä tarvittaessa MarkDown-ankkurilinkitys.

Dokumentin sisällä viitataan useissa kohdissa kansioon "/pohjat". Kyseinen kansio sisältää ns. "templaatti"-tiedostoja joita käytetään apuna eri määrittelyjen kirjaamisessa. Tämä tarkoittaa, että tuosta kansiosta voi tarvittasessa kopioida tiedostoja.

PlantUML-työkalun avulla on mahdollista piirtää esim. UML-kuvauskielen mukaisia kuvauksia ja liittää ne osaksi MarkDown-kuvauksia. Kurssin aikana on hyödyllistä tutustua sen käyttöön http://plantuml.com/ ja pyrkiä soveltamaan sitä mahdollisimman paljon eri osa-alueilla.

HUOMIO! Älä käytä PlantUML-kuvauksissa skandinaavisia merkkejä, koska tämä johtaa ongelmiin CI/CD-prosessin aikana

Tutustu seuraavan linkin takaa löytyvään MindMap-kuvaan, siitä miten eri käsitteet liittyvät toisiinsa. Kannattaa keskittyä ymmärtämään yhteyksien merkitys, eli kysyminen kannattaa aina :) Kuvaus voi päivittyä kurssin aikana!

http://ttos0100.pages.labranet.jamk.fi/amk-2020/kurssimateriaali/kasitekartta/

HUOMIO! Kun teet harjoitusta, niin poista ennen lopullista luovutusta kaikki ohjekommentit ja video-linkit sisällöstä.

Tiedostojen nimeämisestä: Kannattaa pyrkiä nimeämään kaikki tiedostot säännönmukaisesti esim. use-case-001.md, profiili_asiakas-2, ominaisuus-ft1.md__ etc Itse MarkDown -tiedostossa ylä otsikko kannattaa täyttää myös samalla menetelmällä.
Use Case: Uuden käyttäjän kirjautuminen Profiili: Asiakas 2 Ominaisuus: Raportti generaattori Tämä helpottaa hahmottamaan myöhemmin koko vaatimusmäärittelyn rakennetta

Sisällysluettelo

  1. Johdanto
  2. Toimeksiantaja
  3. Vaatimusmäärittelyn tekijä
  4. Palvelukuvaus
  5. Sidosryhmäkartta
  6. Sidosryhmät ja profiilit
  7. Tunnistetut riskit
  8. Valitut asiakastarinat
  9. Palveluun liittyviä asiakaspolkuja
  10. Oleelliset käyttötapaukset
  11. Tärkeimmät yleiset ominaisuudet/toiminnallisuudet
  12. MockUp-prototyyppi
  13. Alustavat Käyttäjätarinat
  14. Palvelun järjestelmävaatimukset
  15. Palveluun vaikuttavat rajaukset
  16. Palvelun liityvät laitevaatimukset
  17. Palvelun suoritusympäristöön liittyvät vaatimukset
  18. Palvelun määritellyt ominaisuudet/toiminnnallisuudet
  19. Palvelun toiminnalliset vaatimukset
  20. Palvelun ei-toiminnalliset vaatimukset
  21. Palvelun alustava arkkitehtuuri
  22. Palvelun alustava sijoittelunäkymä
  23. Palvelun alustava tietokantakuvaus)
  24. Palvelun integraatiot muihin järjestelmiin
  25. Palvelun laadun varmistuksesta
  26. Palvelun hyväksyntätestit
  27. Julkaisusuunnitelma
  28. Aiheeseen liityvä standardit ja lähteet

Johdanto

Kuvaa millaisesta projektista on kyse, hieman taustaa ja aiheeseen olennaisesti liittyviä asioita? Jos kyseessä harjoitustehtävä, niin tarkista voitko käytää todellisten tilaajien oikeita nimiä! Muuta aina oletuksena henkilötiedot ja toimeksiantajan viralliset tiedot

Toimeksiantaja

Kuka on vaatimusmäärittelyn tilaaja? Muista vaihtaa oikeat tilaajan nimet ja tiedot omiin keksittyihin!

Vaatimusmäärittelyn tekijästä

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