Mudell ta' rekord ta' deċiżjoni minn arc42

1. Introduzzjoni u Għanijiet

Deskrizzjoni qasira tar-rekwiżiti, tal-forzi li jmexxu, estratt (jew astratt) tar-rekwiżiti. L-aqwa tliet (massimu ħamsa) għanijiet tal-kwalità għall-arkitettura li għandhom l-ogħla prijorità għall-partijiet interessati ewlenin. Tabella tal-partijiet interessati importanti bl-aspettattivi tagħhom rigward l-arkitettura.

1.1 Ħarsa ġenerali lejn ir-rekwiżiti

Kontenut

Deskrizzjoni qasira tar-rekwiżiti funzjonali, tal-forzi li jmexxu, estratt (jew astratt) tar-rekwiżiti. Rabtiet mad-dokumenti tar-rekwiżiti (li nittamaw li jeżistu), b'informazzjoni dwar fejn insibuhom.

Motivazzjoni

Mill-perspettiva tal-utenti aħħarin, sistema tinħoloq jew tinbidel biex ittejjeb l-appoġġ ta' attività tan-negozju u/jew ittejjeb il-kwalità.

Forma

Deskrizzjoni qasira bit-test, probabbilment f'format ta' każijiet ta' użu f'tabella. Jekk jeżistu dokumenti tar-rekwiżiti, din il-ħarsa ġenerali għandha tirreferi għal dawn id-dokumenti.

Żomm dawn l-estratti qosra kemm jista' jkun. Ibbilanċja l-qari ta' dan id-dokument mar-ridondanza potenzjali fir-rigward tad-dokumenti tar-rekwiżiti.

1.2 Għanijiet tal-kwalità

Kontenut

L-aqwa tliet (massimu ħamsa) għanijiet tal-kwalità għall-arkitettura li t-twettiq tagħhom huwa tal-akbar importanza għall-partijiet interessati ewlenin. Qed nifhmu verament għanijiet tal-kwalità għall-arkitettura. Tħawwadhomx mal-għanijiet tal-proġett. Mhumiex neċessarjament identiċi. L-istandard ISO 25010 jipprovdi ħarsa ġenerali sabiħa ta' suġġetti potenzjali ta' interess.

Motivazzjoni

Għandek tkun taf l-għanijiet tal-kwalità tal-aktar partijiet interessati importanti tiegħek, peress li se jinfluwenzaw deċiżjonijiet arkitettoniċi fundamentali. Kun żgur li tkun konkret ħafna dwar dawn il-kwalitajiet, evita kliem tal-moda. Jekk int bħala arkitett ma tafx kif se tiġi ġġudikata l-kwalità tax-xogħol tiegħek …

Forma

Tabella bl-aktar għanijiet importanti tal-kwalità u xenarji konkreti, ordnati skont il-prijoritajiet.

1.3 Partijiet interessati

Kontenut

Ħarsa ġenerali espliċita tal-partijiet interessati tas-sistema, jiġifieri l-persuni, ir-rwoli jew l-organizzazzjonijiet kollha li

għandhom jafu l-arkitettura
jridu jiġu mqanqlin dwar l-arkitettura
jridu jaħdmu mal-arkitettura jew mal-kodiċi
għandhom bżonn id-dokumentazzjoni tal-arkitettura għax-xogħol tagħhom
jridu jieħdu deċiżjonijiet dwar is-sistema jew l-iżvilupp tagħha

Motivazzjoni

Għandek tkun taf il-partijiet kollha involuti fl-iżvilupp tas-sistema jew affettwati mis-sistema. Inkella, tista' tiltaqa' ma' sorpiżi spjaċevoli aktar tard fil-proċess tal-iżvilupp. Dawn il-partijiet interessati jiddeterminaw l-estensjoni u l-livell ta' dettall tax-xogħol tiegħek u tar-riżultati tiegħu.

Forma

Tabella bl-ismijiet tar-rwoli, l-ismijiet tal-persuni, u l-aspettattivi tagħhom fir-rigward tal-arkitettura u tad-dokumentazzjoni tagħha.

2. Restrizzjonijiet

