قالب سجل قرار البنية المعمارية (ADR)

هذا قالب لسجلات ADR في EdgeX Foundry.

المصدر: https://docs.edgexfoundry.org/2.3/design/adr/template/

مقدّمو السجل

اذكر مقدّمي السجل.

الصيغة:

• الاسم (المؤسسة)

سجل التغييرات

اذكر التغييرات على الوثيقة، بما في ذلك الحالة والتاريخ ورابط طلب الدمج (PR).

الحالة إحدى القيم: pending (قيد الانتظار)، approved (معتمد)، amended (معدَّل)، deprecated (مهجور).

التاريخ سلسلة بصيغة ISO 8601 ‏(YYYY-MM-DD).

طلب الدمج هو الطلب الذي قدّم التغيير، ويتضمن معلومات مثل الفروق والمساهمين والمراجعين.

الصيغة:

• [حالة السجل مثل approved أو amended وغيرهما](رابط طلب الدمج) YYYY-MM-DD

حالات الاستخدام المشار إليها

اذكر كل وثائق حالات الاستخدام / المتطلبات ذات الصلة.

يتطلب السجل حالة استخدام واحدة على الأقل ذات صلة ومعتمدة.

الصيغة:

• [اسم حالة الاستخدام](الرابط)

أضف توضيحات إذا كان السجل لا يعالج كل متطلبات حالة الاستخدام.

السياق

صِف:

• كيف أن التصميم ذو أثر معماري، مما يستدعي سجل ADR (مقابل مجرد مسألة وطلب دمج لإصلاح مشكلة)

• نهج التصميم رفيع المستوى (التفاصيل موصوفة في التصميم المقترح أدناه)

التصميم المقترح

تفاصيل التصميم (دون الخوض في التنفيذ قدر الإمكان).

المخطط:

• الخدمات/الوحدات التي ستتأثر (تتغير)

• الخدمات/الوحدات الجديدة التي ستُضاف

• الأثر في النموذج وكائنات DTO (تغييرات/إضافات/حذف)

• الأثر في الواجهات البرمجية (تغييرات/إضافات/حذف)

• الأثر في الإعدادات العامة (إنشاء أقسام جديدة، تغييرات/إضافات/حذف)

• الأثر في devops

الاعتبارات

وثّق البدائل والمخاوف والمسائل الجانبية أو ذات الصلة والأسئلة التي نشأت في نقاش السجل.

بيّن هل حُلّت أو خُفِّفت وكيف.

القرار

وثّق أي تفاصيل تنفيذ مهمة متفق عليها، والتحفظات، والاعتبارات المستقبلية، ومسائل التصميم المتبقية أو المؤجلة.

وثّق أي جزء من المتطلبات لم يلبّه التصميم المقترح.

سجلات ADR أخرى ذات صلة

اذكر أي سجلات ADR ذات صلة، مثل قرار تصميم لمكوّن فرعي من ميزة، أو تصميم أصبح مهجورًا نتيجة هذا التصميم، وهكذا.

الصيغة:

• [عنوان السجل](الرابط) - الصلة

المراجع

اذكر مراجع إضافية.

الصيغة:

• [العنوان](الرابط)