কিছু ডকুমেন্টেশন ফাইল একইসাথে কনসেপ্ট অনুশীলনী এবং প্র্যাকটিস অনুশীলনী উভয়ের ক্ষেত্রেই প্রযোজ্য। এই ফাইলগুলি সব অনুশীলনীতে প্রযোজ্য, আর এগুলি ট্র্যাকের exercises/shared/.docs ডিরেক্টরিতে থাকে:
-
debug.md: ব্রাউজারে কোড লেখা একজন শিক্ষার্থী কীভাবে "ডিবাগিং" করতে পারেন, তা ব্যাখ্যা করে (ঐচ্ছিক)
-
help.md: সাহায্য পাওয়ার জন্য ট্র্যাক-নির্দিষ্ট নির্দেশনা থাকে (আবশ্যক)
-
representations.md: একটি সমাধানের রিপ্রেজেন্টেশন তৈরি করতে কোন নরমালাইজেশনগুলি প্রয়োগ করা হয়, তা ব্যাখ্যা করে (ঐচ্ছিক)
-
tests.md: টেস্ট চালানোর জন্য ট্র্যাক-নির্দিষ্ট নির্দেশনা থাকে (আবশ্যক)
প্রেজেন্টেশন ডকুমেন্ট ব্যাখ্যা করে কীভাবে এই ফাইলগুলি ব্যবহার করে শিক্ষার্থীর কাছে কনটেন্ট উপস্থাপন করা হয়।
ফাইল: debug.md
উদ্দেশ্য: ব্রাউজারে কোড লেখা একজন শিক্ষার্থী কীভাবে "ডিবাগিং" করতে পারেন, তা ব্যাখ্যা করা
উপস্থিতি: ঐচ্ছিক
ব্রাউজারের ভেতরের এডিটরে ডিবাগিংয়ের জন্য কোনো বিল্ট-ইন সুবিধা নেই। যদি ট্র্যাকের টেস্ট রানার কনসোল আউটপুট ক্যাপচার করা সমর্থন করে, তাহলে শিক্ষার্থী কোনোভাবে "ডিবাগিং" করতে পারেন, আর সেটি কীভাবে করবেন এই ডকুমেন্টে তা ব্যাখ্যা করা আছে।
এই ফাইলের বিষয়বস্তু শুধুমাত্র অনলাইন এডিটরে দেখানো হয়; CLI এই ফাইলটি উপেক্ষা করে।
উদাহরণ
# Debug
To help with debugging, you can use the fact that any [console output](https://www.programiz.com/csharp-programming/basic-input-output) will be shown in the test results window. You can write to the console using:
```csharp
Console.WriteLine("Debug message");
```
ফাইল: help.md
উদ্দেশ্য: একজন শিক্ষার্থী কীভাবে সাহায্য পেতে পারেন, তা ব্যাখ্যা করা
উপস্থিতি: আবশ্যক
এই ট্র্যাকের জন্য বিশেষভাবে শিক্ষার্থী কীভাবে সাহায্য পেতে পারেন তা বর্ণনা করুন (Exercism-ব্যাপী নয়)।
এই ফাইলের বিষয়বস্তু শুধুমাত্র CLI ব্যবহার করে, যা এটিকে HELP.md ফাইলে যুক্ত করে।
নির্দেশনা ছোট এবং সোজাসাপ্টা হওয়া উচিত।
আপনি Gitter চ্যানেল, ফোরাম বা মেইলিং লিস্টের মতো রিসোর্সের লিঙ্ক দিতে পারেন: যা কিছু শিক্ষার্থীকে আটকে যাওয়া থেকে বেরিয়ে আসতে সাহায্য করে।
এই ডকুমেন্টের লিঙ্কগুলি docs/LEARNING.md বা docs/RESOURCES.md-এর লিঙ্কের সাথে মিলে যেতে পারে।
এই ডকুমেন্টে Exercism-ব্যাপী (ট্র্যাক-নিরপেক্ষ) সাহায্যের রিসোর্সের লিঙ্ক দেওয়া উচিত নয়, কারণ সেই রিসোর্সগুলি HELP.md ফাইলে স্বয়ংক্রিয়ভাবে যুক্ত হয়ে যায়।
উদাহরণ
# Help
To get help if you're having trouble, you can use one of the following resources:
- [Kotlin Documentation](https://kotlinlang.org/docs/reference/)
- [Kotlin Forums](https://discuss.kotlinlang.org/)
- [Kotlin Slack Channel](https://kotlinlang.slack.com/): [get invite here](https://slack.kotlinlang.org/)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/kotlin)
- [Kotlin Subreddit](https://www.reddit.com/r/kotlin)
ফাইল: representations.md
উদ্দেশ্য: একটি সমাধানের রিপ্রেজেন্টেশন তৈরি করতে কোন নরমালাইজেশনগুলি প্রয়োগ করা হয়, তা ব্যাখ্যা করে
উপস্থিতি: ঐচ্ছিক
কোনো ট্র্যাক একটি রিপ্রেজেন্টার চালু করলে, জমা দেওয়া প্রতিটি সমাধানের জন্য একটি রিপ্রেজেন্টেশন তৈরি হয়।
এই ডকুমেন্টে রিপ্রেজেন্টার একটি সমাধানে যে সমস্ত নরমালাইজেশন প্রয়োগ করে, তার সবই তালিকাভুক্ত থাকা উচিত।
রিপ্রেজেন্টেশন কমেন্ট যোগ করার সময় এটি একজন মেন্টরকে সাহায্য করে।
উদাহরণ
# Representations
The representer applies the following normalizations:
- All comments are removed
- All import declarations are removed
- The code is formatted
- Identifiers are normalized to a placeholder value
আপনার ট্র্যাকে docs/REPRESENTER_NORMALIZATIONS.md ফাইল থাকলে, আমরা সুপারিশ করি যে নরমালাইজেশনগুলির প্রতিটির সাথে সেই ফাইলের সংশ্লিষ্ট বিভাগের লিঙ্ক দেবেন।
ফাইল: tests.md
উদ্দেশ্য: টেস্ট চালানোর জন্য ট্র্যাক-নির্দিষ্ট নির্দেশনা থাকে
উপস্থিতি: আবশ্যক
এই নির্দিষ্ট অনুশীলনীর টেস্ট কীভাবে চালাতে হবে, তা বর্ণনা করুন।
এই ফাইলের বিষয়বস্তু শুধুমাত্র CLI ব্যবহার করে, যা এটিকে HELP.md ফাইলে যুক্ত করে।
নির্দেশনা ছোট এবং সোজাসাপ্টা হওয়া উচিত।
docs/TESTS.md ফাইলে টেস্ট চালানোর আরও বিস্তারিত বর্ণনা থাকতে পারে।
উদাহরণ
# Tests
To run the tests, run the command `dotnet test` from within the exercise directory.
ওভাররাইট করা
দ্রষ্টব্য: এটি এখনও বাস্তবায়িত হয়নি
অনুশীলনীগুলি নিজেদের .docs ডিরেক্টরিতে একই নামের একটি ফাইল তৈরি করে ট্র্যাক-নির্দিষ্ট ফাইলগুলি ওভাররাইট করতে পারে (যেমন .docs/debug.md)। এটি খুব কম ক্ষেত্রেই দরকার হওয়া উচিত (যদি আদৌ হয়)।
