آرکیٹیکچر فیصلے کے ریکارڈ (ADR) کا سانچہ

یہ EdgeX Foundry ADR کا سانچہ ہے۔

ماخذ: https://docs.edgexfoundry.org/2.3/design/adr/template/

جمع کرانے والے

ADR جمع کرانے والوں کی فہرست دیں۔

شکل:

• نام (تنظیم)

تبدیلیوں کا لاگ

دستاویز کی تبدیلیوں کی فہرست دیں، بشمول حالت، تاریخ اور PR کا URL۔

حالت ان میں سے ایک ہے: pending, approved, amended, deprecated۔

تاریخ ISO 8601 (YYYY-MM-DD) اسٹرنگ ہے۔

PR وہ پل ریکوئسٹ ہے جس نے تبدیلی جمع کرائی، جس میں diff، معاونین اور جائزہ کاروں جیسی معلومات شامل ہیں۔

شکل:

• [ADR کی حالت، مثلاً approved, amended وغیرہ](پل ریکوئسٹ کا URL) YYYY-MM-DD

حوالہ دیے گئے استعمال کے کیسز

تمام متعلقہ استعمال کے کیس / تقاضوں کی دستاویزات کی فہرست دیں۔

ADR کے لیے کم از کم ایک متعلقہ، منظور شدہ استعمال کا کیس درکار ہے۔

شکل:

• [استعمال کے کیس کا نام](URL)

اگر ADR استعمال کے کیس کے تمام تقاضوں کو حل نہیں کرتا تو وضاحتیں شامل کریں۔

سیاق و سباق

بیان کریں:

• ڈیزائن آرکیٹیکچر کے لحاظ سے کیسے اہم ہے - جو ADR کا متقاضی ہے (بمقابلہ کسی مسئلے کو ٹھیک کرنے کے لیے سادہ issue اور PR)

• اعلیٰ سطح کا ڈیزائن کا طریقہ (تفصیلات نیچے تجویز کردہ ڈیزائن میں بیان کی گئی ہیں)

تجویز کردہ ڈیزائن

ڈیزائن کی تفصیلات (جہاں ممکن ہو نفاذ میں گئے بغیر)۔

خاکہ:

• متاثر ہونے والی (بدلی جانے والی) سروسز/ماڈیولز

• شامل کی جانے والی نئی سروسز/ماڈیولز

• ماڈل اور DTO پر اثر (تبدیلیاں/اضافے/حذف)

• API پر اثر (تبدیلیاں/اضافے/حذف)

• عمومی کنفیگریشن پر اثر (نئے حصوں کا قیام، تبدیلیاں/اضافے/حذف)

• devops پر اثر

غور و فکر کے نکات

ADR کی بحث میں اٹھنے والے متبادل، خدشات، ضمنی یا متعلقہ مسائل اور سوالات درج کریں۔

بتائیں کہ آیا اور کیسے وہ حل یا کم کیے گئے۔

فیصلہ

کوئی بھی متفقہ اہم نفاذی تفصیل، احتیاطیں، مستقبل کے غور و فکر کے نکات، باقی یا مؤخر شدہ ڈیزائن کے مسائل درج کریں۔

تقاضوں کا کوئی بھی حصہ جو تجویز کردہ ڈیزائن سے پورا نہیں ہوتا، درج کریں۔

دیگر متعلقہ ADR

کسی بھی متعلقہ ADR کی فہرست دیں - مثلاً کسی خصوصیت کے ذیلی جز کا ڈیزائن کا فیصلہ، اس ڈیزائن کے نتیجے میں متروک ہونے والا ڈیزائن وغیرہ۔

شکل:

• [ADR کا عنوان](URL) - مطابقت

حوالہ جات

اضافی حوالہ جات کی فہرست دیں۔

شکل:

• [عنوان](URL)