Zachovajte sledovateľnosť požiadaviek pri zmenách softvéru

Opíšte správanie, ktoré možno overiť

„Vytvoriť moderný export zákazníkov“ necháva dôležité rozhodnutia otvorené. Nedefinuje používateľov, záznamy, polia ani správanie pri zlyhaní. Agent sa musí buď opýtať, alebo prijať predpoklady. Nezaznamenané predpoklady sa neskôr ťažko kontrolujú.

Použite fiktívnu požiadavku s jasnou hranicou: autentifikovaný manažér môže exportovať aktívnych zákazníkov zo svojej organizácie. Export obsahuje ID zákazníka a zobrazovaný názov. Vylučuje kontaktné údaje a archivované záznamy. Používateľ bez roly manažéra nedostane žiadny export.

Stále treba rozhodnúť o formáte, objeme, čase odozvy a spracovaní chýb. Neznáme veci označte výslovne. Užitočná špecifikácia odhaľuje neistotu namiesto jej skrytia v sebavedomom texte.

Oddeľte požiadavky od implementačných rozhodnutí

Používateľ potrebuje povolený súbor záznamov v použiteľnom formáte. Databázový dotaz, knižnica a štruktúra endpointu sú implementačné rozhodnutia. Prepojte ich s požiadavkou bez toho, aby ste každú aktuálnu voľbu považovali za trvalú obchodnú potrebu.

Rozhodnutie so závažnými dôsledkami zaznamenajte s kontextom, alternatívami a dôvodom. Napríklad synchrónny export môže vyhovovať malým objemom. Väčší objem môže vyžadovať úlohu na pozadí a samostatnú kontrolu oprávnenia na stiahnutie.

Ak je to možné, zachovajte stabilnú požiadavku a verziujte zmenené rozhodnutie. Kontrolujúce osoby tak ľahšie rozlíšia odlišnú implementáciu od odlišného prísľubu používateľom.

Vytvorte krátky reťazec dôkazov

Použite identifikátory, ktoré zostanú pri kontrolách zrozumiteľné. V tomto príklade môže EXPORT-01 označovať hranicu organizácie. Názov je ilustračný, nie povinný systém číslovania.

Reťazec musí odkazovať na skutočné dôkazy. Názov testu obsahujúci ID požiadavky nepreukazuje, že ju testové tvrdenie kontroluje. Preskúmajte test a produkčnú cestu, ktorú skúša.

NIST SSDF poskytuje kontext pre požiadavky a overenie v bezpečnom vývoji. Sledovateľnosť použite na sprístupnenie týchto činností kontrole, nie na tvorbu dokumentácie pre samotnú dokumentáciu. Prečítajte si rámec.

Preskúmajte dosah zmeneného predpokladu

Predstavte si, že firma teraz potrebuje archivovaných zákazníkov. Táto zmena ovplyvňuje viac než príznak databázového dotazu. Overte pravidlá uchovávania, autorizáciu, očakávaný objem, vysvetlenia pre používateľov a význam existujúcich reportov.

Označte dotknuté dokumenty a kontroly na preskúmanie. Zachovajte predchádzajúce rozhodnutie, aby prevádzkovateľ mohol vysvetliť staršie vydanie. Neprepisujte potichu históriu tak, aby najnovší návrh vyzeral ako nevyhnutný.

Agent môže pomôcť nájsť odkazy a navrhnúť aktualizácie. Zodpovedné osoby musia vyriešiť protichodné požiadavky a prijať zmenené správanie. Zoznam zodpovedajúcich súborov je začiatkom, nie úplným posúdením dosahu.

Udržujte záznam dostatočne stručný na použitie

Zaznamenajte rozhodnutia, ktoré ovplyvňujú implementáciu, overenie a prevádzku. Neopakujte rovnakú požiadavku v mnohých neprepojených dokumentoch. Uprednostnite odkazy na jeden udržiavaný zdroj.

Pred prijatím zmeny sa pýtajte, či kontrolujúca osoba dokáže od jej účelu prejsť k skutočným dôkazom. Pred prevádzkou sa pýtajte, či osoba zodpovedná za službu nájde relevantnú hranicu a rozhodnutie o obnove. Sú to praktické testy užitočnej sledovateľnosti.