كاتب توثيق واجهة برمجة التطبيقات (API)
حوّل سلوك نقطة النهاية إلى توثيق واضح لواجهة برمجة التطبيقات يتضمن المصادقة، والمعلمات، والحمولات، والاستجابات، والأخطاء، والأمثلة، وتنبيهات التنفيذ.
البرومبت
استخدم المادة أدناه لإكمال **api documentation writer**. النتيجة المفيدة ليست نصيحة عامة؛ بل هي نتيجة جاهزة لاتخاذ القرار للاستعلام “api documentation writer prompt”. ## تفاصيل مهمة — كاتب توثيق واجهة برمجة التطبيقات (API) - [LANGUAGE] — لكاتب توثيق واجهة برمجة التطبيقات، قدم اللغة ذات الصلة. إذا كانت غير متوفرة، ضع علامة [LANGUAGE] `unknown`؛ لا تستنتجها أبداً. - [EXPECTED_BEHAVIOR] — لكاتب توثيق واجهة برمجة التطبيقات، قدم السلوك المتوقع ذو الصلة. إذا كان غير متوفر، ضع علامة [EXPECTED_BEHAVIOR] `unknown`؛ لا تستنتجه أبداً. - [REPRODUCTION_STEPS] — لكاتب توثيق واجهة برمجة التطبيقات، قدم خطوات إعادة الإنتاج ذات الصلة. إذا كانت غير متوفرة، ضع علامة [REPRODUCTION_STEPS] `unknown`؛ لا تستنتجها أبداً. - [CODE] — لكاتب توثيق واجهة برمجة التطبيقات، قدم الكود ذو الصلة. إذا كان غير متوفر، ضع علامة [CODE] `unknown`؛ لا تستنتجه أبداً. - [RUNTIME] — لكاتب توثيق واجهة برمجة التطبيقات، قدم بيئة التشغيل ذات الصلة. إذا كانت غير متوفرة، ضع علامة [RUNTIME] `unknown`؛ لا تستنتجها أبداً. - [ERROR_OUTPUT] — لكاتب توثيق واجهة برمجة التطبيقات، قدم مخرجات الخطأ ذات الصلة. إذا كانت غير متوفرة، ضع علامة [ERROR_OUTPUT] `unknown`؛ لا تستنتجها أبداً. - [REQUIRED_POINTS] — لكاتب توثيق واجهة برمجة التطبيقات، قدم النقاط المطلوبة ذات الصلة. إذا كانت غير متوفرة، ضع علامة [REQUIRED_POINTS] `unknown`؛ لا تستنتجها أبداً. - [REPOSITORY_CONTEXT] — لكاتب توثيق واجهة برمجة التطبيقات، قدم سياق المستودع ذو الصلة. إذا كان غير متوفر، ضع علامة [REPOSITORY_CONTEXT] `unknown`؛ لا تستنتجه أبداً. ## منهجية هذا العمل — كاتب توثيق واجهة برمجة التطبيقات (API) 1. ابدأ المسودة فقط بعد تحديد الجمهور، والغرض، والحقائق، والنبرة، والإجراء المطلوب. 2. قدم نسخة قابلة للنشر بالإضافة إلى مبررات موجزة للخيارات المهمة. 3. تتبع السلوك الملحوظ من خلال مسار الكود ذي الصلة قبل تعديل أي شيء. 4. قدم أصغر تصحيح يمكن الدفاع عنه، واختبارات الانحدار، وخطوات التحقق الدقيقة. 5. افصل السلوك المؤكد عن الفرضيات. 6. ضع في اعتبارك الحالات الاستثنائية، والأمان، والتوافق مع الإصدارات السابقة. 7. اعرض تغييراً بسيطاً قبل إعادة الهيكلة الاختيارية. 8. قم بتضمين اختبارات كانت ستفشل قبل التصحيح. 9. حدود كاتب توثيق واجهة برمجة التطبيقات: لا تبتكر واجهات برمجة تطبيقات، أو حزم، أو ملفات، أو سلوك بيئة تشغيل، أو مخرجات أوامر، أو نتائج اختبار ناجحة. ## مخرجات مفيدة — كاتب توثيق واجهة برمجة التطبيقات (API) - **النتائج التقنية لكاتب توثيق واجهة برمجة التطبيقات** — مدخلات المواد لكاتب توثيق واجهة برمجة التطبيقات، كل منها متصل بمطالبة api documentation writer. - **الأدلة أو إعادة الإنتاج لكاتب توثيق واجهة برمجة التطبيقات** — كاتب توثيق واجهة برمجة التطبيقات جاهز للاستخدام، منسق لمطالبة api documentation writer. - **تغيير بسيط لكاتب توثيق واجهة برمجة التطبيقات** — نقاط ضعف كاتب توثيق واجهة برمجة التطبيقات، والمجهولات، وحدود برومبت api documentation writer. - **تغطية الاختبار لكاتب توثيق واجهة برمجة التطبيقات** — برومبت api documentation writer ← تحقق من كاتب توثيق واجهة برمجة التطبيقات قبل الاستخدام. - **أمر التحقق لكاتب توثيق واجهة برمجة التطبيقات** — أدلة برومبت api documentation writer ← كاتب توثيق واجهة برمجة التطبيقات؛ احذف المقدمة. ## التحقق — كاتب توثيق واجهة برمجة التطبيقات (API) راجع كاتب توثيق واجهة برمجة التطبيقات النهائي مقابل الطلب الأصلي. إذا كان هناك مدخل أساسي مفقود، اذكر بالضبط كيف يحد ذلك من النتيجة.
كيفية استخدام هذا البرومبت
استبدل فقط الحقول الموجودة بين أقواس بما يتناسب مع وضعك. احتفظ بالمعلومات غير المعروفة مميزة كغير معروفة، والصق البرومبت المكتملة في مساعد AI قادر، وراجع النتيجة قبل استخدامها.
أفضل نموذج ذكاء اصطناعي
استخدم نموذج صور حديثًا يدعم التعليمات وسير العمل القائم على الصور المرجعية الموضح في البرومبت.
نصائح للحصول على نتائج أفضل
للحصول على نتيجة أفضل مع كاتب توثيق واجهة برمجة التطبيقات (API) برومبت، ثبّت الموضوع والتكوين أولاً ثم عدّل الإضاءة أو الألوان أو الخلفية تدريجياً.
الأسئلة الشائعة
ما الذي يحدده كاتب توثيق واجهة برمجة التطبيقات (API) برومبت؟
يحدد موضوع الصورة وتكوينها وأسلوبها البصري والعناصر التي ينبغي الحفاظ عليها.
كيف أستخدمه؟
الصق البرومبت كاملاً في أداة الصور، ثم جرّب تعديلاً واحداً على الإضاءة أو التكوين في كل مرة.

