Išlaikykite reikalavimų atsekamumą keičiantis programinei įrangai

Aprašykite veikimą, kurį kas nors gali patikrinti

„Sukurti šiuolaikinį klientų eksportą“ palieka svarbius sprendimus atvirus. Tai neapibrėžia naudotojų, įrašų, laukų ar elgesio sutrikus. Agentas turi klausti arba daryti prielaidas. Neužrašytas prielaidas vėliau sunku peržiūrėti.

Naudokite išgalvotą reikalavimą su aiškia riba: autentifikuotas vadovas gali eksportuoti aktyvius savo organizacijos klientus. Eksporte yra kliento ID ir rodomas vardas. Jis neapima kontaktinių duomenų ir archyvuotų įrašų. Naudotojas be vadovo vaidmens eksporto negauna.

Dar reikia sprendimų dėl formato, apimties, atsako laiko ir klaidų tvarkymo. Aiškiai pažymėkite nežinomus dalykus. Naudinga specifikacija atskleidžia neaiškumą, o ne paslepia jį užtikrintame tekste.

Atskirkite reikalavimus nuo įgyvendinimo pasirinkimų

Naudotojui reikia leidžiamo įrašų rinkinio tinkamu formatu. Duomenų bazės užklausa, biblioteka ir API adreso struktūra yra įgyvendinimo pasirinkimai. Susiekite juos su reikalavimu, bet nelaikykite kiekvieno dabartinio pasirinkimo nuolatiniu verslo poreikiu.

Svarbų sprendimą užrašykite kartu su aplinkybėmis, alternatyvomis ir priežastimi. Pavyzdžiui, sinchroninis eksportas gali tikti mažai apimčiai. Didesnei apimčiai gali reikėti foninės užduoties ir atskiro atsisiuntimo autorizavimo patikrinimo.

Kur įmanoma, išlaikykite stabilų reikalavimą, o pasikeitusį sprendimą versijuokite. Tai padeda peržiūrėtojams atskirti kitokį įgyvendinimą nuo kitokio pažado naudotojams.

Sukurkite trumpą įrodymų grandinę

Naudokite identifikatorius, kurie peržiūrose lieka suprantami. Šiame pavyzdyje EXPORT-01 gali žymėti organizacijos ribą. Pavadinimas yra iliustracija, o ne privaloma numeravimo sistema.

Grandinė turi rodyti tikrus įrodymus. Testo pavadinimas su reikalavimo ID neįrodo, kad tikrinimo sąlyga jį patikrina. Išnagrinėkite testą ir jo vykdomą produkcinio kodo kelią.

NIST SSDF suteikia reikalavimų ir patikrinimo kontekstą saugiame kūrime. Atsekamumą naudokite tam, kad šias veiklas būtų galima išnagrinėti, o ne dokumentacijai dėl pačios dokumentacijos kurti. Susipažinkite su gairėmis.

Peržiūrėkite pasikeitusios prielaidos poveikį

Tarkime, verslui dabar reikia archyvuotų klientų. Šis pakeitimas paveikia daugiau nei užklausos parametrą. Patikrinkite saugojimo taisykles, autorizavimą, numatytą apimtį, paaiškinimus naudotojams ir esamų ataskaitų reikšmę.

Pažymėkite paveiktus dokumentus ir patikrinimus peržiūrai. Išsaugokite ankstesnį sprendimą, kad eksploatuotojas galėtų paaiškinti senesnę versiją. Tyliai neperrašykite istorijos taip, kad naujausias sprendimas atrodytų neišvengiamas.

Agentas gali padėti rasti nuorodas ir pasiūlyti atnaujinimus. Atsakingi asmenys turi išspręsti prieštaringus reikalavimus ir priimti pasikeitusį veikimą. Sutampančių failų sąrašas yra pradžios taškas, o ne visas poveikio vertinimas.

Išlaikykite įrašą pakankamai nedidelį, kad juo naudotųsi

Užrašykite sprendimus, veikiančius įgyvendinimą, patikrinimą ir eksploatavimą. Nekartokite to paties reikalavimo daugybėje nesusietų dokumentų. Verčiau pateikite nuorodas į vieną prižiūrimą šaltinį.

Prieš priimdami pakeitimą, paklauskite, ar peržiūrėtojas gali atsekti jo tikslą iki tikrųjų įrodymų. Prieš pradėdami eksploatavimą, paklauskite, ar už paslaugą atsakingas asmuo gali rasti aktualią ribą ir atkūrimo sprendimą. Tai praktiniai naudingo atsekamumo patikrinimai.