Ohranite sledljivost zahtev ob spremembah programske opreme
DokončanoRezultat za uporabnika povežite z odločitvami, merili sprejemljivosti, izvedbo in dokazili. Ob spremembi predpostavk posodobite povezave.
Izdajatelj TaigaKako pišemo
Preverite razumevanjeSpecifikacija se spremeni po pripravi arhitekture in testov. Kaj se mora zgoditi?Opravite vajo
Kaj se boste naučili
- Napišite zahtevo s preverljivim delovanjem in izrecnimi mejami.
- Sledite zahtevi skozi spremembo in njena preverjanja.
- Prepoznajte odvisne dokumente, na katere vpliva spremenjena predpostavka.
Opišite delovanje, ki ga lahko nekdo preveri
»Ustvarite sodoben izvoz podatkov strank« pušča pomembne odločitve odprte. Ne določa uporabnikov, zapisov, polj ali delovanja ob napaki. Agent mora vprašati ali predpostavljati. Nezabeležene predpostavke je pozneje težko pregledati.
Uporabite izmišljeno zahtevo z jasno mejo: vodja s preverjeno istovetnostjo lahko izvozi podatke aktivnih strank svoje organizacije. Izvoz vsebuje ID stranke in prikazno ime. Izključuje kontaktne podatke in arhivirane zapise. Uporabnik brez vloge vodje ne prejme izvoza.
Še vedno so potrebne odločitve o obliki, količini, odzivnem času in ravnanju ob napakah. Neznanke izrecno označite. Uporabna specifikacija razkrije negotovost, namesto da jo skrije v samozavestno besedilo.
Ločite zahteve od odločitev o izvedbi
Uporabnik potrebuje dovoljen nabor zapisov v uporabni obliki. Poizvedba v podatkovni zbirki, knjižnica in struktura končne točke so odločitve o izvedbi. Povežite jih z zahtevo, ne da bi vsako trenutno izbiro obravnavali kot trajno poslovno potrebo.
Pomembno odločitev zabeležite skupaj s kontekstom, alternativami in razlogom. Sinhroni izvoz je lahko na primer primeren za majhne količine. Večja količina lahko zahteva opravilo v ozadju in ločeno preverjanje avtorizacije prenosa.
Kjer je mogoče, zahtevo ohranite nespremenjeno, spremenjeno odločitev pa beležite z različico. To pomaga pregledovalcem ločiti drugačno izvedbo od drugačne obljube uporabnikom.
Ustvarite kratko verigo dokazil
Uporabite identifikatorje, ki med pregledi ostanejo razumljivi. V tem primeru lahko EXPORT-01 označuje mejo organizacije. Ime je ponazoritev in ne predpisan sistem številčenja.
| Povezava | Primer |
|---|---|
| Zahteva | EXPORT-01: samo zapisi vodjeve organizacije |
| Odločitev o zasnovi | Članstvo preverjajte na strežniku, ne v brskalniku |
| Izvedba | PR spremeni poizvedbo in pot avtorizacije |
| Preverjanje | Zahteva za zapise druge organizacije je zavrnjena |
| Dokazila izdaje | Rezultat preverjanja določa sprejeti commit in artefakt |
Veriga mora kazati na dejanska dokazila. Ime testa, ki vsebuje ID zahteve, ne dokazuje, da jo njegova preverba preverja. Preglejte test in produkcijsko pot, ki jo preizkuša.
NIST SSDF daje kontekst za zahteve in preverjanje znotraj varnega razvoja. Sledljivost uporabite za preglednost teh dejavnosti in ne za ustvarjanje dokumentacije same zase. Preberite okvir.
Preglejte vpliv spremenjene predpostavke
Recimo, da poslovanje zdaj potrebuje podatke arhiviranih strank. Ta sprememba vpliva na več kot zastavico poizvedbe. Preverite pravila hrambe, avtorizacijo, pričakovano količino, pojasnila uporabnikom in pomen obstoječih poročil.
Prizadete dokumente in preverjanja označite za pregled. Ohranite prejšnjo odločitev, da lahko operativna ekipa pojasni starejšo izdajo. Zgodovine ne prepišite neopazno tako, da bi bila najnovejša zasnova videti neizogibna.
Agent lahko pomaga najti sklice in predlagati posodobitve. Odgovorne osebe morajo razrešiti nasprotujoče si zahteve in sprejeti spremenjeno delovanje. Seznam ujemajočih se datotek je izhodišče in ne popolna ocena vpliva.
Zapis naj ostane dovolj majhen za uporabo
Zabeležite odločitve, ki vplivajo na izvedbo, preverjanje in delovanje. Iste zahteve ne ponavljajte v številnih nepovezanih dokumentih. Prednost dajte povezavam do enega vzdrževanega vira.
Pred sprejetjem spremembe vprašajte, ali lahko pregledovalec sledi njenemu namenu do dejanskih dokazil. Pred začetkom delovanja vprašajte, ali lahko odgovorni za storitev najde ustrezno mejo in odločitev o obnovi. To sta praktična preizkusa uporabne sledljivosti.
Opravite vajo
Napišite zahtevo, ki vodji omogoča izvoz podatkov aktivnih strank. Vključite dovoljene uporabnike, mejo organizacije, polja, delovanje ob napaki in merljiv pogoj dokončanja. Povežite jo z izmišljenim testom in izdajo. Nato zahtevo spremenite tako, da vključuje arhivirane stranke, in navedite prizadete odločitve.
Prenesi delovni list (Markdown)Če počistite to izbiro, izbrišete ves napredek, shranjen v tem brskalniku.
Napredek ostane v tem brskalniku. Brez računa in sledenja.
Viri in nadaljnje branje
- NIST: Secure Software Development Framework ↗
- Google Engineering Practices: What to look for in a code review ↗