এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ScummVM
- কৌশলী লেখক:
- b-ভদ্র
- প্রকল্পের নাম:
- ডক্সিজেনের মাধ্যমে সোর্স কোড ডকুমেন্টেশন উন্নত করুন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বর্তমান ScummVM API (সোর্স কোড) ডকুমেন্টেশন এখানে প্রকাশিত হয়েছে: https://doxygen.scummvm.org/modules.html
এটি দুর্ভাগ্যবশত অনেক এলাকায় অনুপস্থিত:
1) এটির কার্যত কোন কাঠামো নেই, সমস্ত তথ্য একই স্তরে ভাসছে।
2) C++ উপাদানগুলি অসঙ্গতভাবে নথিভুক্ত করা হয়েছে যার মধ্যে কিছু নথিভুক্ত নয়। এটি এমন কিছু যা সংস্থাটি একটি প্রধান সমস্যা হিসাবে উল্লেখ করেছে।
3) পুরানো এবং অবচিত বিষয়বস্তু এখনও আউটপুট প্রদর্শিত হচ্ছে.
4) ডক্সিজেন ট্যাগিংয়ের ভাষা এবং ব্যবহার আরও সামঞ্জস্যপূর্ণ করা উচিত। এটির জন্য নিয়মগুলির একটি সেট প্রয়োজন, এমন কিছু যা এই প্রকল্পের জন্য ভবিষ্যতের ডকুমেন্টেশন স্টাইলগাইডের ভিত্তি হতে পারে।
5) এই পৃষ্ঠায় ব্যবহৃত ডক্সিজেন সিএসএস এটিকে ScummVM ওয়েবসাইটের সাথে আরও সাদৃশ্যপূর্ণ করতে উন্নত করা যেতে পারে: https://www.scummvm.org
ডক্স প্রকল্পের মরসুমে এই সমস্ত সমস্যাগুলি মোকাবেলা করা যেতে পারে।
ডক্স অ্যাপ্লিকেশনের এই মরসুমে একটি খসড়া পিআর সহ রয়েছে যা আমি প্রস্তাবিত কিছু সম্ভাব্য উন্নতি প্রদর্শনের জন্য প্রকল্পে খুলেছিলাম: https://github.com/scummvm/scummvm/pull/2361 কি সম্পর্কে কিছু বিশদ বিবরণের জন্য সেখানে বিবরণ দেখুন এটি রয়েছে এবং পার্থক্যটি দেখতে।
এটি মোটামুটি PR এর সাথে জড়িত:
1) আমি মনে করি সম্ভাব্য নতুন অবদানকারীদের জন্য এই মুহূর্তে সবচেয়ে বিভ্রান্তিকর বিষয়, এবং সাধারণত যারা বর্তমান API ডক দেখেন, তা হল কাঠামোর অভাব। স্ট্রাকচার্ড API ডকুমেন্টেশন প্রবর্তন করা পঠনযোগ্যতা, সন্ধানযোগ্যতা, এবং ফলস্বরূপ, ডকসেটের ব্যবহারযোগ্যতা উন্নত করবে। এই কারণেই আমার PR 'সাধারণ' ফোল্ডারের সমস্ত শিরোনাম ফাইলের সাথে ডক্সিজেন গ্রুপগুলিকে পরিচয় করিয়ে দেয়। এই নতুন কাঠামোর সাহায্যে, কেউ যদি OS-সম্পর্কিত API (উদাহরণস্বরূপ) জন্য ডক্স খুঁজতে চায়, তারা সহজেই নেভিগেশনে এটি খুঁজে পেতে পারে।
2) এই ডকুমেন্টেশন তৈরি করতে একটি নতুন ডক্সিজেন কনফিগারেশন ফাইল সেট আপ করা হয়েছে।
3) একটি 'links.doxyfile' ফাইল যা থেকে ডকসেট জুড়ে ব্যবহৃত সমস্ত লিঙ্ক একক-সোর্স হতে পারে। ডক্সিজেনের সাথে কাজ করার সময় একটি দরকারী প্রক্রিয়া।
4) একটি পরিবর্তিত ডক্সিজেন CSS। এটি বর্তমানে অন্য ওপেন সোর্স প্রকল্প থেকে নেওয়া হয়েছে এবং এটি শুধুমাত্র একটি সূচনা বিন্দু। আদর্শভাবে, ডক্সিজেন পৃষ্ঠার চেহারা এবং অনুভূতি ScummVM ওয়েব পৃষ্ঠার সাথে কমবেশি সামঞ্জস্যপূর্ণ হওয়া উচিত।
পিআর যা কভার করে না তবে অবশ্যই বিষয়বস্তুতে কাজ করা দরকার। এর দ্বারা আমি কোডের প্রয়োজনীয় অংশগুলি সনাক্ত করতে চাই যা নথিভুক্ত নয়, যেগুলি যথেষ্ট নথিভুক্ত নয়, বা কোডের পুরানো অংশগুলি যা ডকুমেন্টেশন থেকে সরানো উচিত। যেহেতু আমি এর আগে প্রকল্পে কাজ করিনি, তাই এটি অর্জনের জন্য একজন পরামর্শদাতার কাছ থেকে নির্দেশিকা প্রয়োজন হবে।
অবশ্যই, আমরা পিআর থেকে কিছু বাস্তবায়ন করব কিনা তা সংস্থার সাথে আলোচনার বিষয়। আমার ধারণা ছিল যে ক্রিয়াগুলি শব্দের চেয়ে জোরে কথা বলে তাই আমি কেবল অ্যাপ্লিকেশনটিতে এটি বর্ণনা করার পরিবর্তে আমি কী করতে পারি তা দেখানোর সিদ্ধান্ত নিয়েছি।
সংস্থাটি এই প্রকল্পের জন্য নিম্নলিখিত রুক্ষ টাইমলাইন প্রদান করেছে: সপ্তাহের প্রধান কার্য সপ্তাহ 0 (9/14 এর আগে) প্রস্তাব আলোচনা ও পর্যালোচনা সপ্তাহ 1 (9/14) ডক্সিজেন বিল্ড সেট আপ সপ্তাহ 2 (9/21) ডক্সিজেন ত্বকের রিফ্রেশ ( কম অগ্রাধিকার) সপ্তাহ 3 (9/28) সাধারণ কোড - OSystem, FS, ডেটা স্ট্রাকচার, স্ট্রিংস, ইত্যাদি। সপ্তাহ 4 (10/05) সাধারণ কোড - অব্যাহত সপ্তাহ 5 (10/12) ইঞ্জিন - সাধারণ কোড এবং নমুনা ইঞ্জিন সপ্তাহ 6 (10/19) গ্রাফিক্স সপ্তাহ 7 (10/26) অডিও সপ্তাহ 8 (11/02) ভিডিও, ছবি সপ্তাহ 9 (11/09) ব্যাকএন্ড - প্ল্যাটফর্ম, গ্রাফিক্স, ইভেন্ট সপ্তাহ 10 (11/23) ব্যাকএন্ড - অব্যাহত সপ্তাহ 11 (11/30) প্রকল্পের সারাংশ এবং জমা
আমি যে পরিবর্তনের প্রস্তাব করব তা হল কাঠামোর উপর কাজ করে শুরু করা, যেমনটি ইতিমধ্যে উল্লেখ করা হয়েছে। এটি ডক্সিজেন বিল্ড সেটআপ (যা অনেকাংশে ইতিমধ্যেই করা হয়েছে) এবং ডক্সিজেন স্কিন রিফ্রেশ সহ 1 এবং 2 সপ্তাহে করা যেতে পারে। এর পরে, আমি একমত যে সমস্যাগুলি সনাক্ত করতে এবং ডক্সিজেন ডকুমেন্টেশন উন্নত করতে পরামর্শদাতার সাথে এক এক করে বিভিন্ন ক্ষেত্রের মধ্য দিয়ে যাওয়া সবচেয়ে বোধগম্য।
আমি এটি একটি প্রমিত দৈর্ঘ্যের প্রকল্প দেখছি কিন্তু আমি নিশ্চিত যে API ডকুমেন্টেশন সম্পর্কিত অন্যান্য উন্নতি আছে যা GSoD প্রকল্প শেষ হওয়ার পরে করা যেতে পারে। উদাহরণস্বরূপ, একটি ডকুমেন্টেশন স্টাইলগাইড নিয়ে আসা এবং এটি উইকিতে যোগ করা, যাতে অবদানকারীরা সচেতন হন যে তারা যে কোডটি যোগ করছেন তা কীভাবে নথিভুক্ত করা উচিত।
GSoD শেষ হওয়ার পরে আমি আনন্দের সাথে এই ধরনের কাজগুলিতে সাহায্য করব। আমি নিশ্চিত যে ScummVM একটি প্রযুক্তিগত লেখক ব্যবহার করতে পারে যিনি নিশ্চিত করবেন যে এর API ডকটি ভাল মানের এবং ব্যবহারযোগ্য। আমি আরও দেখতে পাচ্ছি যে ভবিষ্যতের অন্যান্য ডক প্রজেক্ট রয়েছে যেগুলির সাথে আমি আপনাকে সাহায্য করতে পারি, যেমন প্লাগইনগুলির সাথে কীভাবে কাজ করতে হয় সে সম্পর্কে একটি গাইড তৈরি করা।