Säilytä vaatimusten jäljitettävyys muutoksissa
Yhdistä käyttäjän tavoite päätöksiin, hyväksymiskriteereihin, toteutukseen ja näyttöön. Päivitä yhteydet oletusten muuttuessa.
Julkaisija TaigaNäin kirjoitamme
Mitä opit
- Kirjoitat havaittavan vaatimuksen ja sen rajat.
- Jäljität vaatimuksen muutokseen ja tarkistuksiin.
- Tunnistat muuttuneen oletuksen vaikutukset dokumentteihin.
Kuvaa todennettava toiminta
”Tee moderni asiakasvienti” jättää olennaiset päätökset auki. Käyttäjät, tietueet, kentät ja virhetilanteet puuttuvat. Agentin pitää kysyä tai olettaa. Kirjaamattomia oletuksia on vaikea tarkastaa myöhemmin.
Käytä rajattua kuvitteellista vaatimusta: kirjautunut manager saa viedä oman organisaationsa aktiiviset asiakkaat. Vienti sisältää customer ID:n ja näyttönimen. Yhteystiedot ja arkistoidut tietueet jäävät pois. Käyttäjä ilman manager-roolia ei saa vientiä.
Vielä tarvitaan päätökset formaatista, määrästä, vasteajasta ja virhetoiminnasta. Merkitse tuntemattomat asiat. Hyödyllinen määrittely näyttää epävarmuuden eikä peitä sitä varman kuuloiseen tekstiin.
Erota vaatimus toteutustavasta
Käyttäjä tarvitsee sallitut tietueet käyttökelpoisessa muodossa. Tietokantakysely, kirjasto ja endpointin rakenne ovat toteutusvalintoja. Yhdistä ne vaatimukseen tekemättä jokaisesta nykyvalinnasta pysyvää liiketoimintatarvetta.
Kirjaa merkittävä päätös, sen konteksti, vaihtoehdot ja peruste. Synkroninen vienti voi sopia pienelle määrälle. Suuri määrä voi vaatia taustatyön ja erillisen latausoikeuden tarkistuksen.
Säilytä vaatimus mahdollisuuksien mukaan ja versioi muuttuva päätös. Näin tarkastaja erottaa uuden toteutustavan käyttäjälle annetun lupauksen muutoksesta.
Tee lyhyt näyttöketju
Käytä reviewssa ymmärrettäviä tunnisteita. Esimerkissä EXPORT-01 yksilöi organisaatiorajan. Nimi havainnollistaa menetelmää eikä ole pakollinen numerointitapa.
| Yhteys | Esimerkki |
|---|---|
| Vaatimus | EXPORT-01: vain managerin oman organisaation tietueet |
| Suunnittelupäätös | Jäsenyys valvotaan palvelimella, ei selaimessa |
| Toteutus | PR muuttaa kyselyä ja authorization-polkua |
| Tarkistus | Toisen organisaation tietoihin kohdistuva pyyntö estyy |
| Julkaisun näyttö | Testitulos yksilöi hyväksytyn commitin ja artefaktin |
Ketjun pitää osoittaa todelliseen näyttöön. Vaatimustunniste testin nimessä ei osoita assertionin tarkistavan vaatimusta. Tarkasta testi ja sen käyttämä tuotantopolku.
NISTin SSDF käsittelee vaatimuksia ja tarkistuksia turvallisessa kehityksessä. Tee jäljitettävyyden avulla työ tarkastettavaksi sen sijaan, että dokumentaatio olisi oma päämääränsä. Lue viitekehys.
Arvioi muuttuneen oletuksen vaikutus
Liiketoiminta tarvitsee nyt myös arkistoidut asiakkaat. Muutos koskee muutakin kuin kyselyn flagia. Tarkista säilytyssäännöt, authorization, tietomäärä, käyttäjälle annettu kuvaus ja nykyisten raporttien merkitys.
Merkitse vaikutuksen kohteena olevat dokumentit ja testit tarkistettaviksi. Säilytä aiempi päätös, jotta ylläpitäjä voi selittää vanhan julkaisun toiminnan. Älä kirjoita historiaa huomaamatta uudelleen.
Agentti voi etsiä viittauksia ja ehdottaa päivityksiä. Vastuuhenkilöt ratkaisevat ristiriidat ja hyväksyvät muuttuneen toiminnan. Hakutuloksena saatu tiedostolista on lähtökohta, ei täydellinen vaikutusarvio.
Pidä kirjaus käyttökelpoisena
Kirjaa toteutukseen, tarkistuksiin ja ylläpitoon vaikuttavat päätökset. Älä toista samaa vaatimusta monissa irrallisissa dokumenteissa. Linkitä yhteen ylläpidettyyn lähteeseen.
Pystyykö tarkastaja seuraamaan muutoksen tarkoituksesta todelliseen näyttöön? Löytääkö palvelun omistaja olennaisen rajan ja palautumispäätöksen? Nämä kysymykset testaavat jäljitettävyyden käytännön hyötyä.
Sovella käytäntöön
Kirjoita vaatimus managerin aktiivisten asiakkaiden viennille. Nimeä sallitut käyttäjät, organisaatioraja, kentät, virhetoiminta ja mitattava valmistumisehto. Yhdistä vaatimus kuvitteelliseen testiin ja julkaisuun. Lisää sitten arkistoidut asiakkaat ja listaa muuttuvat päätökset.
Lataa työpohja (Markdown)Testaa, mitä opit
Lähteet ja lisälukeminen
- NIST: Secure Software Development Framework ↗
- Google Engineering Practices: What to look for in a code review ↗
Aiheesta Taigan sivuilla
Valinnan poistaminen poistaa kaikki tälle selaimelle tallennetut suoritusmerkinnät.
Edistyminen tallentuu tähän selaimeen. Ei käyttäjätiliä eikä seurantaa.