الدرس ٢ من ٦٧ دقائق للقراءة
قراءة تعليقات الكود والتوثيق التقني
قراءة توثيق API وسجلات التغيير وStack Overflow
المطورون يقضون وقتاً كبيراً في قراءة التوثيق. فهم بنية ومفردات المستندات الإنجليزية يجعلك أسرع وأكثر فعالية.
بنية توثيق API
| القسم | الغرض | عبارات رئيسية |
|---|---|---|
| Overview (نظرة عامة) | ماذا يفعل الـ API | "This API allows you to..." |
| Authentication (المصادقة) | كيف تتصادق | "Bearer token required" |
| Endpoints (نقاط النهاية) | العمليات المتاحة | "GET /users — Returns a list" |
| Parameters (المعاملات) | قيم الإدخال | "Required: id", "Optional: limit" |
| Error codes (رموز الخطأ) | ما يمكن أن يخطئ | "٤٠٠: Bad Request" |
قراءة رموز حالة HTTP
| الرمز | المعنى | ترجمة المطور |
|---|---|---|
| ٢٠٠ | نجاح | طلبك نجح |
| ٤٠٠ | طلب خاطئ | تحقق من المعاملات |
| ٤٠١ | غير مصرّح | تحقق من مفتاح API |
| ٤٠٤ | غير موجود | تحقق من العنوان/المعرف |
| ٤٢٩ | طلبات كثيرة | أبطئ طلباتك |
| ٥٠٠ | خطأ في الخادم | ليس خطأك، حاول مرة أخرى |
مفردات سجل التغيير
- Added (أُضيف): ميزات جديدة
- Changed (تغيّر): سلوك معدّل
- Deprecated (مُوقف): لا يزال يعمل لكن سيُزال
- Fixed (أُصلح): إصلاح أخطاء
- Breaking Changes (تغييرات جذرية): يجب تحديث كودك
مهارات قراءة Stack Overflow
تحديد الإجابات الجيدة
- ✓ لديها علامة خضراء (إجابة مقبولة)
- ✓ عدد أصوات عالٍ
- ✓ تتضمن أمثلة كود
- ✓ حديثة (تحقق من التاريخ!)
عبارات Stack Overflow الشائعة
| العبارة | المعنى |
|---|---|
| "This is an XY problem" | تسأل عن حلك المحاول وليس مشكلتك الفعلية |
| "Possible duplicate" | سؤالك أُجيب عليه بالفعل في مكان آخر |
| "Works for me" | لا يستطيع تكرار المشكلة |
| "Minimal reproducible example" | شارك أصغر كود يُظهر الخطأ |