পটভূমি: আমার সহযোগীরা এবং আমি একাডেমিক জার্নালের জন্য একটি নিবন্ধ লিখছি। আমাদের গবেষণা চলাকালীন, আমরা জাভাতে একটি সিমুলেশন প্রোগ্রাম লিখেছিলাম। আমরা সিমুলেশন প্রোগ্রামটি অন্যের জন্য ব্যবহারের জন্য অবাধে উপলব্ধ করতে চাই। আমরা গিটহাবের সংগ্রহস্থলে কোডটি হোস্টিংয়ের সিদ্ধান্ত নিয়েছি। অন্যের পক্ষে এটি ব্যবহার করা সহজ করার জন্য, আমরা আমাদের প্রোগ্রামের জন্য ভাল ডকুমেন্টেশন লিখতে চাই:
- প্রতিটি শ্রেণি এবং পদ্ধতির জন্য জাভাদোকস
- কোডটি কীভাবে ব্যবহার করবেন
- কোডটির উচ্চ-স্তরের কাঠামো বর্ণনা করছেন
আমার উচ্চ-স্তরের প্রশ্নটি: আপনি কী শব্দ এবং চিত্রগুলির একটি ভাল উদাহরণ প্রদান করতে পারেন যা কোনও প্রোগ্রামের উচ্চ-স্তরের কাঠামো বর্ণনা করতে ব্যবহার করা যেতে পারে? এর মধ্যে উপ-প্রশ্ন হিসাবে অন্তর্ভুক্ত রয়েছে:
- কোন প্যাকেজগুলিতে কী ক্লাস রয়েছে তা আমরা কীভাবে দেখাব?
- কীভাবে প্যাকেজগুলি অন্যান্য প্যাকেজগুলির উপর নির্ভর করে তা আমরা কীভাবে দেখাব?
- প্রোগ্রামের অবজেক্ট / ক্লাসগুলি কীভাবে একসাথে কাজ করে তা আমরা কীভাবে দেখাব?
- আমরা আমার কোডের ডিজাইনে ডোমেন-চালিত ডিজাইন নীতিগুলি ব্যবহার করার চেষ্টা করেছি। আমরা কীভাবে ডোমেনের অবজেক্ট এবং এই উত্সগুলিকে এনকোডিং করে নির্দিষ্ট উত্স কোড ফাইলগুলির মধ্যে চিঠিপত্র দেখাব? (নীচে প্রকল্পের আমার "সর্বব্যাপী ভাষা" বর্ণনা দেখুন))
আমি এ পর্যন্ত কি করেছি
সর্বব্যাপী ভাষা
আমরা ubiquitous-language.mdনীচে একটি ফাইলে ফাইলের কোডের একটি "সর্বব্যাপী ভাষা" বর্ণনা রেখেছি ।
এই প্রকল্পের উদ্দেশ্যটি বিভিন্ন লিড টাইম মডেলের অধীনে, প্রতিবেদন বিলম্ব এবং চাহিদা মডেলের অধীনে একটি একক সুবিধাসহ একটি সাধারণ সরবরাহ চেইনে পুনরায় পরিশোধন নীতিটি কতটা ভাল সম্পাদন করে তা অধ্যয়ন করা।
প্রতিটি পিরিয়ডে, নিম্নলিখিত ইভেন্টগুলি ঘটে:
- যদি বর্তমান সময়ে কোনও চালান সুবিধাটিতে পৌঁছানোর কথা নির্ধারিত হয় , তবে সুবিধাটির ইনভেন্টরি স্তরটি এক্স ইউনিট দ্বারা বাড়ানো হয়।
- যদি তফসিলটি ইঙ্গিত দেয় যে বর্তমান সময়কাল একটি প্রতিবেদনের সময়সীমা, তবে সুবিধাটি সরবরাহকারীকে একটি প্রতিবেদন জমা দেয় । সরবরাহকারী পেতে পারে প্রতিবেদন তাত্ক্ষণিকভাবে অথবা, দ্বারা নির্দিষ্ট, কয়েক সপ্তাহ একটি বিলম্ব সময়সূচী ।
- যদি সরবরাহকারী কোনও প্রতিবেদন পেয়ে থাকে তবে পুনরায় পরিশোধন নীতিমালার ভিত্তিতে এটি এক্স ইউনিটগুলির পুনরায় পরিশোধন পরিমাণ গণনা করবে। একটি চালান পণ্য এক্স ইউনিট ঠ সময়কালের দ্বারা নির্দিষ্ট সীসা সময় পর পৌঁছা নির্ধারিত করা হবে না।
- গ্রাহকরা সুবিধায় পৌঁছে পণ্যটির এক্স ইউনিট দাবি করেন। যে কোনও আনমেট চাহিদা নষ্ট হয়।
উত্স কোড কাঠামো
আমরা কোনও ফাইলের কোডের একটি অসম্পূর্ণ "উচ্চ-স্তরের" বর্ণনা রেখেছি structure.md, নীচের বিষয়বস্তুতে।
প্যাকেজ স্তর স্তর
সর্বোচ্চ স্তরে, উত্স কোডটি তিনটি প্যাকেজগুলিতে সংগঠিত হয়
com.gly.sfsmainপদ্ধতি সহ প্রধান শ্রেণি এই প্যাকেজটিতে থাকে।com.gly.sfs.modelডোমেন মডেল ক্লাসগুলি এই প্যাকেজটিতে থাকে।com.gly.sfs.utilসহায়ক প্যাকেজগুলি এই প্যাকেজে থাকে।