Architecture Decision Record

Active theme: Light

← Templedi cofnodion penderfyniadau

Templed cofnod penderfyniad gan arc42

https://arc42.org/overview

1. Cyflwyniad a Nodau

Disgrifiad byr o'r gofynion, y grymoedd sy'n gyrru, a detholiad (neu grynodeb) o'r gofynion. Y tri phrif nod ansawdd (pump ar y mwyaf) ar gyfer y saernïaeth sydd â'r flaenoriaeth uchaf i'r prif randdeiliaid. Tabl o'r rhanddeiliaid pwysig a'u disgwyliadau o ran saernïaeth.

1.1 Trosolwg o'r Gofynion

Cynnwys

Disgrifiad byr o'r gofynion gweithredol, y grymoedd sy'n gyrru, a detholiad (neu grynodeb) o'r gofynion. Dolenni i'r dogfennau gofynion (a fydd yn bodoli, gobeithio), gyda gwybodaeth am ble i ddod o hyd iddynt.

Cymhelliant

O safbwynt y defnyddwyr terfynol, caiff system ei chreu neu ei newid i wella cymorth ar gyfer gweithgarwch busnes a/neu wella ansawdd.

Ffurf

Disgrifiad testun byr, ar ffurf tabl achosion defnydd yn ôl pob tebyg. Os oes dogfennau gofynion yn bodoli, dylai'r trosolwg hwn gyfeirio atynt.

Cadwch y detholiadau hyn mor fyr â phosibl. Cydbwyswch ddarllenadwyedd y ddogfen hon â'r ailadrodd posibl o'i gymharu â dogfennau'r gofynion.

1.2 Nodau ansawdd

Cynnwys

Y tri phrif nod ansawdd (pump ar y mwyaf) ar gyfer y saernïaeth y mae eu cyflawni o'r pwys mwyaf i'r prif randdeiliaid. Nodau ansawdd ar gyfer y saernïaeth rydym yn ei olygu mewn gwirionedd. Peidiwch â'u drysu â nodau'r prosiect. Nid ydynt o reidrwydd yr un fath. Mae safon ISO 25010 yn rhoi trosolwg da o'r pynciau o ddiddordeb posibl.

Cymhelliant

Dylech wybod nodau ansawdd eich rhanddeiliaid pwysicaf, gan y byddant yn dylanwadu ar benderfyniadau sylfaenol ynghylch saernïaeth. Byddwch yn bendant iawn am yr ansoddau hyn, ac osgowch eiriau gwag. Os nad ydych chi, fel pensaer, yn gwybod sut y caiff ansawdd eich gwaith ei farnu …

Ffurf

Tabl gyda'r nodau ansawdd pwysicaf a senarios pendant, wedi'u trefnu yn ôl blaenoriaeth.

1.3 Rhanddeiliaid

Cynnwys

Trosolwg eglur o randdeiliaid y system, h.y. pob unigolyn, rôl neu sefydliad sydd

  • angen gwybod y saernïaeth

  • angen cael eu perswadio o'r saernïaeth

  • angen gweithio gyda'r saernïaeth neu gyda'r cod

  • angen dogfennaeth y saernïaeth ar gyfer eu gwaith

  • angen dod i benderfyniadau am y system neu ei datblygiad

Cymhelliant

Dylech wybod yr holl bartïon sy'n rhan o ddatblygu'r system neu y mae'r system yn effeithio arnynt. Fel arall, efallai y cewch syrpréis annymunol yn ddiweddarach yn y broses ddatblygu. Y rhanddeiliaid hyn sy'n pennu maint a lefel manylder eich gwaith a'i ganlyniadau.

Ffurf

Tabl gydag enwau rolau, enwau unigolion, a'u disgwyliadau o ran y saernïaeth a'i dogfennaeth.

2. Cyfyngiadau

Unrhyw beth sy'n cyfyngu ar dimau wrth wneud penderfyniadau dylunio a gweithredu neu benderfyniadau am brosesau cysylltiedig. Weithiau gallant fynd y tu hwnt i systemau unigol a bod yn ddilys ar gyfer sefydliadau a chwmnïau cyfan.

