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