Itinerari 04Lliçó 2 / 10

Manteniu la traçabilitat dels requisits quan canviï el programari

Relacioneu un resultat per a l'usuari amb decisions, criteris d'acceptació, implementació i evidències. Actualitzeu les connexions quan canviïn les hipòtesis.

Pràctic10 minRevisat

Publicat per Com escrivim

Comproveu què heu entèsL'especificació canvia després de preparar l'arquitectura i les proves. Què ha de passar?Feu l'exercici
L'especificació canvia després de preparar l'arquitectura i les proves. Què ha de passar?

Què aprendreu

  • Escriure un requisit observable amb límits explícits.
  • Seguir un requisit a través d'un canvi i les seves comprovacions.
  • Identificar els documents dependents afectats per una hipòtesi modificada.

Descriviu un comportament que es pugui verificar

«Creeu una exportació moderna de dades de clients» deixa decisions importants obertes. No defineix els usuaris, els registres, els camps ni el comportament en cas de fallada. Un agent ha de preguntar o fer hipòtesis. Les hipòtesis no registrades són difícils de revisar més endavant.

Utilitzeu un requisit fictici amb un límit clar: un responsable d’equip autenticat pot exportar dades de clients actius de la seva pròpia organització. L’exportació conté l’identificador de client i el nom visible. Exclou les dades de contacte i els registres arxivats. Un usuari sense el rol de responsable d’equip no rep cap exportació.

Encara cal decidir el format, el volum, el temps de resposta i el tractament de fallades. Marqueu explícitament els aspectes desconeguts. Una especificació útil mostra la incertesa en lloc d’amagar-la en un text que transmet seguretat.

Separeu els requisits de les decisions d’implementació

L’usuari necessita un conjunt de registres permesos en un format utilitzable. La consulta de base de dades, la biblioteca i l’estructura de l’endpoint són decisions d’implementació. Relacioneu-les amb el requisit sense tractar cada decisió actual com una necessitat permanent del negoci.

Registreu una decisió amb conseqüències importants amb el seu context, les alternatives i el motiu. Per exemple, una exportació síncrona pot ser adequada per a volums petits. Un volum més gran pot requerir una tasca en segon pla i una comprovació d’autorització separada per a la descàrrega.

Manteniu el requisit estable quan sigui possible i versioneu la decisió modificada. Això ajuda qui revisa el canvi a distingir una implementació diferent d’una promesa diferent als usuaris.

Creeu una cadena curta d’evidències

Utilitzeu identificadors que es puguin entendre durant les revisions. En aquest exemple, EXPORT-01 pot identificar el límit d’organització. El nom és il·lustratiu, no un sistema de numeració obligatori.

ConnexióExemple
RequisitEXPORT-01: només registres de l’organització del responsable d’equip
Decisió de dissenyFer complir la pertinença al servidor, no al navegador
ImplementacióLa PR modifica la consulta i el recorregut d’autorització
VerificacióEs denega una petició de registres d’una altra organització
Evidència de publicacióEl resultat de la comprovació identifica el commit i l’artefacte acceptats

La cadena ha d’apuntar a evidències reals. Que el nom d’una prova contingui l’identificador del requisit no demostra que l’asserció el comprovi. Inspeccioneu la prova i el recorregut de producció que posa a prova.

El SSDF de NIST proporciona context per als requisits i la verificació dins del desenvolupament segur. Utilitzeu la traçabilitat per fer inspeccionables aquestes activitats, no per produir documentació com a finalitat en si mateixa. Llegiu el marc.

Reviseu l’impacte d’una hipòtesi modificada

Suposeu que el negoci ara necessita dades de clients arxivats. Aquest canvi afecta més que un paràmetre de consulta. Comproveu les regles de conservació, l’autorització, el volum esperat, les explicacions als usuaris i el significat dels informes existents.

Marqueu els documents i les comprovacions afectats perquè es revisin. Conserveu la decisió anterior perquè una persona d’operacions pugui explicar una versió antiga. No reescriviu la història silenciosament per fer que el disseny més recent sembli inevitable.

Un agent pot ajudar a trobar referències i proposar actualitzacions. Els responsables han de resoldre els requisits contradictoris i acceptar el comportament modificat. Una llista de fitxers coincidents és un punt de partida, no una avaluació completa d’impacte.

Manteniu el registre prou petit per utilitzar-lo

Registreu les decisions que afecten la implementació, la verificació i l’operació. Eviteu repetir el mateix requisit en molts documents desconnectats. Preferiu enllaços a una única font mantinguda.

Abans d’acceptar un canvi, pregunteu si qui el revisa pot seguir-ne la finalitat fins a les evidències reals. Abans de posar-lo en funcionament, pregunteu si el responsable del servei pot localitzar el límit pertinent i la decisió de recuperació. Són proves pràctiques d’una traçabilitat útil.

Feu l'exercici

Escriviu un requisit perquè un responsable d'equip pugui exportar dades de clients actius. Incloeu els usuaris permesos, el límit d'organització, els camps, el comportament en cas de fallada i una condició mesurable d'acabament. Vinculeu-lo a una prova i una publicació fictícies. Després canvieu el requisit per incloure clients arxivats i enumereu les decisions afectades.

Descarrega la fitxa (Markdown)
Comproveu què heu entès ↑

Continua aprenent

Fonts i lectures addicionals

Lectures relacionades de Taiga

Lliçó anterior: Connecteu tot el cicle de vida del programari