مركز المساعدة · الفهم

كيف أشرح أعرافي الداخلية للوكلاء؟

اكتب ما يحتاج زميل جديد أن يُشرح له، لتعرفه كل عملية تشغيل.

تتيح لك خط الأنابيب ← سياقاتي أن تكتب، بنص حر، ما لا يستطيع الوكلاء تخمينه: مكتبتك الداخلية، وأعراف التسمية لديك، ومزالق شيفرتك. تدخل هذه النصوص في كل عملية تشغيل، إضافةً إلى قواعد التقنية.

ما الذي يستحق أن يُكتب هناك؟

أبسط اختبار: ماذا كنت ستشرح لمطوّر كفء يلتحق بالمشروع يوم الاثنين؟ هذا بالضبط ما يحتاجه الوكلاء.

ما ينفع فعلًا:

• «كل نداءات واجهتنا البرمجية تمرّ عبر ApiClient، لا عبر fetch مباشرةً.»
• «نصوص المستخدم تعيش في lang/، ولا تُكتب داخل العرض أبدًا.»
• «وحدة الفواتير قيد إعادة الكتابة: لا تلمسها دون إخبارنا.»

وما لا ينفع: تكرار أعراف إطار العمل. يعرفها Diavi أصلًا، وهي ما تدفع ثمنه.

لماذا توجد عدة تبويبات؟

لأن سياق React لا شأن له بعملية Python. لكل تقنية سياقها، وثمة تبويب مشترك يستقبل ما لا يتعلق بالتقنية: أعراف المراجعة لديكم، أو طريقتكم في كتابة التذاكر.

تُحمّل العملية التبويب المشترك مع تبويب تقنيتها، لا غيرهما.

هل هناك حدّ للحجم؟

نعم، 40000 حرف لما تُحمّله العملية فعليًا — المشترك مع تقنية واحدة. وهذا ليس اعتباطًا: يُرسَل هذا النص في كل نداء ضمن العملية، فينعكس حجمه مباشرةً في استهلاكك. ترفض الواجهة الحفظ فوق ذلك بدل الاقتطاع الصامت.

من يستطيع تعديلها؟

مالك الحساب والمسؤولون. يدخل السياق في كل موجّه: فهو رافعة كلفة، لا إعداد راحة.

هل أرى قواعد الناشر؟

لا. قواعد كل تقنية هي خبرة Diavi وتبقى خاصة. سياقاتك تُضاف إليها؛ ولا تحلّ محلها أبدًا، وتظل تستفيد من تحديثاتها.