كتابة درس تطبيقي حول الترميز

مقدمة

الدرس التطبيقي حول الترميز هو برنامج تعليمي تفاعلي مكتوب بلغة markdown. وننشر دروسنا حول الترميز على blocklycodelabs.dev، حيث تستخدم دروسًا تطبيقية حول الترميز بمزيج من اللغات الطبيعية وعيّنات التعليمات البرمجية ولقطات الشاشة لتقديم تجربة تعليمية شيّقة أكثر. يتابع المستخدم المستهدف في الدرس التطبيقي حول الترميز التعليمة البرمجية ويشغله أثناء قراءته.

تشكل كتابة درس تطبيقي حول الترميز طريقة رائعة للمساهمة في المجتمع. إنها طريقة لمشاركة معرفتك وتسهيل الحياة للمطور التالي الذي يواجه نفس المشكلة.

ما الذي يجعل درسًا تطبيقيًا رائعًا حول الترميز؟

يكون الدرس التطبيقي حول الترميز مركّزًا وقابلاً للقراءة. إنه يخبر المستخدم بوضوح بما سيبنيه وما الذي سيتعلمه، ويوجه المستخدم من خلال كتابة وفهم التعليمات البرمجية لإكمال مهمة محددة.

العملية

إذا كانت لديك فكرة عن درس تطبيقي حول الترميز، يمكنك إعلامنا بها من خلال تقديم طلب ميزة في مستودع النماذج المجمّعة. قم بتضمين وصف لما تريد تدريسه وما ستبنيه في درس تطبيقي حول التعليمات البرمجية. ثم سنناقش ونحسّن الفكرة. يمكنك بعد ذلك كتابتها وإرسال طلب سحب لها. وبعد الانتهاء من المراجعة، سينشره أحد أعضاء فريقBlockly.

نصائح الكتابة

بقية هذه الصفحة عبارة عن مجموعة من النصائح والأسئلة لإرشادك خلال كتابة درس تطبيقي حول الترميز.

يمكنك الاطّلاع على دليل الكتابة الفنية للحصول على مقدمة سريعة عن الكتابة التقنية.

الجمهور

  • مَن هو القارئ المستهدَف؟
  • ما هي المعلومات التي يعرفونها عن استخدام حظر؟
  • ما الذي يحاولون تعلمه؟

الإعداد

  • ما الحد الأدنى من الإعداد المطلوب لكي يقوم المستخدم بتشغيل التعليمات البرمجية الخاصة بك؟

يمكنك نشر رمز أوّلي ورمز مكتمل في دليل examples إذا كان ذلك مفيدًا.

البنية

كما هو الحال مع أي كتابة، ابدأ بمخطط. هذا هيكل جيد لمعظم الدروس التطبيقية حول التعليمات البرمجية:

  • المقدمة
    • ما ستتعرَّف عليه
    • ما ستقوم بإنشائه
    • ما تحتاج إلى معرفته
    • تعليمات الإعداد
  • الخطوة الأولى: [يظهر العنوان هنا]
    • التفسير/التحفيز
    • عيّنة تعليمات برمجية
    • النتائج المتوقَّعة
    • (اختياري) مزيد من التوضيح
  • ...
  • الخطوة العاشرة: [يظهر العنوان هنا]
  • ملخّص
    • ما تعلمته
    • المنتجات التي صممتها
    • مراجع إضافية
    • رابط إلى الرمز المكتمل (إذا كان متاحًا)

يمكنك اتّباع أكثر من عشر خطوات، ولكن إذا كنت تصل إلى عشرين خطوة، عليك تقسيمها إلى درسَين تطبيقيَّين.

أسلوب الكتابة

  • استخدِم أسلوب كتابة حوارية.
  • استخدم العناوين لتوضيح المؤسسة.
  • استخدام القوائم النقطية لتقسيم جدران النصوص.
  • استخدام الصور وملفات GIF

نمط الرمز

  • يمكنك الكتابة باستخدام ES5 أو ES6 أو TypeScript، ولكن أخبر القارئ بأنه في بدايته.
  • اتّباع دليل الأسلوب من Google