Skip to content
Apothem
أوامر خط الأنابيب

/plan-design

‎/plan-design — يُنتِج أثرًا شاملًا للتصميم المعماري عند <bdi>`_inputs/design.md`</bdi>.

الدور: المعماري الموضع في خط الأنابيب: شَرطي، بعد المراجعة وقبل التنفيذ

يُنتِج أثر التصميم المعماري عند _inputs/design.md عندما تحوي حزمة الخطّة عملًا حاملًا للمعمارية. وهو شَرطي عن قصد: فحزمة النثر أو التوثيق أو البيانات الوصفية أو التجهيزات الضيّقة تنتقل من /plan-review مباشرةً إلى /plan-execute؛ أمّا الحزمة التي تُغيِّر المكوّنات أو الواجهات أو المخطّطات أو تدفّق البيانات أو المُحوِّلات أو طوبولوجيا الإصدار أو حدود الأمان أو سلوك التشغيل فتمرّ عبر /plan-design أولًا.

الاستدعاء القانوني

/plan-design path/to/plan-suite/

مع وسائط:

/plan-design [path/to/plan-suite/] [--refine-existing] [--dry-run]

المُدخَلات

حزمة خطّة مُراجَعة + _spec/spec.md + _inputs/handoff-manifest.yml

  • بطاقات نتائج مراجعة PASS من /plan-review.

المُخرَجات

_inputs/design.md إضافةً إلى _inputs/handoff-manifest.yml مُعزَّز يحمل مسار أثر التصميم، ونتيجة بوابة التصميم، ونتيجة التغطية على سبعة محاور، وملخّص مصفوفة الربط ثنائية الاتجاه.

بوابة القابلية للتطبيق

شغِّل /plan-design عندما يُعلِن أو يضمر طورٌ تالٍ واحد على الأقل ما يلي:

  • تغييرات في تخطيط المصدر أو حدّ الحزمة أو حدّ المُحوِّل أو حدّ الوحدة.
  • واجهات عامة أو بروتوكولات أو مخطّطات أو عقود تهيئة أو سلوك CLI.
  • تدفّق بيانات عبر المكوّنات أو ترتيب دورة الحياة أو انتقالات الحالة أو حواف الاعتماد.
  • معمارية الأمان أو الأداء أو التزامن أو القابلية للرصد أو النشر أو الإصدار أو سلسلة التوريد.
  • تمريرة /architecture-review لاحقة يجب أن تتبّع التنفيذ رجوعًا إلى أثر تصميم.

تخطَّ /plan-design عندما تقتصر الحزمة على تحريرات نصّية أو تحديثات لجرد مُولَّد أو تحديثات تجهيزات ضيّقة أو إصلاحات توثيق لمرّة واحدة أو عملٍ آخر يمكن التحقّق من تنفيذه دون سطح تتبّع معماري. ومسار التخطّي صريح: يُسجِّل /plan-review التصنيف غير المعماري، ثم يتابع /plan-execute من حزمة الخطّة المُراجَعة.

المصبّ

يستهلك /plan-execute أثر التصميم للأطوار الحاملة للمعمارية. ويستهلك /architecture-review الأثر نفسه أثناء سلسلة مراجعة التدقيق. وإن كان _inputs/design.md غائبًا عن عملٍ حاملٍ للمعمارية، توقّفت مراجعة المعمارية وأعادت توجيه الحزمة عبر /plan-design.

أطوار سير العمل

يتّبع الأمر ستة أطوار تحويلية خاصة بالمعمارية:

  1. ابتلاع المُدخَلات — يقرأ الحزمة المُراجَعة وبطاقات النتائج ومُخرَجات الأطوار وبيان التسليم؛ ويحجب عند دليل مراجعة مفقود أو فاشل في SHARED+.
  2. التفكيك المعماري — يجوب المعمارية والتزامن والأداء والأمان والاختبار وTooling والقابلية للرصد؛ ويُحدِّد المكوّنات والحواف والأسئلة المعمارية المفتوحة.
  3. تصميم واجهة المكوّنات — يُعرِّف الواجهات العامة وعقود البروتوكولات والمخطّطات والثوابت وأنماط الإخفاق وحدود عكس الاعتماد.
  4. التصديق على الروابط بين المكوّنات — يُغلِق كلّ حافة منبع ومصبّ وشقيقة ومعيار ومرساة؛ ويُصدِر مصفوفة ربط ثنائية الاتجاه عندما يعبر بيان المكوّنات عتبة المصفوفة.
  5. إصدار أثر التصميم — يكتب _inputs/design.md مع أقسام المكوّنات والمخطّطات وسجلّات القرارات ونتيجة التحقّق والروابط.
  6. بوابة التحقّق من التصميم — يُشغِّل بوابة ما قبل الإصدار ذات الخمسة عشر قضيبًا؛ ولا يُحدِّث _inputs/handoff-manifest.yml إلّا بعد اجتياز التصميم.

شكل أثر التصميم

يحتوي _inputs/design.md المُصدَر على:

  • ملخّص تنفيذي يحوي عدد المكوّنات والتغطية على سبعة محاور.
  • قسم واحد لكلّ مكوّن رئيسي، مُرتَّب من أسطح المجال الداخلية إلى المُحوِّلات وأسطح المُشغِّل الخارجية.
  • مخطّطات Mermaid للمعمارية أو التسلسل أو الحالة أو الاعتماد حيث يكون الهيكل غامضًا لولا ذلك.
  • سجلّات قرارات معمارية مُستقِرّة مع البدائل والمفاضلات وملاحظات القابلية للعكس.
  • نتيجة بوابة التحقّق ومصفوفة الربط ثنائية الاتجاه عند الاقتضاء.
  • روابط الأثر نفسه الخماسية الاتجاه نحو أسطح التخطيط في المنبع والمصبّ.

أنماط الإخفاق

العَرَضالسببالتعافي
متطلّب مُسبَق ناقصطور مُعتمَد عليه غير مكتملأكمِل الطور المنبعي أولًا
بوابة الجودة FAILالمُخرَج لا يفي بالمعاييرأصلِح المُخرَج وأعِد التشغيل
الحزمة المُراجَعة مفقودةحزمة الخطّة أو بطاقات المراجعة غائبةشغِّل /plan-generate ثم /plan-review
حزمة غير معماريةلا طور يحتاج سطح تتبّع معماريسجِّل التخطّي وتابِع إلى /plan-execute
مراجعة المعمارية تحجب_inputs/design.md غائب عن تنفيذ حامل للمعماريةشغِّل /plan-design ثم أعِد تشغيل /architecture-review

أمثلة

# Dry-run to preview applicability, component count, and open questions
/plan-design --dry-run

# Emit design for a named architecture-bearing suite
/plan-design path/to/plan-suite/

إحالات متقاطعة

On this page