وثائق

سياق المشروع

ما تعرفه الوكلات عن مشروعك، وما لا يمكنها استنتاجه، وما يجب أن تخبرها به.

تقرأ الوكلات مستودع الكود الخاص بك؛ هذا يغطي معظم ما تحتاجه — لكن ليس القرارات التي توجد في أذهان الأشخاص، أو في صفحات الويكي، أو في محادثات منذ عامين.

سياق المشروع يجمع بين تعليمات المستودع والإرشادات التي تحفظها في Coroid.

تعليمات المستودع تُعد جزءًا من السياق أيضًا

Coroid تقرأ ملفات الذاكرة مثل الملفات الموجودة في المسار الجذري AGENTS.md، CLAUDE.md و GEMINI.md، بالإضافة إلى قواعد Cursor في .cursor/rules. المصادر المفعلة تُدرج ضمن سياق مشروع الوكيل قبل بدء العمل. إعدادات المستودع المحلي @ يمكنها استيراد ملفات تعليمات أخرى؛ يتم تضمين عمليات الاستيراد المتكررة والدورات وجسم التعليمات المكرر مرة واحدة فقط. لا حاجة لنسخ هذه التعليمات إلى إدخال سياق التطبيق.

في إعدادات ← معرفة ← سياق، مصادر المستودع تحدد الملفات التي تتلقاها الوكلات، بينما سياقات التطبيق تحتوي على ملاحظات يدوية وسياق تم إنشاؤه ويُخزن في Coroid. تكون المصادر مفعلة ما لم يتم تعطيلها صراحةً؛ قم بإيقاف التعليمات المتداخلة أو المتعارضة التي لا ترغب في دمجها.

تعليمات المستودع تتبع الكود في Git؛ أما سياقات التطبيق فهي مفيدة للإرشادات والمراجع التي تحفظها خارج المستودع. كلاهما يحتاج إلى صيانة عند تغيير أي اتفاقية. راجع إعدادات سياق المشروع لمعرفة المسارات المدعومة وطرق اكتشاف الملفات وضوابطها.

ما يمكن لـ Coroid استنتاجه بنفسها

من المستودع وحده، يمكن للوكالات رؤية:

  • اللغات والأطر والمكتبات المستخدمة
  • كيف يتم بناء المشروع واختباره وتشغيله
  • الأنماط الموجودة — كيف يتم التعامل مع الأخطاء، وكيف تُنظم الوحدات، وكيف تُسمى الأشياء
  • ما يعتمد على ما

لا حاجة لتوثيق أي من ذلك؛ إعادة صياغته تعد هدرًا للجهد وقد يؤدي إلى تضارب مع الكود، الذي يُعد المصدر الأكثر مصداقية على أي حال.

ما لا يمكنها استنتاجه

الكود يوضح ما قمت به، وليس لماذا:

  • اختيار مكتبة معينة بدلاً من بديل واضح لسبب لا يزال ساريًا
  • نمط يبدو كتكرار لكنه فصل مقصود في الكود
  • وحدة لا ينبغي لأحد التعديل عليها دون التحدث مع فريق معين
  • اتفاقيات تم الاتفاق عليها لكن لم يتم تطبيقها بعد في أي مكان
  • قيود خارج نطاق الكود — متطلبات الامتثال، العقود، عملية ترحيل جارية

هذا ما ينتمي إلى سياق المشروع. المعيار بسيط: هل يمكن لشخص ما العمل بناءً على قراءة المستودع فقط؟ إذا كان الجواب نعم، فتجاهله. وإذا كان لا، فاكتبه.

يعرض المستودع ما يلي

يقرأه الوكلاء في كل مهمة. لا داعي لإعادة ذكره.

  • لغات وأطر عمل ومكتبات
  • كيفية بنائها واختبارها وتشغيلها
  • الأنماط وعمليات التسمية الموجودة
  • ما يعتمد على ماذا

أنت تضيف السبب

يحتوي سياق المشروع على ما يوجد في أذهان الأشخاص.

  • لماذا تم اختيار مكتبة معينة بدلاً من بديل واضح؟
  • تكرار متعمد كنقطة اتصال
  • وحدات لا ينبغي لأحد المساس بها دون فريق محدد
  • اتفاقيات متفق عليها لم تُفرض بعد في أي مكان
  • قيود خارجية: الامتثال، العقود، عملية ترحيل جارية

الاختبار: هل يمكن لمن يقرأ المستودع فقط أن يحل هذه المسألة؟ إذا كان الجواب نعم، تجاهلها. وإلا، اكتبها.

تجاهل ما يعرضه المستودع بالفعل. اكتب ما لا يمكن لمن يقرأ المستودع فقط أن يستنتجه.

إضافة سياق

الصق الوثائق والسياسات والمراجع ضمن قسم سياق التابع للمشروع. ملاحظات الهندسة المعمارية، سجلات القرارات، دلائل الأسلوب، وعقود API كلها صالحة.

السياق الجيد يكون موجزًا ودقيقًا؛ دليل التوجيه البالغ 40 صفحة المكتوب للبشر هو في الغالب سرد؛ الفقرات الثلاث التي توضح القيود الحقيقية هي ما يهم. استخرج تلك الفقرات.

سياق كل مهمة

السياق المرتبط بالمشروع ينطبق على كل شيء؛ أما ما يتعلق بجزء معين من العمل — مثل تذكرة، أو مستند تصميم، أو تقرير عميل — فيتم إرفاقه بالمهمة بدلاً من ذلك.

احتفظ بسياق المشروع للحالات التي تظل صحيحة على المدى الطويل؛ فأي ملاحظة خاصة بمهمة معينة ضمن سياق المشروع تتحول إلى ضجيج في كل مهمة لاحقة.

الحفاظ على دقة السياق

السياق الذي فقد صلاحيته أسوأ من عدم وجود سياق، لأن الوكلات تعتبره مرجعًا موثوقًا؛ وعندما يتغير أحد المعايير، يجب تحديث السياق في نفس التغيير الذي يطال الكود.

إذا وجدت نفسك تصحح نفس الشيء مرارًا وتكرارًا في تعليقات إعادة العمل، فهذا مؤشر على وجود نقص في السياق أو أن جزءًا منه غير صحيح.