Õpitee 04Õppetund 2 / 10

Hoia nõuded tarkvara muutudes jälgitavana

Seo kasutaja soovitud tulemus otsuste, vastuvõtukriteeriumide, teostuse ja tõenditega. Uuenda seoseid, kui eeldused muutuvad.

Praktik10 minÜle vaadatud

Avaldaja Kuidas me kirjutame

Mida õpid

  • Kirjuta vaadeldav nõue koos selgete piiridega.
  • Jälgi nõuet läbi muudatuse ja selle kontrollide.
  • Tuvasta muudetud eeldusest mõjutatud järgnevad dokumendid.

Kirjelda käitumist, mida saab kontrollida

„Loo nüüdisaegne klientide eksport“ jätab olulised otsused lahtiseks. See ei määra kasutajaid, kirjeid, välju ega veakäitumist. Agent peab kas küsima või eeldusi tegema. Kirja panemata eeldusi on hiljem raske üle vaadata.

Kasuta selge piiriga väljamõeldud nõuet: autenditud haldur saab eksportida oma organisatsiooni aktiivseid kliente. Eksport sisaldab kliendi ID-d ja kuvatavat nime. Kontaktandmed ja arhiveeritud kirjed jäävad välja. Haldurirollita kasutaja eksporti ei saa.

Endiselt on vaja otsustada vorming, maht, vastamisaeg ja tõrgete käsitlemine. Märgi teadmata asjaolud selgelt. Kasulik spetsifikatsioon toob ebakindluse nähtavale, mitte ei peida seda enesekindlasse teksti.

Erista nõuded teostusvalikutest

Kasutaja vajab lubatud kirjete kogumit kasutatavas vormingus. Andmebaasipäring, teek ja lõpp-punkti ülesehitus on teostusvalikud. Seo need nõudega, käsitlemata iga praegust valikut püsiva ärivajadusena.

Pane oluliste tagajärgedega otsus kirja koos tausta, alternatiivide ja põhjusega. Näiteks sünkroonne eksport võib sobida väikeste mahtude jaoks. Suurem maht võib nõuda taustatööd ja eraldi allalaadimise autoriseerimiskontrolli.

Hoia nõue võimaluse korral stabiilne, andes muudetud otsusele uue versiooni. See aitab ülevaatajatel eristada teistsugust teostust teistsugusest lubadusest kasutajatele.

Loo lühike tõendiahel

Kasuta identifikaatoreid, mis jäävad ülevaatustes arusaadavaks. Selles näites võib EXPORT-01 tähistada organisatsioonipiiri. Nimi on näitlik, mitte nõutav nummerdussüsteem.

SeosNäide
NõueEXPORT-01: ainult halduri organisatsiooni kirjed
KavandamisotsusKontrolli liikmesust serveris, mitte brauseris
TeostusPR muudab andmepäringut ja autoriseerimise teed
KontrollTeise organisatsiooni kirjete päring lükatakse tagasi
Väljalaske tõendKontrolli tulemus tuvastab heaks kiidetud commit’i ja artefakti

Ahel peab viitama päris tõenditele. Nõude ID testi nimes ei tõenda, et testi kontrolltingimus seda kontrollib. Uuri testi ja tootmiskoodi teed, mida see katsetab.

NIST-i SSDF annab nõuetele ja kontrollimisele turvalise arenduse tausta. Kasuta jälgitavust nende tegevuste uuritavaks muutmiseks, mitte dokumentatsiooni tootmiseks selle enda pärast. Loe raamistikku.

Vaata üle muudetud eelduse mõju

Oletame, et ettevõte vajab nüüd arhiveeritud kliente. See muudatus mõjutab enamat kui üht päringulippu. Kontrolli säilitusreegleid, autoriseerimist, oodatavat mahtu, kasutajale antavaid selgitusi ja olemasolevate aruannete tähendust.

Märgi mõjutatud dokumendid ja kontrollid ülevaatamiseks. Säilita eelmine otsus, et käitaja saaks vanemat väljalaset selgitada. Ära kirjuta ajalugu märkamatult ümber, et viimane lahendus näiks vältimatu.

Agent saab aidata viiteid leida ja uuendusi pakkuda. Vastutajad peavad lahendama vastuolulised nõuded ning muudetud käitumise heaks kiitma. Sobivate failide loend on lähtekoht, mitte täielik mõjuhinnang.

Hoia kirjeldus kasutamiseks piisavalt väike

Pane kirja otsused, mis mõjutavad teostust, kontrollimist ja käitust. Väldi sama nõude kordamist paljudes omavahel sidumata dokumentides. Eelista linke ühele hooldatud allikale.

Enne muudatuse vastuvõtmist küsi, kas ülevaataja saab liikuda selle eesmärgist tegelike tõenditeni. Enne käitust küsi, kas teenuse vastutaja leiab asjakohase piiri ja taastamisotsuse. Need on kasuliku jälgitavuse praktilised kontrollid.

Tee harjutus

Kirjuta nõue, mille järgi haldur saab aktiivseid kliente eksportida. Lisa lubatud kasutajad, organisatsioonipiir, väljad, veakäitumine ja mõõdetav lõpetamistingimus. Seo see väljamõeldud testi ja väljalaskega. Seejärel muuda nõuet, et kaasata arhiveeritud kliendid, ning loetle mõjutatud otsused.

Laadi tööleht alla (Markdown)

Kontrolli oma arusaamist

Spetsifikatsioon muutub pärast arhitektuuri ja testide ettevalmistamist. Mis peaks juhtuma?

Allikad ja lisalugemine

Seotud lugemine Taigalt