এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- Open3D
- কৌশলী লেখক:
- রোহান রথী
- প্রকল্পের নাম:
- পাইথন এবং C++ API এর প্রযুক্তিগত ডকুমেন্টেশন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
সারসংক্ষেপ:
প্রকল্পটি 4টি অংশে বিভক্ত হবে: Open3D কন্ট্রিবিউটরের গাইড আপগ্রেড এবং প্রসারিত করুন সম্পূর্ণ পাইথন API ডকুমেন্টেশন সম্পূর্ণ C++ API ডকুমেন্টেশন কোর ডেটা স্ট্রাকচারের উচ্চ-স্তরের ডক্স
বর্ণনা:
আমার প্রকল্পে আমি প্রকল্পটি 4 ভাগে ভাগ করার পরিকল্পনা করেছি:
আমি নতুনদের জন্য কন্ট্রিবিউটর গাইড সম্পূর্ণ এবং আপডেট করার পরিকল্পনা করছি যা তারা কিভাবে সোর্স কোড তৈরি করতে পারে, ডকুমেন্টেশন তৈরি করতে পারে এবং ডেভেলপার সম্প্রদায়ের সাথে যোগ দিতে পারে সে সম্পর্কে একটি বিস্তৃত ধাপে ধাপে নির্দেশিকা প্রদান করে। একটি লিখিত নির্দেশিকা ছাড়াও আমি ইউটিউব চ্যানেলের জন্য সোর্স কোড কীভাবে তৈরি করতে হয় তার সঠিক পদক্ষেপগুলি প্রদর্শন করে একটি ভিডিও তৈরি করতে চাই। পাইবিন্ড এবং ডক্সিজেন ব্যবহার করে স্ফিংক্স দ্বারা নির্মিত সোর্স কোডে পরিবর্তন করে নতুন বিকাশকারীরা কীভাবে ডকুমেন্টেশনে অবদান রাখতে পারে সে সম্পর্কে আমি একটি গাইড যোগ করব।
Python API ডকুমেন্টেশন প্রসারিত করুন। বর্তমানে পাইথন API-এ ক্লাস এবং সদস্য ফাংশনগুলির জন্য মৌলিক ডকস্ট্রিং রয়েছে যা কার্যকারিতার একটি অস্পষ্ট বিবরণ প্রদান করে। আমি পাইথন এপিআই ডকুমেন্টেশন রিফ্রেস করার পরিকল্পনা করছি যা এপিআইকে বুঝতে সহজ করে এবং কার্যকারিতা পরিষ্কার করে। আমি বিভিন্ন ক্ষেত্রগুলিতে ব্যবহৃত প্রাসঙ্গিক 3D গ্রাফিক্স ধারণাগুলির লিঙ্কগুলি যোগ করার ইচ্ছাও রাখি (যেমন: ক্যামেরায় ব্যবহৃত অন্তর্নিহিত ম্যাট্রিক্স)
C++ API ডকুমেন্টেশন সম্পূর্ণ করুন। পাইথন ডকুমেন্টেশনের তুলনায় বর্তমানে C++ ডকুমেন্টেশনে কোনো সমতুল্য ডকস্ট্রিং নেই। আমি ক্লাস এবং তাদের সংশ্লিষ্ট সদস্য ফাংশন এবং ডেটা সদস্যদের বিস্তারিতভাবে নথিভুক্ত করতে চাই।
মূল ডেটা স্ট্রাকচারের উচ্চ এবং নিম্ন স্তরের ডক্স। আমি বিভিন্ন ডেটা স্ট্রাকচার যেমন ট্রায়াঙ্গেলমেশ, লাইনসেট, অক্টরির কোড বুঝতে চাই এবং কোডবেসে মন্তব্য যোগ করতে চাই, নতুন ডেভেলপার বোঝার জন্য এবং যেকোনো ব্যবহারকারীর জন্য। পাশাপাশি টিউটোরিয়ালগুলিকে উন্নত করে কাঠামোর সাথে জড়িত ব্যবহার এবং ধারণাগুলির উপর উচ্চ স্তরের ডকুমেন্টেশন সরবরাহ করুন। আমি ব্যবহারের বিস্তারিত উদাহরণ প্রদান করব এবং কাঠামোর সাথে জড়িত ধারণাগুলির সাথে প্রাসঙ্গিক লিঙ্ক যোগ করব। যদি সময় অনুমতি দেয় তবে আমি আরও সহজ কাজগুলিতে কাজ করব যেমন কীভাবে কিছু নির্দিষ্ট কাজ সম্পাদন করতে হয় যা নতুন ব্যবহারকারীদের সফ্টওয়্যারের সাথে সংযুক্ত হতে সাহায্য করতে পারে।
প্রকল্পের সময়সূচী-
1 আগস্ট - 1 সেপ্টেম্বর:
আমার পরামর্শদাতার সাথে পরিচিত হন এবং কোডবেসের বিভিন্ন অংশে প্রয়োজনীয় ডকুমেন্টেশনের স্তরের আরও গভীরতার সাথে আলোচনা করুন এবং নিম্ন স্তরের বনাম উচ্চ স্তরের ডকুমেন্টেশনের মধ্যে কীভাবে গভীরভাবে যেতে হবে তাও আলোচনা করুন। আমি এই সময়টি কোডবেস বোঝার জন্য ব্যয় করব এবং ধারণাগুলি অধ্যয়ন করব যাতে আমি সেগুলি আরও ভালভাবে নথিভুক্ত করতে পারি।
সপ্তাহ 1 এবং 2:
আমি অবদানকারীদের গাইড আপডেট এবং প্রসারিত করব। আমি সোর্স কোড কীভাবে তৈরি করতে হয় তার ডকুমেন্টেশন উন্নত করব। নতুন অবদানকারীরা কীভাবে ডকুমেন্টেশনে সাহায্য করতে পারে সে সম্পর্কে আমি একটি ডকুমেন্টার বিভাগও যোগ করব। আমি কীভাবে সোর্স কোড তৈরি করতে হয় তা ধাপে ধাপে নির্দিষ্ট করে একটি ইউটিউব ভিডিও তৈরি করব।
সপ্তাহ 3 - 5:
আমি পাইথন API প্রসারিত করতে কাজ করব। বিদ্যমান ডকুমেন্টেশন রিফ্রেস করুন এবং বিদ্যমান সদস্যদের বিস্তারিত ডকুমেন্টেশন লিখুন। আমি সম্পর্কিত ধারণাগুলির প্রাসঙ্গিক লিঙ্কগুলিও যুক্ত করব যাতে ব্যবহারকারীরা জড়িত ধারণাগুলির সাথে নিজেদেরকে আরও ভালভাবে পরিচিত করতে পারে৷
সপ্তাহ 6 - 8:
বর্তমান C++ নথিগুলি লাইব্রেরির বেশিরভাগ অংশের জন্য অসম্পূর্ণ, তাই আমি বেশিরভাগ সময় C++ নথি পূরণ করতে ব্যয় করব
সপ্তাহ 9 - 11:
এই সময়ের মধ্যে আমি মূল ডেটা স্ট্রাকচারে কাজ করব। প্রতিটি ডেটা স্ট্রাকচারের টিউটোরিয়াল পুনর্গঠন করুন, একটি উচ্চ স্তরের ওভারভিউ এবং নথির উদাহরণ ব্যবহারের বিবরণ প্রদান করুন।
শেষ সপ্তাহ:
আমি আমার 12 সপ্তাহের ডকুমেন্টেশন সময়ের মধ্যে সম্পন্ন কাজের আমার চূড়ান্ত প্রতিবেদন প্রস্তুত করতে চূড়ান্ত সপ্তাহ ব্যবহার করব। আমি ডকুমেন্টেশন পর্যালোচনা এবং চূড়ান্ত করতে এই সময় ব্যয় করব।