Architecture Decision Record

Active theme: Light

← முடிவு பதிவு வார்ப்புருக்கள்

கட்டமைப்பு முடிவு பதிவு (ADR) வார்ப்புரு

இது EdgeX Foundry ADR க்கான வார்ப்புரு.

மூலம்: https://docs.edgexfoundry.org/2.3/design/adr/template/

சமர்ப்பிப்பவர்கள்

ADR சமர்ப்பிப்பவர்களைப் பட்டியலிடுங்கள்.

வடிவம்:

  • பெயர் (நிறுவனம்)

மாற்றப் பதிவு

நிலை, தேதி, PR URL உட்பட ஆவணத்தில் செய்யப்பட்ட மாற்றங்களைப் பட்டியலிடுங்கள்.

நிலை இவற்றில் ஒன்று: நிலுவை, அங்கீகரிக்கப்பட்டது, திருத்தப்பட்டது, நிறுத்தப்பட்டது.

தேதி ஒரு ISO 8601 (YYYY-MM-DD) சரம்.

PR என்பது மாற்றத்தைச் சமர்ப்பித்த pull request, இதில் diff, பங்களிப்பாளர்கள், மதிப்பாய்வாளர்கள் போன்ற தகவல் அடங்கும்.

வடிவம்:

  • [ADR இன் நிலை எ.கா. அங்கீகரிக்கப்பட்டது, திருத்தப்பட்டது போன்றவை](pull request இன் URL) YYYY-MM-DD

குறிப்பிடப்பட்ட பயன்பாட்டு நிகழ்வுகள்

தொடர்புடைய அனைத்துப் பயன்பாட்டு நிகழ்வு / தேவை ஆவணங்களையும் பட்டியலிடுங்கள்.

ADR க்குக் குறைந்தபட்சம் ஒரு தொடர்புடைய, அங்கீகரிக்கப்பட்ட பயன்பாட்டு நிகழ்வு தேவை.

வடிவம்:

  • [பயன்பாட்டு நிகழ்வின் பெயர்](URL)

ADR ஒரு பயன்பாட்டு நிகழ்வின் அனைத்துத் தேவைகளையும் நிறைவேற்றவில்லை என்றால் விளக்கங்களைச் சேர்க்கவும்.

சூழல்

விவரியுங்கள்:

  • வடிவமைப்பு கட்டமைப்பு ரீதியாக எவ்வாறு முக்கியமானது - ADR ஐ நியாயப்படுத்துவது (ஒரு சிக்கலைச் சரிசெய்ய எளிய issue மற்றும் PR க்கு எதிராக)

  • உயர்நிலை வடிவமைப்பு அணுகுமுறை (விவரங்கள் கீழே முன்மொழியப்பட்ட வடிவமைப்பில் விவரிக்கப்பட்டுள்ளன)

முன்மொழியப்பட்ட வடிவமைப்பு

வடிவமைப்பின் விவரங்கள் (முடிந்தவரை நடைமுறைப்படுத்தலுக்குள் செல்லாமல்).

வரையறை:

  • பாதிக்கப்படும் (மாற்றப்படும்) சேவைகள்/தொகுதிகள்

  • சேர்க்கப்பட வேண்டிய புதிய சேவைகள்/தொகுதிகள்

  • மாதிரி மற்றும் DTO தாக்கம் (மாற்றங்கள்/சேர்த்தல்கள்/நீக்கங்கள்)

  • API தாக்கம் (மாற்றங்கள்/சேர்த்தல்கள்/நீக்கங்கள்)

  • பொது உள்ளமைவுத் தாக்கம் (புதிய பிரிவுகளை நிறுவுதல், மாற்றங்கள்/சேர்த்தல்கள்/நீக்கங்கள்)

  • devops தாக்கம்

பரிசீலனைகள்

ADR விவாதத்தில் எழுந்த மாற்றுகள், கவலைகள், துணை அல்லது தொடர்புடைய சிக்கல்கள், கேள்விகளை ஆவணப்படுத்துங்கள்.

அவை தீர்க்கப்பட்டனவா அல்லது தணிக்கப்பட்டனவா, எவ்வாறு என்பதைக் குறிப்பிடுங்கள்.

முடிவு

ஒப்புக்கொள்ளப்பட்ட முக்கிய நடைமுறைப்படுத்தல் விவரம், எச்சரிக்கைகள், எதிர்காலப் பரிசீலனைகள், மீதமுள்ள அல்லது ஒத்திவைக்கப்பட்ட வடிவமைப்புச் சிக்கல்களை ஆவணப்படுத்துங்கள்.

முன்மொழியப்பட்ட வடிவமைப்பால் நிறைவேற்றப்படாத தேவைகளின் எந்தப் பகுதியையும் ஆவணப்படுத்துங்கள்.

பிற தொடர்புடைய ADR கள்

ஒரு அம்சத்தின் துணைக் கூறுக்கான வடிவமைப்பு முடிவு, இந்த வடிவமைப்பின் விளைவாக நிறுத்தப்பட்ட வடிவமைப்பு போன்ற தொடர்புடைய ADR களைப் பட்டியலிடுங்கள்.

வடிவம்:

  • [ADR தலைப்பு](URL) - தொடர்பு

குறிப்புகள்

கூடுதல் குறிப்புகளைப் பட்டியலிடுங்கள்.

வடிவம்:

  • [தலைப்பு](URL)