diff --git a/documentation/20-Requirement-management/templates/pohja-vaatimukset-listana.md b/documentation/20-Requirement-management/templates/template-requirementlist.md similarity index 72% rename from documentation/20-Requirement-management/templates/pohja-vaatimukset-listana.md rename to documentation/20-Requirement-management/templates/template-requirementlist.md index 7585ef4bc2e062d004a6e597542202086d8dbb0b..4ddf0e443144bade3197510a07dae7cc6fd2f606 100644 --- a/documentation/20-Requirement-management/templates/pohja-vaatimukset-listana.md +++ b/documentation/20-Requirement-management/templates/template-requirementlist.md @@ -1,41 +1,40 @@ -# Vaatimukset listana +# Requirements as a list template [](http://www.youtube.com/watch?v=rp3DkiZ-Mkk "") +This model is quite useful if the list of requirements isn't very long. The same list can be done quite conveniently with Excel, but it will soon lead to the complexity of documentation. +When one environment is used to gather relevant information, it is easier to link them to each other and the information stays up to date better. -Tämä malli on varsin käyttökelpoinen, jos lista ei veny kovin pitkäksi. Sama lista voidaan aika kätevästi tehdä Excelillä, mutta se johtaa varsin pian dokumentoinnin monimutkaisuuteen. -Kun käytetään yhtä ympäristöä keräämään oleellinen tieto on niiden linkittäminen helpompaa ja tieto pysyy ajantasalla paremmin. +# Business / Customers / Constraints -# Liiketoiminta/Asiakkaat/Rajoitteet +** Customer Requirements ** -**Asiakasvaatimukset** - -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| -| CUSTOMER-REQ-0001 | Customer Requirement | Käyttäjänä haluan kirjautua käyttäen Facebook-tunnuksia, ettei tarvise häslätä | [Kirjautuminen ft1](ft1-ominaisuus.md) | +| CUSTOMER-REQ-0001 | Customer Requirement | As a user I want to login using my Facebook credentials to avoid any hassle. | [Login ft1](ft1-ominaisuus.md) | | CUSTOMER-REQ-0002 | Customer Requirement ||| | CUSTOMER-REQ-0003 | Customer Requirement ||| | CUSTOMER-REQ-0004 | Customer Requirement ||| | CUSTOMER-REQ-0005 | Customer Requirement ||| -**Liiketoiminnan vaatimukset** +**Business requirements** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| -| BUSINESS-REQ-0001 | Business Requirement | Palvelun kirjautuminen tulee olla helppoa, että voimme saavuttaa laajan käyttäjäkunnan = 35% kohderyhmästä | [Kirjautuminen ft1](ft1-ominaisuus.md) | +| BUSINESS-REQ-0001 | Business Requirement | Logging in to the service should be easy so that we can reach a wide user base = 35% of the target group | [Login ft1](ft1-ominaisuus.md) | | BUSINESS-REQ-0002 | Business Requirement ||| | BUSINESS-REQ-0003 | Business Requirement ||| | BUSINESS-REQ-0004 | Business Requirement ||| | BUSINESS-REQ-0005 | Business Requirement ||| -**Rajoitukset / Standardit** +**Constraints and standards** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| -| CONSTRAINT-REQ-S00000 | Constrain | Palvelun kirjautumisprosessin on noudatettava AC5-2009-käytäntöä | [Kirjautuminen ft1](ft1-ominaisuus.md) | +| CONSTRAINT-REQ-S00000 | Constrain | Login process must follow the AC5-2009 standard. | [Login ft1](ft1-ominaisuus.md) | | CONSTRAINT-REQ-S00001 | Constrain ||| | CONSTRAINT-REQ-S00002 | Constrain ||| | CONSTRAINT-REQ-S00003 | Constrain ||| @@ -64,7 +63,7 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: * Ajoalustan ratkaisut JAVA VM, Docker Container ? -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | SYSTEM-REQ-0001 | System Requirement | Kirjatumispalvelulla on oltava itsenäinen kolmannen osapuolen toimittama varmistusjärjestelmä | [Kirjautuminen ft1](ft1-ominaisuus.md) | | SYSTEM-REQ-0002 | System Requirement | Palvelun tärkeimpien palvelujen on oltava vähintään kahdennettu N+1 | | @@ -74,9 +73,9 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: -### Toiminnalliset vaatimukset** +### Functional requirements** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | FUNCTIONAL-REQ-C0001 | Functional Requirement | Käyttäjänä (Asiakas Profiilit 1-4) voin kirjautua käyttäen Facebook-tunnuksia | [Kirjautuminen ft1](ft1-ominaisuus.md) | | FUNCTIONAL-REQ-C0002 | Functional Requirement ||| @@ -90,12 +89,12 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: | FUNCTIONAL-REQ-C0010 | Functional Requirement ||| -### Ei-Toiminnalliset vaatimukset +### Non-functional requirements -**Tietoturva** +**Security** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | SECURITY-REQ-0001 | Non-Functional Security | Salasanassa on käytettävä vähintään MD5-tason salausta, koska standardi XY112 sitä edellyttää | [Kirjautuminen ft1](ft1-ominaisuus.md) | | SECURITY-REQ-0002 | Non-Functional Security ||| @@ -109,9 +108,9 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: | SECURITY-REQ-0010 | Non-Functional Security ||| -**Suorituskyky** +**Performance** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | PERFORMANCE-REQ-0000 | Non-Functional Performance | Kirjautuminen on mahdollista yhtäaikaa 100 käyttäjällä (100 request/s) | [Kirjautuminen ft1](ft1-ominaisuus.md) | | PERFORMANCE-REQ-0001 | Non-Functional Performance ||| @@ -121,9 +120,9 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: | PERFORMANCE-REQ-0005 | Non-Functional Performance ||| -**Käytettävyys** +**Usability** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | 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](ft1-ominaisuus.md) | | | USABILITY-REQ-0001 | Non-Functional Usability ||| @@ -134,17 +133,17 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: -**Palautuminen** +**Recovery** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | RECOVERY-REQ-00100 | Non-Functional Recovery | Kirjautumis-palvelun on käynnistyttävä ensimmäisen palvelun ylösajon aikana | [Kirjautuminen ft1](ft1-ominaisuus.md) | | RECOVERY-REQ-00100 | Non-Functional Recovery ||| -**Testattavuus** +**Testability** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | TESTABILITY-REQ-0000 | Non-Functional Testability | Käyttäjärekisteri on kyettävä palauttamaan alkutilaan ennen testien ajoa | [Kirjautuminen ft1](ft1-ominaisuus.md) | | TESTABILITY-REQ-0001 | Non-Functional Testability ||| @@ -154,9 +153,9 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: | TESTABILITY-REQ-0005 | Non-Functional Testability ||| -**Turvallisuus** +**Safety** -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | SAFETY-REQ-0000 | Non-Functional Safety | Tähän tuotteesen ei voida osoittaa turvallisuus vaatimuksia | [Kirjautuminen ft1](ft1-ominaisuus.md) | | SAFETY-REQ-0001 | Non-Functional Safety ||| @@ -164,9 +163,9 @@ järjestelmävaatimuksiin. Teknisiä vaatimuksia voivat olla esim: | SAFETY-REQ-0003 | Non-Functional Safety ||| -# Mekaaniikka vaatimukset +# Mechanical requirements -| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa | +| Requirement ID | Type | Description | Related feature | |:-:|:-:|:-:|:-:| | MECHANICAL-REQ-000 | Mechanical Requirement | || | MECHANICAL-REQ-001 | Mechanical Requirement | ||