এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ট্রাইটন
- কৌশলী লেখক:
- ডেভ
- প্রকল্পের নাম:
- মৌলিক মডিউল জন্য ডকুমেন্টেশন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
এই প্রকল্পে আমি মৌলিক ট্রাইটন মডিউলগুলির জন্য ডকুমেন্টেশন পর্যালোচনা এবং আপডেট করার প্রস্তাব করছি। ট্রাইটন সিস্টেম সেট আপ করার সময় এই মডিউলগুলিকে সাধারণত সক্রিয় করতে হবে।
ট্রাইটনের মডিউল ডকুমেন্টেশনের উন্নতি ব্যবহারকারীদের তাদের প্রয়োজনের জন্য সঠিক মডিউল খুঁজে পেতে এবং তারপর তাদের সিস্টেম সেটআপ করতে এবং ব্যবহার করতে সহায়তা করবে। ভাল মডিউল ডকুমেন্টেশন ব্যবহারকারীদের আলোচনা ফোরামে উত্তরের জন্য অপেক্ষা না করেই তাদের কিছু মৌলিক প্রশ্নের উত্তর খুঁজে পেতে অনুমতি দেবে।
মৌলিক মডিউলগুলি ন্যূনতম হিসাবে অন্তর্ভুক্ত করে: অ্যাকাউন্ট, অ্যাকাউন্ট_ইনভয়েস, অ্যাকাউন্ট_ইনভয়েস_স্টক, অ্যাকাউন্ট_প্রোডাক্ট, কোম্পানি, দেশ, মুদ্রা, পার্টি, পণ্য, ক্রয়, বিক্রয় এবং স্টক মডিউল।
ট্রিটন ডকুমেন্টেশন, ব্যবহারকারী, সিস্টেম অ্যাডমিনিস্ট্রেটর এবং ডেভেলপারদের জন্য তিনটি প্রধান শ্রোতা রয়েছে। এইগুলির প্রতিটিতে ডকুমেন্টেশন লক্ষ্য করতে সাহায্য করার জন্য, আমি পরামর্শ দিচ্ছি যে প্রতিটি মডিউলের ডকুমেন্টেশন ডক ডিরেক্টরির ভিতরে পৃথক ফাইলগুলিতে বিভক্ত করা হয়। এর মধ্যে বিষয়বস্তুর সারণী এবং মডিউলের বর্ণনা, মডিউল সেট আপ করার নির্দেশাবলী, মডিউলটি কীভাবে ব্যবহার করতে হয় সে সম্পর্কে তথ্য এবং মডিউলটির নকশা এবং গঠন সম্পর্কে বিশদ বিবরণ সহ ফাইল অন্তর্ভুক্ত থাকতে পারে। মডিউলের কার্যকারিতার উপর নির্ভর করে এই ফাইলগুলির মধ্যে কিছু প্রয়োজন নাও হতে পারে এবং প্রয়োজনে অতিরিক্ত ফাইল তৈরি করা যেতে পারে। পার্টি মডিউলের জন্য আমি ইতিমধ্যে প্রস্তাবিত মডিউলের উন্নতির মতো হবে: https://codereview.tryton.org/297241003/#ps327231002
ডকুমেন্টেশনকে এভাবে স্ট্রাকচার করা ভালো কাজ করবে কারণ ডকুমেন্টেশন বর্তমানে রিস্ট্রাকচার্ড টেক্সট ফাইল ব্যবহার করে স্ফিংস দ্বারা তৈরি করা হয়েছে। আমি ডকুমেন্টেশনে পরিবর্তন করার সাথে সাথে সেগুলি ট্রাইটন কোড পর্যালোচনা সাইটে আপলোড করা হবে, যাতে সেগুলি পর্যালোচনা করা যায় এবং আমি প্রয়োজন অনুসারে সেগুলি আপডেট করতে পারি৷ একবার সবাই তাদের সাথে খুশি হলে, তারা আশা করি, ট্রাইটনে অন্তর্ভুক্তির জন্য অনুমোদিত হতে পারে।