একটি ভাল কোডল্যাব লেখা

ভূমিকা

কোডল্যাব হল মার্কডাউন সিনট্যাক্সে লেখা একটি ইন্টারেক্টিভ টিউটোরিয়াল। আমরা blocklycodelabs.dev এ আমাদের কোডল্যাব প্রকাশ করি। আরও আকর্ষণীয় টিউটোরিয়াল অভিজ্ঞতা তৈরি করতে কোডল্যাবগুলি প্রাকৃতিক ভাষা, কোড নমুনা এবং স্ক্রিনশটের মিশ্রণ ব্যবহার করে। কোডল্যাবের টার্গেট ব্যবহারকারী কোডটি পড়ার সাথে সাথে অনুসরণ করছে এবং চালাচ্ছে।

একটি কোডল্যাব লেখা সম্প্রদায়ে অবদান রাখার একটি দুর্দান্ত উপায়। এটি আপনার জ্ঞান ভাগ করে নেওয়ার এবং পরবর্তী বিকাশকারীর জন্য জীবনকে সহজ করে তোলার একটি উপায় যা একই সমস্যায় পড়ে৷

কি একটি মহান কোডল্যাব তোলে?

একটি দুর্দান্ত কোডল্যাব ফোকাসড এবং পঠনযোগ্য। এটি ব্যবহারকারীকে স্পষ্টভাবে বলে যে তারা কী তৈরি করবে এবং তারা কী শিখবে এবং এটি ব্যবহারকারীকে একটি নির্দিষ্ট কাজ সম্পূর্ণ করার জন্য কোড লেখা এবং বোঝার মাধ্যমে নিয়ে যায়।

প্রক্রিয়া

আপনার যদি কোডল্যাবের জন্য কোনো ধারণা থাকে, তাহলে আপনি ব্লকলি-স্যাম্পল রিপোজিটরিতে একটি বৈশিষ্ট্যের অনুরোধ করে এটি সম্পর্কে আমাদের বলতে পারেন। আপনি কী শেখাতে চান এবং কোডল্যাবে আপনি কী তৈরি করবেন তার একটি বিবরণ অন্তর্ভুক্ত করুন। আমরা আলোচনা করব এবং ধারণাটি পরিমার্জন করব। তারপর আপনি এটি লিখতে পারেন এবং এটির জন্য একটি পুল অনুরোধ জমা দিতে পারেন । একবার এটি পর্যালোচনার মাধ্যমে হয়ে গেলে, Blockly দলের একজন সদস্য এটি প্রকাশ করবেন।

লেখার টিপস

এই পৃষ্ঠার বাকি অংশটি একটি কোডল্যাব লেখার মাধ্যমে আপনাকে গাইড করার জন্য টিপস এবং প্রশ্নগুলির একটি সেট৷

প্রযুক্তিগত লেখার দ্রুত পরিচিতির জন্য টেকনিক্যাল রাইটিং ওয়ান দেখুন।

শ্রোতা

• টার্গেট রিডার কে?
• তারা ইতিমধ্যে Blockly ব্যবহার সম্পর্কে কি জানেন?
• তারা কি শেখার চেষ্টা করছে?

সেটআপ

• আপনার কোড চালানোর জন্য ব্যবহারকারীর জন্য ন্যূনতম সেটআপ কী প্রয়োজন?

যদি সহায়ক হয়, আপনি examples ডিরেক্টরিতে স্টার্টার কোড এবং সম্পূর্ণ কোড প্রকাশ করতে পারেন।

গঠন

যেকোনো লেখার মতো, একটি রূপরেখা দিয়ে শুরু করুন। এটি বেশিরভাগ কোডল্যাবগুলির জন্য একটি ভাল কাঠামো:

• ভূমিকা
  • আপনি কি শিখবেন
  • আপনি কি নির্মাণ করবেন
  • আপনাকে জানতে হবে কি
  • সেটআপ নির্দেশাবলী
• ধাপ এক: [শিরোনাম এখানে যায়]
  • ব্যাখ্যা/অনুপ্রেরণা
  • কোড নমুনা
  • প্রত্যাশিত ফলাফল
  • (ঐচ্ছিক) আরো ব্যাখ্যা
• ...
• ধাপ দশ: [শিরোনাম এখানে যায়]
• সারসংক্ষেপ
  • আপনি যা শিখেছেন
  • আপনি যা নির্মাণ করেছেন
  • অতিরিক্ত সম্পদ
  • সম্পূর্ণ কোডের লিঙ্ক (যদি পাওয়া যায়)

যদিও আপনার দশটিরও বেশি পদক্ষেপ থাকতে পারে, আপনি যদি বিশটি আঘাত করেন তবে আপনাকে এটিকে দুটি কোডল্যাবে ভাঙ্গা বিবেচনা করা উচিত।

লিখন শৈলী

• কথোপকথনমূলক লেখার শৈলী ব্যবহার করুন।
• প্রতিষ্ঠানকে পরিষ্কার করতে শিরোনাম ব্যবহার করুন।
• পাঠ্যের দেয়াল ভাঙ্গার জন্য বুলেটেড তালিকা ব্যবহার করুন।
• ছবি এবং gif ব্যবহার করুন!

কোড শৈলী

• আপনি ES5, ES6, বা TypeScript-এ লিখতে পারেন, কিন্তু পাঠককে বলুন যে এটি শুরুতে কোনটি।
• গুগল স্টাইল গাইড অনুসরণ করুন