المشكلة التقنية أو المخرج

هذه المهمة مخصصة لـ«كتابة أمثلة API» داخل البرمجة / التوثيق. جوهرها: حدد الوظيفة التي يجب أن يؤديها نص أمثلة API لدى القارئ.

بيئة التنفيذ والسياق

• المعلومة التي يجب أن ينقلها أمثلة API
• الجمهور الذي سيقرأ النص
• الهدف من النص
• الحقائق والأسماء والأرقام التي يجب الحفاظ عليها
• النبرة والطول أو المنصة
• العقد
• المسارات

الطلب التقني

نفّذ مهمة «كتابة أمثلة API» تقنيا ضمن البرمجة / التوثيق اعتمادا على السياق الفعلي الذي سأقدمه. السياق التقني: - [المعلومة التي يجب أن ينقلها أمثلة API] - [الجمهور الذي سيقرأ النص] - [الهدف من النص] - [الحقائق والأسماء والأرقام التي يجب الحفاظ عليها] - [النبرة والطول أو المنصة] - [العقد] - [المسارات] طريقة التنفيذ والفحص: 1. حدد الوظيفة التي يجب أن يؤديها نص أمثلة API لدى القارئ. 2. رتب معلومات أمثلة API بحسب ما يحتاجه القارئ لاتخاذ الإجراء أو فهم الفكرة. 3. اكتب أمثلة API كنسخة أولى ثم احذف ما لا يخدم وظيفته المحددة. 4. راجع لغة أمثلة API ونبرته وحقائقه قبل التسليم. 5. ثبت contract قبل تفاصيل التنفيذ. 6. استخدم status codes وهيكل أخطاء متسق. المخرجات المقبولة: - نسخة نهائية من أمثلة API. - صياغة متوافقة مع الجمهور والهدف. - عقد API أو تنفيذ متوافق. حافظ على حدود «كتابة أمثلة API»: لا تحوّل الناتج إلى «تحويل كود إلى وثائق»؛ استخدم عناصر المهمة المجاورة فقط عندما تكون مدخلا ضروريا لهذه المهمة. شرط القبول: هل يؤدي أمثلة API الغرض المطلوب من دون معلومات زائدة أو ناقصة؟

ما يجب تسليمه

• نسخة نهائية من أمثلة API
• صياغة متوافقة مع الجمهور والهدف
• عقد API أو تنفيذ متوافق

معيار قبول الحل

• هل يؤدي أمثلة API الغرض المطلوب من دون معلومات زائدة أو ناقصة؟
• هل يستطيع عميل آخر التكامل من التوثيق وحده؟