Architecture Decision Record
← Teimpléid taifead cinntí

Teimpléad taifid chinnidh ailtireachta (ADR)

Is teimpléad é seo do ADR EdgeX Foundry.

Foinse: https://docs.edgexfoundry.org/2.3/design/adr/template/

Aighneoirí

Liostaigh aighneoirí an ADR.

Formáid:

  • Ainm (Eagraíocht)

Logchomhad Athruithe

Liostaigh na hathruithe ar an doiciméad, lena n-áirítear staid, dáta, agus URL an iarratais tarraingthe (PR).

Tá an staid ar cheann de: pending (ar feitheamh), approved (formheasta), amended (leasaithe), deprecated (imithe i léig).

Is teaghrán ISO 8601 (YYYY-MM-DD) é an dáta.

Is é an PR an t-iarratas tarraingthe a chuir an t-athrú isteach, lena n-áirítear faisnéis amhail an difríocht (diff), rannpháirtithe, agus athbhreithneoirí.

Formáid:

  • [Staid an ADR m.sh. approved, amended, srl.](URL an iarratais tarraingthe) YYYY-MM-DD

Cásanna Úsáide Tagartha

Liostaigh gach doiciméad cáis úsáide / riachtanas ábhartha.

Teastaíonn ar a laghad cás úsáide ábhartha formheasta amháin ón ADR.

Formáid:

  • [Ainm an Cháis Úsáide](URL)

Cuir mínithe leis mura dtugann an ADR aghaidh ar riachtanais uile cháis úsáide.

Comhthéacs

Déan cur síos ar:

  • conas atá an dearadh suntasach ó thaobh na hailtireachta de - rud a thugann údar le ADR (seachas saincheist shimplí agus PR chun fadhb a réiteach)

  • an cur chuige dearaidh ardleibhéil (tá mionsonraí le fáil sa dearadh molta thíos)

Dearadh Molta

Mionsonraí an dearaidh (gan dul isteach i gcur chun feidhme nuair is féidir).

Imlíne:

  • seirbhísí/modúil a mbeidh tionchar orthu (athraithe)

  • seirbhísí/modúil nua le cur leis

  • tionchar ar mhúnla agus DTO (athruithe/breiseanna/baintí)

  • tionchar ar API (athruithe/breiseanna/baintí)

  • tionchar ar chumraíocht ghinearálta (rannóga nua a bhunú, athruithe/breiseanna/baintí)

  • tionchar ar devops

Breithnithe

Doiciméadaigh roghanna eile, ábhair imní, saincheisteanna cúnta nó gaolmhara, ceisteanna a d'eascair i ndíospóireacht an ADR.

Léirigh an ndearnadh iad a réiteach nó a mhaolú, agus conas.

Cinneadh

Doiciméadaigh aon mhionsonra tábhachtach cur chun feidhme comhaontaithe, fógraí rabhaidh, breithnithe sa todhchaí, saincheisteanna dearaidh atá fágtha nó curtha siar.

Doiciméadaigh aon chuid de na riachtanais nach gcomhlíonann an dearadh molta.

ADR Gaolmhara Eile

Liostaigh aon ADR ábhartha - amhail cinneadh dearaidh d'fho-chomhpháirt de ghné, dearadh a cuireadh i léig mar thoradh ar an dearadh seo, srl.

Formáid:

  • [Teideal an ADR](URL) - Ábharthacht

Tagairtí

Liostaigh tagairtí breise.

Formáid:

  • [Teideal](URL)