Cynnwys

Unrhyw ofyniad sy'n cyfyngu ar ryddid penseiri meddalwedd wrth wneud penderfyniadau dylunio a gweithredu neu benderfyniadau am y broses ddatblygu. Weithiau mae'r cyfyngiadau hyn yn mynd y tu hwnt i systemau unigol ac yn ddilys ar gyfer sefydliadau a chwmnïau cyfan.

Cymhelliant

Dylai penseiri wybod yn union ble y mae ganddynt ryddid yn eu penderfyniadau dylunio a ble mae'n rhaid iddynt lynu wrth gyfyngiadau. Mae'n rhaid ymdrin â chyfyngiadau bob amser; fodd bynnag, efallai y gellir eu trafod.

Ffurf

Tablau syml o gyfyngiadau gydag esboniadau. Os oes angen, gallwch eu his-rannu yn gyfyngiadau technegol, cyfyngiadau sefydliadol a gwleidyddol, a chonfensiynau (e.e. canllawiau rhaglennu neu fersiynu, confensiynau dogfennaeth neu enwi)

3. Cyd-destun a Chwmpas

Yn gwahanu eich system oddi wrth ei phartneriaid cyfathrebu (allanol) (systemau cyfagos a defnyddwyr). Yn pennu'r rhyngwynebau allanol. Wedi'i ddangos o safbwynt busnes/parth (bob amser) neu safbwynt technegol (dewisol)

Cynnwys

Mae cwmpas a chyd-destun y system - fel mae'r enw'n awgrymu - yn gwahanu eich system (h.y. eich cwmpas) oddi wrth ei holl bartneriaid cyfathrebu (systemau cyfagos a defnyddwyr, h.y. cyd-destun eich system). Felly mae'n pennu'r rhyngwynebau allanol.

