Architecture Decision Recordقالب رکورد تصمیم معماری (ADR)
این قالبی برای ADR مربوط به EdgeX Foundry است.
منبع: https://docs.edgexfoundry.org/2.3/design/adr/template/
ارائه‌دهندگان
ارائه‌دهندگان ADR را فهرست کنید.
قالب:
- نام (سازمان)
گزارش تغییرات
تغییرات سند را فهرست کنید، شامل وضعیت، تاریخ و نشانی PR.
وضعیت یکی از این‌هاست: در انتظار (pending)، تأییدشده (approved)، اصلاح‌شده (amended)، منسوخ (deprecated).
تاریخ یک رشتهٔ ISO 8601 (YYYY-MM-DD) است.
PR درخواست ادغامی است که تغییر را ارائه کرده است، شامل اطلاعاتی مانند تفاوت‌ها (diff)، مشارکت‌کنندگان و بازبینان.
قالب:
- [وضعیت ADR مثلاً approved، amended و غیره](نشانی درخواست ادغام) YYYY-MM-DD
موارد استفادهٔ ارجاع‌شده
همهٔ اسناد مرتبط موارد استفاده / نیازمندی‌ها را فهرست کنید.
ADR دست‌کم به یک مورد استفادهٔ مرتبط و تأییدشده نیاز دارد.
قالب:
- [نام مورد استفاده](URL)
اگر ADR همهٔ نیازمندی‌های یک مورد استفاده را پوشش نمی‌دهد، توضیحاتی اضافه کنید.
زمینه
توضیح دهید:
طراحی از نظر معماری چگونه مهم است — به‌گونه‌ای که ADR را توجیه کند (در مقابل یک issue و PR ساده برای رفع یک مشکل)
رویکرد طراحی در سطح بالا (جزئیات در طراحی پیشنهادی زیر شرح داده می‌شود)
طراحی پیشنهادی
جزئیات طراحی (تا حد امکان بدون ورود به پیاده‌سازی).
رئوس مطلب:
سرویس‌ها/ماژول‌هایی که تحت تأثیر قرار می‌گیرند (تغییر می‌کنند)
سرویس‌ها/ماژول‌های جدیدی که افزوده می‌شوند
تأثیر بر مدل و DTO (تغییرات/افزودن‌ها/حذف‌ها)
تأثیر بر API (تغییرات/افزودن‌ها/حذف‌ها)
تأثیر بر پیکربندی عمومی (ایجاد بخش‌های جدید، تغییرات/افزودن‌ها/حذف‌ها)
تأثیر بر devops
ملاحظات
جایگزین‌ها، نگرانی‌ها، مسائل جانبی یا مرتبط و پرسش‌هایی را که در بحث ADR مطرح شد ثبت کنید.
مشخص کنید که چگونه و آیا حل یا تعدیل شدند.
تصمیم
هر جزئیات مهم پیاده‌سازی که بر سر آن توافق شده، هشدارها، ملاحظات آینده، و مسائل طراحی باقی‌مانده یا به تعویق افتاده را ثبت کنید.
هر بخشی از نیازمندی‌ها را که طراحی پیشنهادی برآورده نمی‌کند ثبت کنید.
سایر ADRهای مرتبط
هر ADR مرتبط را فهرست کنید — مانند تصمیم طراحی برای یک زیرمؤلفهٔ یک قابلیت، طراحی‌ای که در نتیجهٔ این طراحی منسوخ شده است و غیره.
قالب:
- [عنوان ADR](URL) - ارتباط
ارجاع‌ها
ارجاع‌های اضافی را فهرست کنید.
قالب:
- [عنوان](URL)