Architecture Decision Record

Active theme: Light

← وثائق

اقتراحات لكتابة سجلات ADR جيدة

خصائص سجل ADR الجيد:

  • المبرّر (Rationale): اشرح أسباب اتخاذ قرار AD المعيّن. وقد يشمل ذلك السياق (انظر أدناه)، ومزايا الخيارات المحتملة المختلفة وعيوبها، ومقارنات الميزات، ومناقشات التكلفة والفائدة، وغير ذلك.

  • المحدَّد (Specific): ينبغي أن يتناول كل سجل ADR قرار AD واحدًا، لا عدة قرارات.

  • الطوابع الزمنية (Timestamps): بيّن متى كُتب كل عنصر في السجل. وهذا مهم خصوصًا للجوانب التي قد تتغير بمرور الوقت، مثل التكاليف والجداول الزمنية والتوسّع وما شابه.

  • غير القابل للتعديل (Immutable): لا تغيّر المعلومات الموجودة في السجل. بل عدِّل السجل بإضافة معلومات جديدة، أو استبدله بإنشاء سجل ADR جديد.

خصائص قسم «السياق» الجيد في سجل ADR:

  • اشرح وضع مؤسستك وأولوياتها التجارية.

  • ضمّن المبررات والاعتبارات المبنية على التركيبة الاجتماعية والمهارية لفرقك.

  • ضمّن المزايا والعيوب ذات الصلة، وصفها بعبارات تتوافق مع احتياجاتك وأهدافك.

خصائص قسم «العواقب» الجيد في سجل ADR:

  • اشرح ما يترتب على اتخاذ القرار. وقد يشمل ذلك الآثار والنتائج والمخرجات والمتابعات وغير ذلك.

  • ضمّن معلومات عن أي سجلات ADR لاحقة. من الشائع نسبيًا أن يستدعي سجل ADR واحد الحاجة إلى سجلات أخرى، كأن يتخذ سجل قرارًا عامًا كبيرًا ينشئ بدوره الحاجة إلى قرارات أصغر.

  • ضمّن أي عمليات مراجعة بعد التنفيذ. من المعتاد أن تراجع الفرق كل سجل ADR بعد شهر، لمقارنة معلومات السجل بما حدث فعليًا في الممارسة، بغرض التعلم والنمو.

يمكن لسجل ADR جديد أن يحلّ محل سجل سابق:

  • عندما يُتخذ قرار AD يستبدل سجل ADR سابقًا أو يُبطله، ينبغي إنشاء سجل ADR جديد