المرجع
لمحة سريعة
قسم بعنوان «لمحة سريعة»استخدم هذا القسم كنقطة دخول إلى المواد المرجعية: فهارس واجهات API، ومفاتيح التهيئة، وجداول التوافق، وسلوك CSS المدعوم، وسجلات التغطية على مستوى الحزم.
خريطة المراجع
قسم بعنوان «خريطة المراجع»| المرجع | ما الذي يجيب عنه |
|---|---|
| مصفوفة دعم CSS | ميزات CSS التي يتحقق منها مسار HTML أو يعلن عنها أو يدعمها جزئيًا أو لا يدعمها. |
| فهرس واجهة API لعمليات التكامل | صفحة واجهة API للامتداد، وتغطي كل إطار عمل ومُصيِّر وآلية نقل وسطح أداة بناء. |
| أقسام التكامل | الموضع الذي تجد فيه مرجع واجهة API والتهيئة لكل حزمة. |
| مرجع وحدة Core | صفحات واجهة API والبنية على مستوى الوحدة، والمُولَّدة من مستودع core. |
متطلبات مدخل المرجع
قسم بعنوان «متطلبات مدخل المرجع»يجب أن يجيب كل مدخل في واجهة API عن الأسئلة نفسها:
| السؤال | الإجابة المطلوبة |
|---|---|
| ماذا أستدعي؟ | رمز مؤهَّل بالكامل، أو نقطة نهاية، أو أمر واجهة سطر الأوامر (CLI)، أو مفتاح تهيئة. |
| ما المدخلات المقبولة؟ | جدول للمعاملات يوضح النوع، وحالة الإلزام، والقيمة الافتراضية، والقيم المقبولة. |
| ماذا يحدث افتراضيًا؟ | السلوك عند حذف المدخلات الاختيارية. |
| ما الذي يُرجَع؟ | نوع القيمة المُرجَعة، أو نص الاستجابة، أو ملف الإخراج، أو الدفق، أو الأثر الجانبي. |
| ما الذي قد يفشل؟ | استثناء، أو خطأ تحقق، أو حالة HTTP، أو نمط فشل تشغيلي. |
| كيف أستخدمه بأمان؟ | ملاحظات حول الأمان، وسلامة العامل (worker)، وحدود الحجم، والمسار، والمهلة الزمنية، والتعامل مع الأسرار. |
سياسة التغطية
قسم بعنوان «سياسة التغطية»صفحات المرجع مستندة إلى المصدر. تُوثَّق واجهات API العامة اعتمادًا على مصدر الحزمة وملفات التهيئة والاختبارات والأمثلة. لا تُوثَّق الفئات المساعِدة الداخلية إلا عندما يحتاج مطورو التطبيقات إلى فهم سلوكها لتهيئة الحزمة أو تشغيلها.
جاهزية الترجمة
قسم بعنوان «جاهزية الترجمة»تُفضِّل صفحات المرجع الجداول بدلًا من الفقرات الكثيفة. ينبغي أن يكون كل صف مستقلًا بذاته، لأن تجزئة تنسيق ملف تبادل التوطين القابل للتوسعة (XLIFF) لاحقًا ستقسم المحتوى بحسب الكتلة.