مقدمة
البرنامج التعليمي التفاعلي هو برنامج تعليمي تفاعلي مكتوب باستخدام بنية Markdown. ننشر دروسنا التطبيقية حول الترميز على blocklycodelabs.dev. وتستخدم هذه الدروس مزيجًا من اللغة الطبيعية وعيّنات الرموز البرمجية ولقطات الشاشة لتقديم تجربة تعليمية أكثر إثارة للاهتمام. يجب أن يتابع المستخدم المستهدف في كتاب الترميز ويشغّل الرمز أثناء القراءة.
تُعدّ كتابة درس برمجة طريقة رائعة للمساهمة في المنتدى. إنّها طريقة لمشاركة معلوماتك وتسهيل حياة المطوّر التالي الذي يواجه المشكلة نفسها.
ما الذي يجعل تجربة كتابة الرموز البرمجية رائعة؟
يجب أن يكون الدرس التطبيقي العملي رائعًا ومركّزًا وسهل القراءة. ويوضّح للمستخدمين ما سيبنونه وما سيتعلّمونه، كما يرشدهم إلى كيفية كتابة التعليمات البرمجية وفهمها لإكمال مهمة معيّنة.
العملية
إذا كانت لديك فكرة بشأن codelab، يمكنك إخبارنا بها من خلال تقديم طلب ميزة في مستودع blockly-samples. أدرِج وصفًا لما تريد تعليمه وما ستنشئه في تجربة البرمجة. سنناقش الفكرة ونحسّنها. بعد ذلك، يمكنك كتابة الرمز وإرسال طلب سحب له. بعد أن يخضع للمراجعة، سينشره أحد أعضاء فريق Blockly.
نصائح الكتابة
يتضمّن الجزء المتبقي من هذه الصفحة مجموعة من النصائح والأسئلة لإرشادك خلال عملية كتابة تجربة برمجية.
يمكنك الاطّلاع على Technical Writing One للحصول على مقدّمة سريعة حول الكتابة الفنية.
الجمهور
- من هو القارئ المستهدَف؟
- ما الذي يعرفونه بالفعل عن استخدام Blockly؟
- ما الذي يحاولون تعلّمه؟
الإعداد
- ما هو الحدّ الأدنى من الإعداد المطلوب ليتمكّن المستخدم من تشغيل الرمز البرمجي؟
إذا كان ذلك مفيدًا، يمكنك نشر رمز بدء التشغيل
والرمز المكتمل
في الدليل examples.
البنية
كما هو الحال مع أي كتابة، ابدأ بمخطّط. هذا الهيكل مناسب لمعظم التدريبات العملية:
- مقدمة
- أهداف الدورة التعليمية
- ما ستنشئه
- معلومات يجب معرفتها
- تعليمات الإعداد
- الخطوة الأولى: [يُرجى إدخال العنوان هنا]
- الشرح/الدافع
- عيّنة تعليمات برمجية
- النتائج المتوقّعة
- (اختياري) مزيد من التوضيح
- ...
- الخطوة 10: [يظهر العنوان هنا]
- الملخّص
- ما تعلّمته
- ما أنشأته
- مراجع إضافية
- رابط يؤدي إلى الرمز البرمجي المكتمل (في حال توفّره)
يمكنك إضافة أكثر من عشر خطوات، ولكن إذا وصلت إلى عشرين خطوة، ننصحك بتقسيمها إلى دورتَين تعليميتَين.
نمط الكتابة
- استخدِم أسلوب كتابة حواريًا.
- استخدِم العناوين لتوضيح التنظيم.
- استخدِم القوائم النقطية لتقسيم النصوص الطويلة.
- استخدِم الصور وملفات GIF.
نمط الرمز
- يمكنك الكتابة باستخدام ES5 أو ES6 أو TypeScript، ولكن عليك إخبار القارئ بذلك في البداية.
- اتّبِع دليل الأسلوب من Google