Kull ma jirrestrinġi lit-timijiet fid-deċiżjonijiet dwar id-disinn u l-implimentazzjoni jew id-deċiżjonijiet dwar proċessi relatati. Kultant jistgħu jmorru lil hinn minn sistemi individwali u jkunu validi għal organizzazzjonijiet u kumpaniji sħaħ.

Kontenut

Kull rekwiżit li jirrestrinġi lill-arkitetti tas-software fil-libertà tagħhom ta' disinn u deċiżjonijiet ta' implimentazzjoni jew deċiżjonijiet dwar il-proċess tal-iżvilupp. Dawn ir-restrizzjonijiet kultant jmorru lil hinn minn sistemi individwali u huma validi għal organizzazzjonijiet u kumpaniji sħaħ.

Motivazzjoni

L-arkitetti għandhom jafu eżattament fejn huma ħielsa fid-deċiżjonijiet tad-disinn tagħhom u fejn iridu jimxu mar-restrizzjonijiet. Ir-restrizzjonijiet dejjem iridu jiġu trattati; madankollu jistgħu jkunu negozjabbli.

Forma

Tabelli sempliċi ta' restrizzjonijiet bi spjegazzjonijiet. Jekk meħtieġ tista' taqsamhom f'restrizzjonijiet tekniċi, restrizzjonijiet organizzattivi u politiċi u konvenzjonijiet (eż. linji gwida tal-programmazzjoni jew tal-verżjonar, konvenzjonijiet tad-dokumentazzjoni jew tal-ismijiet)

3. Kuntest u Ambitu

Jiddelimita s-sistema tiegħek mis-sħab tagħha (esterni) tal-komunikazzjoni (sistemi ġirien u utenti). Jispeċifika l-interfaces esterni. Muri mill-perspettiva tan-negozju/tad-dominju (dejjem) jew mill-perspettiva teknika (fakultattiv)

Kontenut

L-ambitu u l-kuntest tas-sistema - kif jissuġġerixxi l-isem - jiddelimitaw is-sistema tiegħek (jiġifieri l-ambitu tiegħek) mis-sħab kollha tagħha tal-komunikazzjoni (sistemi ġirien u utenti, jiġifieri l-kuntest tas-sistema tiegħek). B'hekk jispeċifikaw l-interfaces esterni.

Jekk meħtieġ, iddistingwi l-kuntest tan-negozju (inputs u outputs speċifiċi għad-dominju) mill-kuntest tekniku (kanali, protokolli, hardware).

Motivazzjoni

L-interfaces tad-dominju u l-interfaces tekniċi mas-sħab tal-komunikazzjoni huma fost l-aktar aspetti kritiċi tas-sistema tiegħek. Kun żgur li tifhimhom kompletament.

Forma

Dijagrammi differenti tal-kuntest
Listi ta' sħab tal-komunikazzjoni u l-interfaces tagħhom.

3.1 Kuntest tan-negozju

Kontenut

Speċifikazzjoni tas-sħab kollha tal-komunikazzjoni (utenti, sistemi tal-IT, …) bi spjegazzjonijiet ta' inputs u outputs jew interfaces speċifiċi għad-dominju. Fakultattivament tista' żżid formati speċifiċi għad-dominju jew protokolli tal-komunikazzjoni.

Motivazzjoni

Il-partijiet interessati kollha għandhom jifhmu liema data tiġi skambjata mal-ambjent tas-sistema.

Forma

Kull tip ta' dijagrammi li juru s-sistema bħala kaxxa sewda u jispeċifikaw l-interfaces tad-dominju mas-sħab tal-komunikazzjoni.

Alternattivament (jew addizzjonalment) tista' tuża tabella. It-titlu tat-tabella huwa l-isem tas-sistema tiegħek, it-tliet kolonni fihom l-isem tas-sieħeb tal-komunikazzjoni, l-inputs, u l-outputs.

3.2 Kuntest tekniku

Kontenut

