Saglabājiet prasību izsekojamību, mainoties programmatūrai
PabeigtsSaistiet lietotāja rezultātu ar lēmumiem, pieņemšanas kritērijiem, īstenojumu un pierādījumiem. Atjauniniet saiknes, kad mainās pieņēmumi.
Publicē TaigaKā mēs rakstām
Pārbaudiet savu izpratniSpecifikācija mainās pēc arhitektūras un testu sagatavošanas. Kas jādara?Izpildiet uzdevumu
Ko apgūsiet
- Uzrakstiet novērojamu prasību ar skaidrām robežām.
- Izsekojiet prasību caur izmaiņu un tās pārbaudēm.
- Atrodiet turpmākos dokumentus, kurus ietekmē mainīts pieņēmums.
Aprakstiet darbību, ko var pārbaudīt
„Izveidot modernu klientu eksportu“ atstāj būtiskus lēmumus atvērtus. Tas nenosaka lietotājus, ierakstus, laukus vai darbību kļūmes gadījumā. Aģentam vai nu jājautā, vai jāizdara pieņēmumi. Nereģistrētus pieņēmumus vēlāk ir grūti pārskatīt.
Izmantojiet izdomātu prasību ar skaidru robežu: autentificēts vadītājs var eksportēt aktīvos klientus no savas organizācijas. Eksports satur klienta ID un parādāmo vārdu. Tas neietver kontaktinformāciju un arhivētos ierakstus. Lietotājs bez vadītāja lomas eksportu nesaņem.
Vēl vajag lēmumus par formātu, apjomu, atbildes laiku un kļūmju apstrādi. Skaidri atzīmējiet nezināmo. Noderīga specifikācija atklāj nenoteiktību, nevis paslēpj to pārliecinošā tekstā.
Atdaliet prasības no īstenošanas izvēlēm
Lietotājam vajag atļautu ierakstu kopu lietojamā formātā. Datubāzes vaicājums, bibliotēka un galapunkta struktūra ir īstenošanas izvēles. Saistiet tās ar prasību, neuzskatot katru pašreizējo izvēli par pastāvīgu biznesa vajadzību.
Reģistrējiet būtisku lēmumu kopā ar kontekstu, alternatīvām un pamatojumu. Piemēram, sinhrons eksports var derēt nelielam apjomam. Lielāks apjoms var prasīt fona uzdevumu un atsevišķu lejupielādes autorizācijas pārbaudi.
Kur iespējams, saglabājiet prasību nemainīgu, vienlaikus versējot mainīto lēmumu. Tas palīdz pārskatītājiem atšķirt citu īstenojumu no cita solījuma lietotājiem.
Izveidojiet īsu pierādījumu ķēdi
Izmantojiet identifikatorus, kas paliek saprotami pārskatīšanā. Šajā piemērā EXPORT-01 var identificēt organizācijas robežu. Nosaukums ir ilustratīvs, nevis obligāta numerācijas sistēma.
| Saikne | Piemērs |
|---|---|
| Prasība | EXPORT-01: tikai vadītāja organizācijas ieraksti |
| Projektēšanas lēmums | Pārbaudīt piederību serverī, nevis pārlūkā |
| Īstenojums | PR maina vaicājumu un autorizācijas ceļu |
| Pārbaude | Citas organizācijas ierakstu pieprasījums tiek atteikts |
| Laidiena pierādījumi | Pārbaudes rezultāts identificē pieņemto commit un artefaktu |
Ķēdei jānorāda uz īstiem pierādījumiem. Testa nosaukums ar prasības ID nepierāda, ka testa nosacījums to pārbauda. Pārbaudiet testu un produkcijas koda ceļu, ko tas izpilda.
NIST SSDF sniedz kontekstu prasībām un pārbaudēm drošā izstrādē. Izmantojiet izsekojamību, lai šīs darbības varētu pārbaudīt, nevis radītu dokumentāciju pašas dokumentācijas dēļ. Lasiet ietvaru.
Pārskatiet mainīta pieņēmuma ietekmi
Pieņemsim, ka biznesam tagad vajag arī arhivētos klientus. Šī izmaiņa ietekmē vairāk nekā vaicājuma karodziņu. Pārbaudiet glabāšanas noteikumus, autorizāciju, gaidāmo apjomu, lietotāju skaidrojumus un esošo pārskatu nozīmi.
Atzīmējiet ietekmētos dokumentus un pārbaudes pārskatīšanai. Saglabājiet iepriekšējo lēmumu, lai ekspluatācijas speciālists varētu izskaidrot vecāku laidienu. Klusējot nepārrakstiet vēsturi, lai jaunākais risinājums izskatītos neizbēgams.
Aģents var palīdzēt atrast atsauces un piedāvāt atjauninājumus. Atbildīgajiem jāatrisina pretrunīgās prasības un jāpieņem mainītā darbība. Atbilstošo failu saraksts ir sākuma punkts, nevis pilns ietekmes novērtējums.
Saglabājiet ierakstu pietiekami nelielu lietošanai
Reģistrējiet lēmumus, kas ietekmē īstenošanu, pārbaudi un ekspluatāciju. Neatkārtojiet vienu prasību daudzos nesaistītos dokumentos. Dodiet priekšroku saitēm uz vienu uzturētu avotu.
Pirms izmaiņas pieņemšanas jautājiet, vai pārskatītājs var izsekot tās nolūku līdz faktiskajiem pierādījumiem. Pirms ekspluatācijas jautājiet, vai par pakalpojumu atbildīgais var atrast attiecīgo robežu un atjaunošanas lēmumu. Tie ir praktiski noderīgas izsekojamības testi.
Izpildiet uzdevumu
Uzrakstiet prasību vadītājam eksportēt aktīvos klientus. Iekļaujiet atļautos lietotājus, organizācijas robežu, laukus, darbību kļūmes gadījumā un izmērāmu pabeigšanas nosacījumu. Saistiet to ar izdomātu testu un laidienu. Tad mainiet prasību, iekļaujot arhivētos klientus, un uzskaitiet ietekmētos lēmumus.
Lejupielādēt darblapu (Markdown)Noņemot šo atzīmi, tiek dzēsts viss šajā pārlūkā saglabātais progress.
Progress paliek šajā pārlūkā. Bez konta un izsekošanas.
Avoti un papildu lasāmviela
- NIST: Secure Software Development Framework ↗
- Google Engineering Practices: What to look for in a code review ↗