প্রেজেন্টেশন

এই ডকুমেন্টে বর্ণনা করা হয়েছে কীভাবে বিভিন্ন অনুশীলনী ও ট্র্যাক ফাইল শিক্ষার্থীর সামনে উপস্থাপিত হয়, শিক্ষার্থী CLI না এডিটর ব্যবহার করছে তা বিবেচনায় নিয়ে।

ডকুমেন্টেশন

এমন তিন ধরনের ডকুমেন্টেশন আছে যা নির্ধারণ করে একটি অনুশীলনীর জন্য কোন ডকুমেন্টেশন উপস্থাপিত হয়।

অনুশীলনী-ভিত্তিক ফাইল

এই ফাইলগুলো প্রতিটি অনুশীলনীর জন্য আলাদা:

• .docs/introduction.md: অনুশীলনীটি শিক্ষার্থীকে যে কনসেপ্ট শেখায় তার পরিচয় দেয় (আবশ্যক)
• .docs/introduction.append.md: বিদ্যমান পরিচিতির পরে যুক্ত করার জন্য অতিরিক্ত পরিচিতিমূলক লেখা (কনসেপ্ট অনুশীলনীতে ব্যবহৃত হয় না, প্র্যাকটিস অনুশীলনীতে ঐচ্ছিক)
• .docs/instructions.md: অনুশীলনীর জন্য নির্দেশনা দেয় (আবশ্যক)
• .docs/instructions.append.md: বিদ্যমান নির্দেশনার পরে যুক্ত করার জন্য অতিরিক্ত পরিচিতিমূলক লেখা (কনসেপ্ট অনুশীলনীতে ব্যবহৃত হয় না, প্র্যাকটিস অনুশীলনীতে ঐচ্ছিক)
• .docs/hints.md: অনুশীলনীতে শিক্ষার্থী আটকে গেলে নিজে থেকে বেরিয়ে আসতে সাহায্য করার জন্য হিন্ট দেয় (কনসেপ্ট অনুশীলনীতে আবশ্যক, প্র্যাকটিস অনুশীলনীতে ঐচ্ছিক)
• .meta/config.json: অনুশীলনীর সোর্স-সংক্রান্ত তথ্য ধারণ করে (ঐচ্ছিক)

আরও তথ্যের জন্য কনসেপ্ট অনুশীলনীর ডকুমেন্টেশন এবং প্র্যাকটিস অনুশীলনীর ডকুমেন্টেশন দেখুন।

ট্র্যাক-ভিত্তিক ফাইল

এই ফাইলগুলো সব অনুশীলনীর মধ্যে শেয়ার করা হয়:

• debug.md: ব্রাউজারে কোড করা শিক্ষার্থী কীভাবে এখনও "debugging" করতে পারে তা ব্যাখ্যা করে (ঐচ্ছিক)
• help.md: সহায়তা পাওয়ার উপায় নিয়ে ট্র্যাক-ভিত্তিক নির্দেশনা ধারণ করে (আবশ্যক)
• representations.md: একটি সলুশনের রিপ্রেজেন্টেশন তৈরি করতে কোন নরমালাইজেশন প্রয়োগ করা হয় তা ব্যাখ্যা করে (ঐচ্ছিক)
• tests.md: টেস্ট চালানোর ট্র্যাক-ভিত্তিক নির্দেশনা ধারণ করে (আবশ্যক)

আরও তথ্যের জন্য শেয়ার্ড ফাইলের ডকুমেন্টেশন দেখুন।

Exercism-ব্যাপী ডকুমেন্টেশন

উপরের ট্র্যাক/অনুশীলনী-ভিত্তিক ডকুমেন্টেশন ফাইলগুলো ছাড়াও Exercism-ব্যাপী (এবং তাই সব ট্র্যাকে শেয়ার করা) দুটি ডকুমেন্টেশন অংশ আছে:

• CLI দিয়ে একটি অনুশীলনী সাবমিট করার নির্দেশনা
• সহায়তা পাওয়ার নির্দেশনা

এডিটর

ব্রাউজারে একটি অনুশীলনী নিয়ে কাজ করার সময় প্রাসঙ্গিক সময়ে ডকুমেন্টেশন ফাইলগুলো দেখা যাবে। উদাহরণস্বরূপ, শিক্ষার্থী দেখতে চাইলে ছাড়া হিন্ট দেখানো হয় না। এডিটরকে CLI-এর নির্দেশনা দেখানোরও প্রয়োজন নেই।

CLI

CLI-এর মাধ্যমে স্থানীয়ভাবে কাজ করার সময় শর্তসাপেক্ষে ডকুমেন্টেশন দেখানোর সুযোগ আমাদের নেই। তাই CLI-কে সবসময় সব প্রাসঙ্গিক ডকুমেন্টেশন ডাউনলোড করতে হয়। শিক্ষার্থীকে একাধিক ফাইল খুলতে না হওয়ার জন্য, CLI সব প্রাসঙ্গিক ডকুমেন্টেশন মিলিয়ে তিনটি ডকুমেন্ট তৈরি করে:

README.md

এই ফাইলে অনুশীলনীর নির্দেশনা, পরিচিতি (ঐচ্ছিক) এবং সোর্স-সংক্রান্ত তথ্য (ঐচ্ছিক) থাকে।

# [exercise name]

Welcome to [exercise name] on Exercism's [track name] Track.
If you need help running the tests or submitting your code, check out `HELP.md`.
If you get stuck on the exercise, check out `HINTS.md`, but try and solve it without using those first :)

## Introduction (optional)

[Exercise-specific file: .docs/introduction.md] (optional)

[Exercise-specific file: .docs/introduction.append.md] (optional)

## Instructions

[Exercise-specific file: .docs/instructions.md]

[Exercise-specific file: .docs/instructions.append.md] (optional)

## Source

### Created by

- @[author-1 handle]
- @[author-2 handle]
  ...

### Contributed to by (optional)

- @[contributor-1 handle]
- @[contributor-2 handle]
  ...

### Based on

[source] - [source url]

HELP.md

এই ফাইলে টেস্ট চালানোর উপায় এবং ট্র্যাক- ও Exercism-ব্যাপী সহায়তার নির্দেশনা বর্ণনা করা হয়েছে।

# Help

## Running the tests

[Track-specific file: exercises/shared/.docs/tests.md]

## Submitting your solution

[Exercism-wide documentation: instructions on how to submit a solution]

## Need to get help?

[Exercism-wide documentation: instructions on how to get help]

[Track-specific file: exercises/shared/.docs/help.md]

HINTS.md

এই ফাইলটিতে অনুশীলনী-ভিত্তিক হিন্ট থাকে (ঐচ্ছিক)

# Hints

## General

- Consider extracting the logic to a helper function.