Skip to content

DESIGN.md

هذا الملف هو نقطة دخول التصميم. أبقِه موجزًا واستخدمه للتوجيه نحو الملفات الأكثر تفصيلًا تحت docs/design-docs/.

الغرض

تسجيل قرارات تصميم المنتج والنظام الدائمة التي يجب أن تبقى بعد محادثة واحدة أو سباق تطوير واحد أو ذاكرة مراجع واحدة.

اقرأ هذا عندما

  • تحتاج إلى فلسفة التصميم الحالية
  • أنت على وشك تقديم نمط جديد
  • تحتاج إلى معرفة قرارات التصميم المُستقرة مقابل تلك التي لا تزال مفتوحة

وثائق التصميم المعتمدة

  • docs/design-docs/index.md: فهرس الوثائق المقبولة والمقترحة والمُهمَلة
  • docs/design-docs/core-beliefs.md: معتقدات المشروع الموجهة للوكلاء أولًا

قواعد التصميم

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