Interfaces tekniċi (kanali u mezzi ta' trasmissjoni) li jorbtu s-sistema tiegħek mal-ambjent tagħha. Barra minn hekk mapping ta' input/output speċifiku għad-dominju għall-kanali, jiġifieri spjegazzjoni ta' liema I/O juża liema kanal.

Motivazzjoni

Ħafna partijiet interessati jieħdu deċiżjonijiet arkitettoniċi abbażi tal-interfaces tekniċi bejn is-sistema u l-kuntest tagħha. Speċjalment id-disinjaturi tal-infrastruttura jew tal-hardware jiddeċiedu dawn l-interfaces tekniċi.

Forma

Eż. dijagramma tad-deployment UML li tiddeskrivi l-kanali lejn sistemi ġirien, flimkien ma' tabella ta' mapping li turi r-relazzjonijiet bejn il-kanali u l-input/output.

4. Strateġija tas-Soluzzjoni

Sommarju tad-deċiżjonijiet fundamentali u tal-istrateġiji tas-soluzzjoni li jiffurmaw l-arkitettura. Jista' jinkludi teknoloġija, dekompożizzjoni ta' livell għoli, approċċi biex jinkisbu l-aqwa għanijiet tal-kwalità u deċiżjonijiet organizzattivi rilevanti.

Kontenut

Sommarju qasir u spjegazzjoni tad-deċiżjonijiet fundamentali u tal-istrateġiji tas-soluzzjoni, li jiffurmaw l-arkitettura tas-sistema. Dawn jinkludu

deċiżjonijiet dwar it-teknoloġija
deċiżjonijiet dwar id-dekompożizzjoni ta' livell għoli tas-sistema, eż. l-użu ta' xejra arkitettonika jew xejra tad-disinn
deċiżjonijiet dwar kif jinkisbu l-għanijiet ewlenin tal-kwalità
deċiżjonijiet organizzattivi rilevanti, eż. l-għażla ta' proċess tal-iżvilupp jew id-delegazzjoni ta' ċerti kompiti lil partijiet terzi.

Motivazzjoni

Dawn id-deċiżjonijiet jiffurmaw il-pedamenti tal-arkitettura tiegħek. Huma l-bażi għal ħafna deċiżjonijiet dettaljati oħra jew regoli ta' implimentazzjoni.

Forma

Żomm l-ispjegazzjoni ta' dawn id-deċiżjonijiet ewlenin qasira.

Immotiva dak li ddeċidejt u għaliex iddeċidejt b'dak il-mod, abbażi tad-dikjarazzjoni tal-problema, l-għanijiet tal-kwalità u r-restrizzjonijiet ewlenin tiegħek. Irreferi għad-dettalji fit-taqsimiet li ġejjin (taqsima 5 għad-dettalji strutturali, taqsima 8 għall-kunċetti trasversali).

Tista' tuża lista ta' approċċi tas-soluzzjoni jew tabella.

5. Veduta tal-Blokok tal-Bini

Dekompożizzjoni statika tas-sistema, astrazzjonijiet tal-kodiċi sors, murija bħala ġerarkija ta' kaxxi bojod (li fihom kaxxi suwed), sal-livell xieraq ta' dettall.

Kontenut

Il-veduta tal-blokok tal-bini turi d-dekompożizzjoni statika tas-sistema f' blokok tal-bini (moduli, komponenti, sottosistemi, klassijiet, interfaces, pakketti, librerijiet, frameworks, saffi, partizzjonijiet, livelli, funzjonijiet, makros, operazzjonijiet, strutturi tad-data, …) kif ukoll id-dipendenzi tagħhom (relazzjonijiet, assoċjazzjonijiet, …)

Din il-veduta hija obbligatorja għal kull dokumentazzjoni tal-arkitettura. B'analoġija ma' dar din hija l-pjanta tal-art.

Motivazzjoni

Żomm ħarsa ġenerali tal-kodiċi sors tiegħek billi tagħmel l-istruttura tiegħu komprensibbli permezz tal-astrazzjoni.

Dan jippermettilek tikkomunika mal-partijiet interessati tiegħek f'livell astratt mingħajr ma tiżvela d-dettalji tal-implimentazzjoni.

Forma

Il-veduta tal-blokok tal-bini hija ġabra ġerarkika ta' kaxxi suwed u kaxxi bojod (ara l-figura hawn taħt) u d-deskrizzjonijiet tagħhom.

5.1 Kaxxa bajda tas-Sistema kollha

Hawnhekk tiddeskrivi d-dekompożizzjoni tas-sistema kollha billi tuża l-mudell li ġej tal-kaxxa bajda. Fih

dijagramma ta' ħarsa ġenerali
motivazzjoni għad-dekompożizzjoni
deskrizzjonijiet tal-kaxxa sewda tal-blokok tal-bini li fiha. Għal dawn nipprovdulek alternattivi:
- uża tabella waħda għal ħarsa ġenerali qasira u pragmatika tal-blokok tal-bini kollha li fiha u tal-interfaces tagħhom
- uża lista ta' deskrizzjonijiet tal-kaxxa sewda tal-blokok tal-bini skont il-mudell tal-kaxxa sewda (ara hawn taħt). Skont l-għażla tal-għodda tiegħek, din il-lista tista' tkun sottokapitli (fi fajls tat-test), sottopaġni (fi Wiki) jew elementi nested (f'għodda tal-immudellar).
- (fakultattiv:) interfaces importanti, li mhumiex spjegati fil-mudelli tal-kaxxa sewda ta' blokk tal-bini, iżda huma importanti ħafna biex tifhem il-kaxxa bajda.

Peress li hemm ħafna modi kif jiġu speċifikati l-interfaces ma nipprovdux mudell speċifiku għalihom.

Fl-aħjar każ taqbeż b'eżempji jew firem sempliċi.

5.2 Livell 2

Hawnhekk tista' tispeċifika l-istruttura interna ta' (xi) blokok tal-bini mil-livell 1 bħala kaxxi bojod.

Trid tiddeċiedi liema blokok tal-bini tas-sistema tiegħek huma importanti biżżejjed biex jiġġustifikaw deskrizzjoni daqshekk dettaljata. Jekk jogħġbok ippreferi r-rilevanza fuq il-kompletezza. Speċifika blokok tal-bini importanti, sorprendenti, riskjużi, kumplessi jew volatili. Ħalli barra partijiet normali, sempliċi, tedjanti jew standardizzati tas-sistema tiegħek

5.2.1 Kaxxa bajda għall-blokk tal-bini 1

Tispeċifika l-istruttura interna tal-blokk tal-bini 1.

Uża l-mudell tal-kaxxa bajda (ara hawn fuq).

6. Veduta tal-Runtime

Mgħiba tal-blokok tal-bini bħala xenarji, li jkopru każijiet ta' użu jew karatteristiċi importanti, interazzjonijiet f'interfaces esterni kritiċi, operat u amministrazzjoni flimkien ma' mgħiba ta' żbalji u eċċezzjonijiet.

Kontenut

Il-veduta tar-runtime tiddeskrivi mgħiba u interazzjonijiet konkreti tal-blokok tal-bini tas-sistema f'forma ta' xenarji mill-oqsma li ġejjin:

każijiet ta' użu jew karatteristiċi importanti: kif il-blokok tal-bini jeżegwuhom?
interazzjonijiet f'interfaces esterni kritiċi: kif il-blokok tal-bini jikkooperaw mal-utenti u mas-sistemi ġirien?
operat u amministrazzjoni: tnedija, bidu, twaqqif
xenarji ta' żbalji u eċċezzjonijiet

Rimarka: Il-kriterju ewlieni għall-għażla tax-xenarji possibbli (sekwenzi, workflows) huwa r-rilevanza arkitettonika tagħhom. Mhuwiex importanti li jiġi deskritt numru kbir ta' xenarji. Aħjar tiddokumenta għażla rappreżentattiva.

Motivazzjoni

Għandek tifhem kif (l-istanzi tal-) blokok tal-bini tas-sistema tiegħek iwettqu x-xogħol tagħhom u jikkomunikaw waqt ir-runtime. Prinċipalment se tiġbor ix-xenarji fid-dokumentazzjoni tiegħek biex tikkomunika l-arkitettura tiegħek lill-partijiet interessati li huma anqas lesti jew kapaċi jaqraw u jifhmu l-mudelli statiċi (veduta tal-blokok tal-bini, veduta tad-deployment).

Forma

Hemm ħafna notazzjonijiet biex jiġu deskritti x-xenarji, eż.

lista bin-numri ta' passi (b'lingwa naturali)
dijagrammi tal-attività jew flowcharts
dijagrammi tas-sekwenza
BPMN jew EPCs (event process chains)
makkini tal-istat
eċċ.

6.n Xenarju tar-Runtime n (1, 2, 3, eċċ.)

Daħħal dijagramma tar-runtime jew deskrizzjoni bit-test tax-xenarju.

Daħħal deskrizzjoni tal-aspetti notevoli tal-interazzjonijiet bejn l-istanzi tal-blokok tal-bini murija f'din id-dijagramma.

7. Veduta tad-Deployment

Infrastruttura teknika b'ambjenti, kompjuters, proċessuri, topoloġiji. Mapping tal-blokok tal-bini (tas-software) għall-elementi tal-infrastruttura.

Kontenut

Il-veduta tad-deployment tiddeskrivi:

l-infrastruttura teknika użata biex titħaddem is-sistema tiegħek, b'elementi tal-infrastruttura bħal postijiet ġeografiċi, ambjenti, kompjuters, proċessuri, kanali u topoloġiji tan-netwerk kif ukoll elementi oħra tal-infrastruttura u
il-mapping tal-blokok tal-bini (tas-software) għal dawk l-elementi tal-infrastruttura.

Spiss is-sistemi jitħaddmu f'ambjenti differenti, eż. ambjent tal-iżvilupp, ambjent tat-test, ambjent tal-produzzjoni. F'każijiet bħal dawn għandek tiddokumenta l-ambjenti rilevanti kollha.

Iddokumenta speċjalment il-veduta tad-deployment meta s-software tiegħek jitħaddem bħala sistema distribwita b'aktar minn kompjuter, proċessur, server jew kontenitur wieħed jew meta tfassal u tibni l-proċessuri u ċ-ċipep tal-hardware tiegħek stess.

Mill-perspettiva tas-software huwa biżżejjed li tiġbor dawk l-elementi tal- infrastruttura li huma meħtieġa biex juru d-deployment tal-blokok tal-bini tiegħek. L-arkitetti tal-hardware jistgħu jmorru lil hinn minn hekk u jiddeskrivu l-infrastruttura sa kwalunkwe livell ta' dettall li jeħtieġu jiġbru.

Motivazzjoni

Is-software ma jaħdimx mingħajr hardware. Din l-infrastruttura sottostanti tista' u se tinfluwenza s-sistema tiegħek u/jew xi kunċetti trasversali. Għalhekk, għandek bżonn tkun taf l-infrastruttura.

Forma

Forsi d-dijagramma tad-deployment tal-ogħla livell diġà hija inkluża fit-taqsima 3.2. bħala kuntest tekniku bl-infrastruttura tiegħek stess bħala kaxxa sewda WAĦDA. F'din it-taqsima se tiżżumma f'din il-kaxxa sewda billi tuża dijagrammi addizzjonali tad-deployment.

L-UML toffri dijagrammi tad-deployment biex tesprimi din il-veduta. Uża dawn, probabbilment b'dijagrammi nested, meta l-infrastruttura tiegħek tkun aktar kumplessa.
Meta l-partijiet interessati (tal-hardware) tiegħek jippreferu tipi oħra ta' dijagrammi minflok id-dijagramma tad-deployment UML, ħallihom jużaw kwalunkwe tip li kapaċi juri nodi u kanali tal-infrastruttura.

7.1 Infrastruttura Livell 1

Iddeskrivi (normalment f'taħlita ta' dijagrammi, tabelli, u test):

id-distribuzzjoni tas-sistema tiegħek f'postijiet, ambjenti, kompjuters, proċessuri multipli, .. kif ukoll il-konnessjonijiet fiżiċi bejniethom
ġustifikazzjoni jew motivazzjoni importanti għal din l-istruttura tad-deployment
karatteristiċi tal-kwalità u/jew tal-prestazzjoni tal-infrastruttura
il-mapping tal-artefatti tas-software (blokok tal-bini) għal elementi tal-infrastruttura

Għal ambjenti multipli jew deployments alternattivi jekk jogħġbok ikkopja dik it-taqsima ta' arc42 għall-ambjenti rilevanti kollha. **

7.2 Infrastruttura Livell 2

Hawnhekk tista' tinkludi l-istruttura interna ta' (xi) elementi tal-infrastruttura mil-livell 1 tal-infrastruttura.

Jekk jogħġbok ikkopja l-istruttura mil-livell 1 għal kull element magħżul.

8. Kunċetti Trasversali

B'mod ġenerali, regolamenti prinċipali u approċċi tas-soluzzjoni rilevanti f'diversi partijiet (→ trasversali) tas-sistema. Il-kunċetti spiss huma relatati ma' blokok tal-bini multipli. Inkludi suġġetti differenti bħal mudelli tad-dominju, xejriet u stili arkitettoniċi, regoli għall-użu ta' teknoloġija speċifika u regoli ta' implimentazzjoni.

Kontenut

Din it-taqsima tiddeskrivi kunċetti trasversali (prattiki, xejriet, regolamenti jew ideat ta' soluzzjoni). Tali kunċetti spiss huma relatati ma' blokok tal-bini multipli. Jistgħu jinkludu ħafna suġġetti differenti.

Motivazzjoni

Il-kunċetti jiffurmaw il-bażi għall-integrità kunċettwali (konsistenza, omoġeneità) tal- arkitettura. Għalhekk, huma kontribut importanti biex jinkisbu l-kwalitajiet interni tas-sistema tiegħek.

Dan huwa l-post fil-mudell li pprovdejna għal speċifikazzjoni koeżiva ta' tali kunċetti.

Ħafna minn dawn il-kunċetti huma relatati ma' diversi blokok tal-bini tiegħek jew jinfluwenzawhom.

Forma

Il-forma tista' tvarja:

karti tal-kunċetti b'kwalunkwe tip ta' struttura
implimentazzjonijiet bħala eżempju, speċjalment għal kunċetti tekniċi
estratti ta' mudelli trasversali jew xenarji li jużaw notazzjonijiet tal-vedute tal-arkitettura

Struttura ta' din it-taqsima

Agħżel biss is-suġġetti l-aktar meħtieġa għas-sistema tiegħek u assenja lil kull wieħed intestatura ta' livell 2 f'din it-taqsima (eż. 8.1, 8.2 eċċ).

TIPPRUVAX tkopri s-suġġetti kollha tad-dijagramma msemmija hawn fuq.

Sfond

Xi suġġetti f'sistemi spiss jikkonċernaw blokok tal-bini multipli, elementi tal-hardware jew proċessi tal-iżvilupp. Jista' jkun eħfef li tikkomunika jew tiddokumenta tali suġġetti trasversali f'post ċentrali, minflok ma tirrepetihom fid-deskrizzjoni tal-blokok tal-bini, tal-elementi tal-hardware jew tal-proċessi tal-iżvilupp konċernati.

Ċerti kunċetti jistgħu jikkonċernaw l-elementi kollha ta' sistema, oħrajn jistgħu jkunu rilevanti biss għal ftit.

9. Deċiżjonijiet Arkitettoniċi

Deċiżjonijiet arkitettoniċi importanti, għaljin, kritiċi, fuq skala kbira jew riskjużi inklużi r-raġunamenti.

Kontenut

Deċiżjonijiet arkitettoniċi importanti, għaljin, fuq skala kbira jew riskjużi inklużi r-raġunamenti. Bi "deċiżjonijiet" nifhmu l-għażla ta' alternattiva waħda abbażi ta' kriterji mogħtija.

Jekk jogħġbok uża l-ġudizzju tiegħek biex tiddeċiedi jekk deċiżjoni arkitettonika għandhiex tiġi dokumentata hawnhekk f'din it-taqsima ċentrali jew jekk aħjar tiddokumentaha lokalment (eż. fil-mudell tal-kaxxa bajda ta' blokk tal-bini wieħed). Evita testi ridondanti. Irreferi għat-taqsima 4, fejn diġà ġbart l-aktar deċiżjonijiet importanti tal-arkitettura tiegħek.

Motivazzjoni

Il-partijiet interessati tas-sistema tiegħek għandhom ikunu jistgħu jifhmu u jitraċċaw id-deċiżjonijiet tiegħek.

Forma

ADR (rekord ta' deċiżjoni arkitettonika) għal kull deċiżjoni importanti
lista jew tabella, ordnata skont l-importanza u l-konsegwenzi jew
aktar dettaljat f'forma ta' taqsimiet separati għal kull deċiżjoni

Sfond (dwar l-ADR)

Biċċiet iżgħar ta' dokumentazzjoni huma eħfef biex jinqraw, jinħolqu u jinżammu. Meta tiġi għall-deċiżjonijiet arkitettoniċi, it-timijiet tal-iżvilupp spiss:

jafu dwar id-deċiżjoni, billi tidher eż. fil-kodiċi sors, iżda
jonqsu mill-motivazzjoni wara dik id-deċiżjoni (ara Nygard 2011)

Għalhekk għandek tiddokumenta ftit deċiżjonijiet importanti flimkien mal-motivazzjoni tagħhom, ir-raġunament

Il-proposta tagħna dwar id-deċiżjonijiet

Żomm ġabra ta' deċiżjonijiet sinifikanti mil-lat arkitettoniku, dawk id-deċiżjonijiet li jaffettwaw l-istruttura, il-karatteristiċi tal-kwalità, id-dipendenzi importanti (speċjalment esterni) u l-interfaces, jew it-tekniki tal-kostruzzjoni (grazzi lil Michael Nygard għal din il-proposta).

10. Rekwiżiti tal-Kwalità

Rekwiżiti tal-kwalità bħala xenarji, b'siġra tal-kwalità biex tipprovdi ħarsa ġenerali ta' livell għoli. L-aktar għanijiet importanti tal-kwalità kellhom ikunu ġew deskritti fit-taqsima 1.2. (għanijiet tal-kwalità).

Kontenut

Din it-taqsima fiha r-rekwiżiti kollha rilevanti tal-kwalità.

L-aktar importanti minn dawn ir-rekwiżiti diġà ġew deskritti fit-taqsima 1.2. (għanijiet tal-kwalità), għalhekk għandhom jissemmew hawnhekk biss. F'din it-taqsima 10 għandek tiġbor ukoll rekwiżiti tal-kwalità b'importanza iżgħar, li ma joħolqux riskji kbar meta ma jintlaħqux bis-sħiħ (iżda jistgħu jkunu mixtieqa).

Motivazzjoni

Peress li r-rekwiżiti tal-kwalità se jkollhom ħafna influwenza fuq id-deċiżjonijiet arkitettoniċi għandek tkun taf liema kwalitajiet huma verament importanti għall-partijiet interessati tiegħek, b'mod speċifiku u li jista' jitkejjel.

Aktar Informazzjoni

Ara l-mudell estensiv tal-kwalità Q42 fuq https://quality.arc42.org.

10.1 Ħarsa ġenerali lejn ir-Rekwiżiti tal-Kwalità

Kontenut

Ħarsa ġenerali jew sommarju tar-rekwiżiti tal-kwalità.

Motivazzjoni

Spiss niltaqgħu ma' għexieren (jew saħansitra mijiet) ta' rekwiżiti dettaljati tal-kwalità. F'din it-taqsima ta' ħarsa ġenerali għandek tipprova tissommarja, eż. billi tiddeskrivi kategoriji jew suġġetti (kif jissuġġerixxu l-ISO 25010:2023 jew Q42

Jekk dawn id-deskrizzjonijiet sommarji huma diġà preċiżi, speċifiċi biżżejjed u li jistgħu jitkejlu, tista' taqbeż it-taqsima 10.2.

Forma

Uża tabella sempliċi li fiha kull linja fiha kategorija jew suġġett u deskrizzjoni qasira tar-rekwiżit tal-kwalità. Alternattivament, tista' tuża mindmap biex tistruttura dawn ir-rekwiżiti tal-kwalità.

Fil-letteratura, ġiet deskritta wkoll l-idea ta' siġra tal-attributi tal-kwalità, li tpoġġi t-terminu ġeneriku "kwalità" bħala l-għerq u tuża raffinar bħal siġra tat-terminu "kwalità". [Bass+21] introduċa t-terminu "Quality Attribute Utility Tree" għal dan l-għan.

10.2 Xenarji tal-Kwalità

Kontenut

Ix-xenarji tal-kwalità jagħmlu r-rekwiżiti tal-kwalità konkreti u jippermettu li jiġi deċiż jekk jintlaħqux (fis-sens ta' kriterji ta' aċċettazzjoni). Kun żgur li x-xenarji tiegħek huma speċifiċi u li jistgħu jitkejlu.

Żewġ tipi ta' xenarji huma partikolarment utli:

Ix-xenarji ta' użu (imsejħa wkoll xenarji tal-applikazzjoni jew xenarji ta' każijiet ta' użu) jiddeskrivu r-reazzjoni tas-sistema waqt ir-runtime għal ċertu stimolu. Dan jinkludi wkoll xenarji li jiddeskrivu l-effiċjenza jew il-prestazzjoni tas-sistema. Eżempju: Is-sistema tirreaġixxi għal talba ta' utent fi żmien sekonda.
Ix-xenarji ta' bidla jiddeskrivu l-effett mixtieq ta' modifika jew estensjoni tas- sistema jew tal-ambjent immedjat tagħha. Eżempju: Tiġi implimentata funzjonalità addizzjonali jew jinbidlu r-rekwiżiti għal attribut tal-kwalità, u jitkejjel l-isforz jew it-tul taż-żmien tal-bidla.

Forma

L-informazzjoni tipika għal xenarji dettaljati tinkludi dan li ġej:

Fil-forma qasira (ippreferuta fil-mudell Q42):

Kuntest/Sfond: X'tip ta' sistema jew komponent, x'inhu l-ambjent jew is-sitwazzjoni?
Sors/Stimolu: Min jew x'jibda jew iqanqal mgħiba, reazzjoni jew azzjoni.
Metrika/Kriterji ta' Aċċettazzjoni: Rispons li jinkludi miżura jew metrika

Il-forma twila tax-xenarji (ippreferuta mis-SEI u [Bass+21]) hija aktar dettaljata u tinkludi din l-informazzjoni:

ID tax-Xenarju: Identifikatur uniku għax-xenarju.
Isem tax-Xenarju: Isem qasir u deskrittiv għax-xenarju.
Sors: L-entità (utent, sistema, jew avveniment) li tibda x-xenarju.
Stimolu: L-avveniment jew il-kundizzjoni li qanqlet li s-sistema trid tindirizza.
Ambjent: Il-kuntest operattiv jew il-kundizzjoni li fiha s-sistema tesperjenza l-istimolu.
Artefatt: Il-blokok tal-bini jew elementi oħra tas-sistema affettwati mill-istimolu.
Rispons: ir-riżultat jew il-mgħiba li s-sistema turi b'reazzjoni għall-istimolu.
Miżura tar-Rispons: Il-kriterji jew il-metrika li biha jiġi evalwat ir-rispons tas-sistema.

Ara wkoll

Minn Jannar 2023, arc42 jipprovdi mudell pragmatiku tal-kwalità, li jipproponi li jiġu ttikkettati r-rekwiżiti tal-kwalità, b'hashtags jew tikketti bħal #flexible, #efficient, #usable, #operable, #testable, #secure, #safe, #reliable.

11. Riskji u Debitu Tekniku

Riskji tekniċi jew debitu tekniku magħrufin. X'problemi potenzjali jeżistu fi jew madwar is-sistema? Dwar xiex jinsab imdejjaq it-tim tal-iżvilupp?

Kontenut

Lista ta' riskji tekniċi jew debiti tekniċi identifikati, ordnati skont il-prijorità

Motivazzjoni

"Il-ġestjoni tar-riskju hija ġestjoni tal-proġetti għall-adulti" (Tim Lister, Atlantic Systems Guild.)

Dan għandu jkun il-motto tiegħek għall-iskoperta u l-evalwazzjoni sistematika tar-riskji u tad-debiti tekniċi fl-arkitettura, li se jkunu meħtieġa mill-partijiet interessati tal-maniġment (eż. maniġers tal-proġetti, sidien tal-prodott) bħala parti mill-analiżi ġenerali tar-riskji u l-ippjanar tal-miżuri.

Forma

Lista ta' riskji u/jew debiti tekniċi, probabbilment inklużi miżuri suġġeriti biex jitnaqqsu, jittaffew jew jiġu evitati riskji jew jitnaqqsu d-debiti tekniċi.