Os oes angen, gwahaniaethwch rhwng y cyd-destun busnes (mewnbynnau ac allbynnau penodol i'r parth) a'r cyd-destun technegol (sianeli, protocolau, caledwedd).

Cymhelliant

Mae'r rhyngwynebau parth a'r rhyngwynebau technegol i bartneriaid cyfathrebu ymhlith agweddau mwyaf hanfodol eich system. Gwnewch yn siŵr eich bod yn eu deall yn llwyr.

Ffurf

  • Diagramau cyd-destun amrywiol

  • Rhestrau o bartneriaid cyfathrebu a'u rhyngwynebau.

3.1 Cyd-destun busnes

Cynnwys

Manyleb o'r holl bartneriaid cyfathrebu (defnyddwyr, systemau TG, …) gydag esboniadau o fewnbynnau ac allbynnau neu ryngwynebau sy'n benodol i'r parth. Yn ddewisol, gallwch ychwanegu fformatau neu brotocolau cyfathrebu sy'n benodol i'r parth.

Cymhelliant

Dylai pob rhanddeiliad ddeall pa ddata sy'n cael eu cyfnewid ag amgylchedd y system.

Ffurf

Pob math o ddiagramau sy'n dangos y system fel blwch du ac yn pennu'r rhyngwynebau parth i bartneriaid cyfathrebu.

Fel arall (neu'n ychwanegol) gallwch ddefnyddio tabl. Teitl y tabl yw enw eich system, ac mae'r tair colofn yn cynnwys enw'r partner cyfathrebu, y mewnbynnau a'r allbynnau.

3.2 Cyd-destun technegol

Cynnwys

Y rhyngwynebau technegol (sianeli a chyfryngau trosglwyddo) sy'n cysylltu eich system â'i hamgylchedd. Hefyd, mapio mewnbwn/allbwn sy'n benodol i'r parth i'r sianeli, h.y. esboniad pa sianel y mae pob mewnbwn/allbwn yn ei defnyddio.

Cymhelliant

Mae llawer o randdeiliaid yn gwneud penderfyniadau ynghylch saernïaeth ar sail y rhyngwynebau technegol rhwng y system a'i chyd-destun. Yn enwedig dylunwyr seilwaith neu galedwedd sy'n penderfynu ar y rhyngwynebau technegol hyn.

Ffurf

E.e. diagram cyflwyno UML sy'n disgrifio sianeli i systemau cyfagos, ynghyd â thabl mapio sy'n dangos y berthynas rhwng sianeli a mewnbwn/allbwn.

4. Strategaeth yr Ateb

Crynodeb o'r penderfyniadau sylfaenol a'r strategaethau ateb sy'n llunio'r saernïaeth. Gall gynnwys technoleg, dadelfennu ar y lefel uchaf, dulliau o gyflawni'r prif nodau ansawdd a phenderfyniadau sefydliadol perthnasol.

Cynnwys

Crynodeb ac esboniad byr o'r penderfyniadau sylfaenol a'r strategaethau ateb sy'n llunio saernïaeth y system. Mae'r rhain yn cynnwys

  • penderfyniadau technoleg

  • penderfyniadau am ddadelfennu'r system ar y lefel uchaf, e.e. defnyddio patrwm saernïaeth neu batrwm dylunio

  • penderfyniadau ar sut i gyflawni'r prif nodau ansawdd

  • penderfyniadau sefydliadol perthnasol, e.e. dewis proses ddatblygu neu ddirprwyo tasgau penodol i drydydd partïon.

Cymhelliant

Y penderfyniadau hyn yw conglfeini eich saernïaeth. Nhw yw'r sail ar gyfer llawer o benderfyniadau manwl eraill neu reolau gweithredu.

Ffurf

Cadwch esboniad y prif benderfyniadau hyn yn fyr.

Eglurwch beth rydych wedi'i benderfynu a pham y gwnaethoch benderfynu felly, ar sail eich datganiad o'r broblem, y nodau ansawdd a'r prif gyfyngiadau. Cyfeiriwch at fanylion yn yr adrannau canlynol (adran 5 ar gyfer manylion strwythurol, adran 8 ar gyfer cysyniadau trawsbynciol).

Gallech ddefnyddio rhestr o ddulliau ateb neu dabl.

5. Golwg ar Flociau Adeiladu

Dadelfennu statig y system, haniaethau o'r cod ffynhonnell, a ddangosir fel hierarchaeth o flychau gwyn (sy'n cynnwys blychau du), hyd at y lefel briodol o fanylder.

Cynnwys

Mae'r olwg ar flociau adeiladu yn dangos dadelfennu statig y system yn flociau adeiladu (modiwlau, cydrannau, is-systemau, dosbarthiadau, rhyngwynebau, pecynnau, llyfrgelloedd, fframweithiau, haenau, rhaniadau, tiers, swyddogaethau, macros, gweithrediadau, strwythurau data, …) yn ogystal â'u dibyniaethau (perthnasoedd, cysylltiadau, …)

Mae'r olwg hon yn orfodol ar gyfer pob dogfennaeth saernïaeth. Fel analog â thŷ, hwn yw cynllun y llawr.

Cymhelliant

Cadwch drosolwg o'ch cod ffynhonnell drwy wneud ei strwythur yn ddealladwy trwy haniaethu.

Mae hyn yn eich galluogi i gyfathrebu â'ch rhanddeiliaid ar lefel haniaethol heb ddatgelu manylion gweithredu.

Ffurf

Mae'r olwg ar flociau adeiladu yn gasgliad hierarchaidd o flychau du a blychau gwyn (gweler y ffigur isod) a'u disgrifiadau.

5.1 Blwch Gwyn y System Gyfan

Yma rydych yn disgrifio dadelfennu'r system gyfan gan ddefnyddio'r templed blwch gwyn canlynol. Mae'n cynnwys

  • diagram trosolwg

  • cymhelliant dros y dadelfennu

  • disgrifiadau blwch du o'r blociau adeiladu a gynhwysir. Ar gyfer y rhain rydym yn cynnig dewisiadau amgen:

    • defnyddiwch un tabl ar gyfer trosolwg byr ac ymarferol o'r holl flociau adeiladu a gynhwysir a'u rhyngwynebau

    • defnyddiwch restr o ddisgrifiadau blwch du o'r blociau adeiladu yn ôl y templed blwch du (gweler isod). Gan ddibynnu ar eich dewis o offeryn, gallai'r rhestr hon fod yn is-benodau (mewn ffeiliau testun), yn is-dudalennau (mewn Wici) neu'n elfennau nythedig (mewn offeryn modelu).

    • (dewisol:) rhyngwynebau pwysig, nad ydynt wedi'u hesbonio yn nhempledi blwch du bloc adeiladu, ond sy'n bwysig iawn ar gyfer deall y blwch gwyn.

Gan fod cymaint o ffyrdd o bennu rhyngwynebau, nid ydym yn darparu templed penodol ar eu cyfer.

Yn yr achos gorau, bydd enghreifftiau neu lofnodion syml yn ddigon.

5.2 Lefel 2

Yma gallwch bennu strwythur mewnol (rhai) blociau adeiladu o lefel 1 fel blychau gwyn.

Mae'n rhaid i chi benderfynu pa flociau adeiladu o'ch system sy'n ddigon pwysig i gyfiawnhau disgrifiad manwl o'r fath. Ffafriwch berthnasedd yn hytrach na chyflawnrwydd. Pennwch flociau adeiladu pwysig, annisgwyl, peryglus, cymhleth neu gyfnewidiol. Gadewch allan rannau arferol, syml, diflas neu safonol o'ch system

5.2.1 Blwch Gwyn ar gyfer bloc adeiladu 1

Yn pennu strwythur mewnol bloc adeiladu 1.

Defnyddiwch y templed blwch gwyn (gweler uchod).

6. Golwg ar yr Amser Rhedeg

Ymddygiad blociau adeiladu fel senarios, sy'n cwmpasu achosion defnydd neu nodweddion pwysig, rhyngweithiadau ar ryngwynebau allanol hanfodol, gweithrediad a gweinyddu, ynghyd ag ymddygiad gwallau ac eithriadau.

Cynnwys

Mae'r olwg ar yr amser rhedeg yn disgrifio ymddygiad a rhyngweithiadau pendant blociau adeiladu'r system ar ffurf senarios o'r meysydd canlynol:

  • achosion defnydd neu nodweddion pwysig: sut mae blociau adeiladu yn eu cyflawni?

  • rhyngweithiadau ar ryngwynebau allanol hanfodol: sut mae blociau adeiladu yn cydweithredu â defnyddwyr a systemau cyfagos?

  • gweithrediad a gweinyddu: lansio, cychwyn, atal

  • senarios gwallau ac eithriadau

Sylw: Y prif faen prawf ar gyfer dewis senarios posibl (dilyniannau, llifoedd gwaith) yw eu perthnasedd o ran saernïaeth. Nid yw'n bwysig disgrifio nifer fawr o senarios. Yn hytrach, dylech ddogfennu detholiad cynrychioliadol.

Cymhelliant

Dylech ddeall sut mae (enghreifftiau o) flociau adeiladu eich system yn gwneud eu gwaith ac yn cyfathrebu ar yr amser rhedeg. Byddwch yn bennaf yn cofnodi senarios yn eich dogfennaeth i gyfleu eich saernïaeth i randdeiliaid sy'n llai parod neu'n llai abl i ddarllen a deall y modelau statig (yr olwg ar flociau adeiladu, yr olwg ar y cyflwyno).

Ffurf

Mae llawer o nodiannau ar gyfer disgrifio senarios, e.e.

  • rhestr rifedig o gamau (mewn iaith naturiol)

  • diagramau gweithgaredd neu siartiau llif

  • diagramau dilyniant

  • BPMN neu EPCs (cadwyni prosesau digwyddiadau)

  • peiriannau cyflwr

  • ac ati.

6.n Senario Amser Rhedeg n (1, 2, 3, ac ati)

Mewnosodwch ddiagram amser rhedeg neu ddisgrifiad testun o'r senario.

Mewnosodwch ddisgrifiad o agweddau nodedig y rhyngweithiadau rhwng enghreifftiau'r blociau adeiladu a ddangosir yn y diagram hwn.

7. Golwg ar y Cyflwyno

Seilwaith technegol gydag amgylcheddau, cyfrifiaduron, proseswyr, topolegau. Mapio blociau adeiladu (meddalwedd) i elfennau'r seilwaith.

Cynnwys

Mae'r olwg ar y cyflwyno yn disgrifio:

  • y seilwaith technegol a ddefnyddir i weithredu eich system, gyda elfennau seilwaith fel lleoliadau daearyddol, amgylcheddau, cyfrifiaduron, proseswyr, sianeli a thopolegau rhwydwaith, yn ogystal ag elfennau seilwaith eraill, a

  • mapio blociau adeiladu (meddalwedd) i'r elfennau seilwaith hynny.

Yn aml, caiff systemau eu gweithredu mewn amgylcheddau gwahanol, e.e. amgylchedd datblygu, amgylchedd profi, amgylchedd cynhyrchu. Yn yr achosion hynny dylech ddogfennu pob amgylchedd perthnasol.

Dogfennwch yr olwg ar y cyflwyno yn arbennig pan gaiff eich meddalwedd ei gweithredu fel system ddosbarthedig â mwy nag un cyfrifiadur, prosesydd, gweinydd neu gynhwysydd neu pan fyddwch yn dylunio ac yn adeiladu eich proseswyr a'ch sglodion caledwedd eich hun.

O safbwynt meddalwedd mae'n ddigon cofnodi'r elfennau hynny o'r seilwaith sydd eu hangen i ddangos cyflwyno eich blociau adeiladu. Gall penseiri caledwedd fynd y tu hwnt i hynny a disgrifio'r seilwaith i unrhyw lefel o fanylder y mae angen iddynt ei chofnodi.

Cymhelliant

Nid yw meddalwedd yn rhedeg heb galedwedd. Gall y seilwaith sylfaenol hwn ddylanwadu, ac fe fydd yn dylanwadu, ar eich system a/neu rai cysyniadau trawsbynciol. Felly, mae angen i chi wybod y seilwaith.

Ffurf

Efallai bod y diagram cyflwyno lefel uchaf eisoes yn adran 3.2. fel cyd-destun technegol gyda'ch seilwaith eich hun fel UN blwch du. Yn yr adran hon byddwch yn chwyddo i mewn i'r blwch du hwn gan ddefnyddio diagramau cyflwyno ychwanegol.

  • Mae UML yn cynnig diagramau cyflwyno i fynegi'r olwg honno. Defnyddiwch ef, gyda diagramau nythedig yn ôl pob tebyg, pan fo eich seilwaith yn fwy cymhleth.

  • Pan fo'ch rhanddeiliaid (caledwedd) yn ffafrio mathau eraill o ddiagramau yn hytrach na diagram cyflwyno UML, gadewch iddynt ddefnyddio unrhyw fath sy'n gallu dangos nodau a sianeli'r seilwaith.

7.1 Seilwaith Lefel 1

Disgrifiwch (fel arfer drwy gyfuniad o ddiagramau, tablau a thestun):

  • dosbarthiad eich system i leoliadau, amgylcheddau, cyfrifiaduron, proseswyr lluosog, .. yn ogystal â'r cysylltiadau ffisegol rhyngddynt

  • cyfiawnhad neu gymhelliant pwysig dros y strwythur cyflwyno hwn

  • nodweddion ansawdd a/neu berfformiad y seilwaith

  • mapio arteffactau meddalwedd (blociau adeiladu) i elfennau'r seilwaith

Ar gyfer amgylcheddau lluosog neu gyflwyniadau amgen, copïwch yr adran hon o arc42 ar gyfer pob amgylchedd perthnasol.

7.2 Seilwaith Lefel 2

Yma gallwch gynnwys strwythur mewnol (rhai) elfennau seilwaith o lefel 1 y seilwaith.

Copïwch y strwythur o lefel 1 ar gyfer pob elfen a ddewiswyd.

8. Cysyniadau Trawsbynciol

Yn gyffredinol, rheoliadau a dulliau ateb craidd sy'n berthnasol mewn nifer o rannau (→ trawsbynciol) o'r system. Mae cysyniadau'n aml yn gysylltiedig â nifer o flociau adeiladu. Cynhwyswch bynciau gwahanol fel modelau parth, patrymau ac arddulliau saernïaeth, rheolau ar gyfer defnyddio technoleg benodol a rheolau gweithredu.

Cynnwys

Mae'r adran hon yn disgrifio cysyniadau trawsbynciol (arferion, patrymau, rheoliadau neu syniadau ateb). Mae cysyniadau o'r fath yn aml yn gysylltiedig â nifer o flociau adeiladu. Gallant gynnwys llawer o bynciau gwahanol.

Cymhelliant

Cysyniadau yw'r sail ar gyfer uniondeb cysyniadol (cysondeb, unffurfiaeth) y saernïaeth. Felly, maent yn gyfraniad pwysig at gyflawni ansoddau mewnol eich system.

Dyma'r lle yn y templed a ddarparwyd gennym ar gyfer manyleb gydlynol o gysyniadau o'r fath.

Mae llawer o'r cysyniadau hyn yn ymwneud â nifer o'ch blociau adeiladu neu'n dylanwadu arnynt.

Ffurf

Gall y ffurf amrywio:

  • papurau cysyniad gydag unrhyw fath o strwythur

  • gweithrediadau enghreifftiol, yn enwedig ar gyfer cysyniadau technegol

  • detholiadau o fodelau neu senarios trawsbynciol gan ddefnyddio nodiannau'r golygon saernïaeth

Strwythur yr adran hon

Dewiswch y pynciau sydd eu hangen fwyaf ar gyfer eich system yn unig a neilltuwch bennawd lefel 2 i bob un yn yr adran hon (e.e. 8.1, 8.2 ac ati).

  • PEIDIWCH Â CHEISIO cwmpasu holl bynciau'r diagram uchod.

Cefndir

Mae rhai pynciau o fewn systemau yn aml yn ymwneud â nifer o flociau adeiladu, elfennau caledwedd neu brosesau datblygu. Gall fod yn haws cyfleu neu ddogfennu pynciau trawsbynciol o'r fath mewn lleoliad canolog, yn hytrach na'u hailadrodd yn nisgrifiad y blociau adeiladu, yr elfennau caledwedd neu'r prosesau datblygu dan sylw.

Gall rhai cysyniadau ymwneud â holl elfennau system, ac eraill yn berthnasol i ychydig yn unig.

9. Penderfyniadau ynghylch Saernïaeth

Penderfyniadau pwysig, drud, hanfodol, ar raddfa fawr neu beryglus ynghylch saernïaeth gan gynnwys y sail resymegol.

Cynnwys

Penderfyniadau pwysig, drud, ar raddfa fawr neu beryglus ynghylch saernïaeth gan gynnwys y sail resymegol. Wrth "benderfyniadau" rydym yn golygu dewis un dewis amgen ar sail meini prawf penodol.

Defnyddiwch eich barn i benderfynu a ddylid dogfennu penderfyniad ynghylch saernïaeth yma yn yr adran ganolog hon neu a fyddai'n well ei ddogfennu'n lleol (e.e. o fewn templed blwch gwyn un bloc adeiladu). Osgowch destunau ailadroddus. Cyfeiriwch at adran 4, lle rydych eisoes wedi cofnodi penderfyniadau pwysicaf eich saernïaeth.

Cymhelliant

Dylai rhanddeiliaid eich system allu deall ac olrhain eich penderfyniadau.

Ffurf

  • ADR (cofnod penderfyniad saernïaeth) ar gyfer pob penderfyniad pwysig

  • rhestr neu dabl, wedi'i drefnu yn ôl pwysigrwydd a chanlyniadau neu

  • yn fwy manwl ar ffurf adrannau ar wahân ar gyfer pob penderfyniad

Cefndir (ar ADRau)

Mae darnau llai o ddogfennaeth yn haws i'w darllen, eu creu a'u cynnal. O ran penderfyniadau ynghylch saernïaeth, bydd timau datblygu yn aml:

  • yn gwybod am y penderfyniad, gan ei fod yn weladwy e.e. yn y cod ffynhonnell, ond

  • yn colli'r cymhelliant y tu ôl i'r penderfyniad hwnnw (gweler Nygard 2011)

Felly dylech ddogfennu ychydig o benderfyniadau pwysig ynghyd â'u cymhelliant a'u rhesymu

Ein cynnig ynghylch penderfyniadau

Cadwch gasgliad o benderfyniadau arwyddocaol o ran saernïaeth, y penderfyniadau hynny sy'n effeithio ar y strwythur, nodweddion ansawdd, dibyniaethau a rhyngwynebau pwysig (yn enwedig rhai allanol), neu dechnegau adeiladu (diolch i Michael Nygard am y cynnig hwn).

10. Gofynion Ansawdd

Gofynion ansawdd fel senarios, gyda choeden ansawdd i roi trosolwg lefel uchel. Dylid fod wedi disgrifio'r nodau ansawdd pwysicaf yn adran 1.2. (nodau ansawdd).

Cynnwys

Mae'r adran hon yn cynnwys yr holl ofynion ansawdd perthnasol.

Mae'r pwysicaf o'r gofynion hyn eisoes wedi'u disgrifio yn adran 1.2. (nodau ansawdd), felly dim ond cyfeirio atynt y dylid ei wneud yma. Yn yr adran 10 hon dylech hefyd gofnodi gofynion ansawdd o lai o bwys, nad ydynt yn creu risgiau uchel os na chânt eu cyflawni'n llawn (ond a allai fod yn ddymunol).

Cymhelliant

Gan y bydd gofynion ansawdd yn dylanwadu llawer ar benderfyniadau ynghylch saernïaeth, dylech wybod pa ansoddau sydd wir yn bwysig i'ch rhanddeiliaid, mewn ffordd benodol a mesuradwy.

Rhagor o Wybodaeth

Gweler model ansawdd helaeth Q42 ar https://quality.arc42.org.

10.1 Trosolwg o'r Gofynion Ansawdd

Cynnwys

Trosolwg neu grynodeb o'r gofynion ansawdd.

Cymhelliant

Yn aml byddwn yn dod ar draws dwsinau (neu hyd yn oed gannoedd) o ofynion ansawdd manwl. Yn yr adran trosolwg hon dylech geisio crynhoi, e.e. drwy ddisgrifio categorïau neu bynciau (fel yr awgrymir gan ISO 25010:2023 neu Q42

Os yw'r disgrifiadau crynodeb hyn eisoes yn fanwl gywir, yn ddigon penodol ac yn fesuradwy, gallwch hepgor adran 10.2.

Ffurf

Defnyddiwch dabl syml lle mae pob llinell yn cynnwys categori neu bwnc a disgrifiad byr o'r gofyniad ansawdd. Fel arall, gallwch ddefnyddio mapfeddwl i strwythuro'r gofynion ansawdd hyn.

Yn y llenyddiaeth, disgrifiwyd y syniad o goeden priodoleddau ansawdd hefyd, sy'n rhoi'r term cyffredinol "ansawdd" fel y gwraidd ac yn defnyddio mireinio tebyg i goeden o'r term "ansawdd". Cyflwynodd [Bass+21] y term "Quality Attribute Utility Tree" at y diben hwn.

10.2 Senarios Ansawdd

Cynnwys

Mae senarios ansawdd yn gwneud gofynion ansawdd yn bendant ac yn caniatáu penderfynu a ydynt wedi'u cyflawni (o ran meini prawf derbyn). Sicrhewch fod eich senarios yn benodol ac yn fesuradwy.

Mae dau fath o senario yn arbennig o ddefnyddiol:

  • Mae senarios defnydd (a elwir hefyd yn senarios cymhwysiad neu senarios achos defnydd) yn disgrifio ymateb amser rhedeg y system i ysgogiad penodol. Mae hyn hefyd yn cynnwys senarios sy'n disgrifio effeithlonrwydd neu berfformiad y system. Enghraifft: Mae'r system yn ymateb i gais defnyddiwr o fewn eiliad.

  • Mae senarios newid yn disgrifio'r effaith ddymunol o addasu neu ymestyn y system neu ei hamgylchedd agos. Enghraifft: Mae swyddogaeth ychwanegol yn cael ei gweithredu neu mae gofynion ar gyfer priodoledd ansawdd yn newid, ac mae'r ymdrech neu'r hyd y newid yn cael ei fesur.

Ffurf

Mae gwybodaeth nodweddiadol ar gyfer senarios manwl yn cynnwys y canlynol:

Ar ffurf fer (a ffafrir yn y model Q42):

  • Cyd-destun/Cefndir: Pa fath o system neu gydran, beth yw'r amgylchedd neu'r sefyllfa?

  • Ffynhonnell/Ysgogiad: Pwy neu beth sy'n cychwyn neu'n sbarduno ymddygiad, ymateb neu weithred.

  • Metrig/Meini Prawf Derbyn: Ymateb sy'n cynnwys mesur neu fetrig

Mae ffurf hir y senarios (a ffafrir gan y SEI a [Bass+21]) yn fwy manwl ac yn cynnwys yr wybodaeth ganlynol:

  • ID y Senario: Dynodwr unigryw ar gyfer y senario.

  • Enw'r Senario: Enw byr, disgrifiadol ar gyfer y senario.

  • Ffynhonnell: Yr endid (defnyddiwr, system neu ddigwyddiad) sy'n cychwyn y senario.

  • Ysgogiad: Y digwyddiad neu'r cyflwr sbarduno y mae'n rhaid i'r system fynd i'r afael ag ef.

  • Amgylchedd: Y cyd-destun neu'r cyflwr gweithredol y mae'r system yn profi'r ysgogiad oddi tano.

  • Arteffact: Y blociau adeiladu neu elfennau eraill o'r system yr effeithir arnynt gan yr ysgogiad.

  • Ymateb: Y deilliant neu'r ymddygiad y mae'r system yn ei arddangos mewn ymateb i'r ysgogiad.

  • Mesur yr Ymateb: Y meini prawf neu'r metrig a ddefnyddir i werthuso ymateb y system.

Gweler hefyd

Ers Ionawr 2023, mae arc42 yn darparu model ansawdd pragmatig, sy'n cynnig labelu gofynion ansawdd, gyda hashnodau neu labeli fel #flexible, #efficient, #usable, #operable, #testable, #secure, #safe, #reliable.

11. Risgiau a Dyled Dechnegol

Risgiau technegol hysbys neu ddyled dechnegol. Pa broblemau posibl sy'n bodoli o fewn neu o amgylch y system? Beth sy'n gwneud i'r tîm datblygu deimlo'n anhapus?

Cynnwys

Rhestr o risgiau technegol neu ddyledion technegol a nodwyd, wedi'u trefnu yn ôl blaenoriaeth

Cymhelliant

"Rheoli risg yw rheoli prosiectau i oedolion" (Tim Lister, Atlantic Systems Guild.)

Dylai hyn fod yn arwyddair i chi ar gyfer canfod a gwerthuso risgiau a dyledion technegol yn y saernïaeth yn systematig, a fydd eu hangen ar randdeiliaid rheoli (e.e. rheolwyr prosiect, perchnogion cynnyrch) fel rhan o'r dadansoddiad risg cyffredinol a'r cynllunio mesurau.

Ffurf

Rhestr o risgiau a/neu ddyledion technegol, gan gynnwys mesurau a awgrymir yn ôl pob tebyg i leihau, lliniaru neu osgoi risgiau neu leihau dyledion technegol.