این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه ی پروژه
- سازمان منبع باز:
- Open3D
- نویسنده فنی:
- روهان راثی
- نام پروژه:
- مستندات فنی Python & C++ API
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
خلاصه داستان:
این پروژه به 4 بخش تقسیم می‌شود: ارتقا و گسترش راهنمای مشارکت‌کننده Open3D. مستندات کامل پایتون API مستندات کامل C++ API اسناد سطح بالا از ساختارهای داده اصلی
شرح:
در پروژه من قصد دارم پروژه را به 4 قسمت تقسیم کنم:
من قصد دارم راهنمای مشارکت کنندگان را برای تازه واردان تکمیل و به روز کنم که راهنمای جامع گام به گام در مورد چگونگی ساخت کد منبع، ساخت اسناد و پیوستن به جامعه توسعه دهندگان ارائه می دهد. علاوه بر یک راهنمای مکتوب، قصد دارم ویدیویی تهیه کنم که مراحل دقیق نحوه ساخت کد منبع کانال یوتیوب را نشان دهد. من همچنین یک راهنمای در مورد اینکه چگونه توسعه دهندگان جدید می توانند با ایجاد تغییرات در کد منبع ساخته شده توسط sphinx با استفاده از pybind و doxygen به مستندات کمک کنند اضافه خواهم کرد.
اسناد Python API را گسترش دهید. در حال حاضر API پایتون حاوی رشته‌های مستند پایه برای کلاس‌ها و توابع عضو است که توصیف مبهم عملکرد را ارائه می‌دهد. من قصد دارم اسناد Python API را دوباره بیان کنم که درک API را آسان‌تر و عملکرد را واضح‌تر می‌کند. من همچنین قصد دارم پیوندهایی را به مفاهیم گرافیک سه بعدی مرتبط که در مناطق مختلف استفاده می شود اضافه کنم (به عنوان مثال: ماتریس ذاتی مورد استفاده در دوربین)
اسناد C++ API را تکمیل کنید. در حال حاضر هیچ رشته مستند معادلی در اسناد C++ در مقایسه با اسناد پایتون وجود ندارد. من قصد دارم کلاس ها و توابع عضو مرتبط و اعضای داده را با جزئیات مستند کنم.
اسناد سطح بالا و پایین ساختارهای داده اصلی. من قصد دارم کد ساختارهای داده مختلف مانند TriangleMesh، LineSet، Octree را درک کنم و نظراتی را در پایگاه کد اضافه کنم، هم برای درک توسعه دهندگان جدید و هم برای هر کاربر. و همچنین با بهبود آموزش ها، مستندات سطح بالایی در مورد کاربرد و مفاهیم درگیر در ساختارها ارائه دهید. من نمونه هایی از کاربرد را به تفصیل ارائه خواهم داد و پیوندهای مرتبط را به مفاهیم درگیر در ساختارها اضافه خواهم کرد. اگر زمان اجازه دهد، من روی کارهای ساده تری مانند مستندسازی نحوه انجام وظایف خاص کار خواهم کرد که می تواند به کاربران تازه وارد کمک کند تا به نرم افزار وابسته شوند.
زمان بندی پروژه-
1 آگوست - 1 سپتامبر:
با مربی من آشنا شوید و در مورد سطح مستندات مورد نیاز در بخش‌های مختلف پایگاه کد با عمق بیشتری بحث کنید و همچنین در مورد چگونگی عمیق‌تر رفتن در اسناد سطح پایین در مقابل سطح بالا بحث کنید. من همچنین این زمان را صرف درک پایگاه کد و مطالعه مفاهیم خواهم کرد تا بتوانم آنها را بهتر مستند کنم.
هفته 1 و 2:
من راهنمای مشارکت‌کنندگان را به‌روزرسانی و گسترش خواهم داد. من مستندات مربوط به نحوه ساخت کد منبع را بهبود خواهم داد. من همچنین یک بخش مستندساز اضافه خواهم کرد که چگونه مشارکت کنندگان جدید می توانند در مستندسازی کمک کنند. من همچنین یک ویدیوی یوتیوب خواهم ساخت که مرحله به مرحله نحوه ساخت کد منبع را مشخص می کند.
هفته 3 تا 5:
من روی گسترش API پایتون کار خواهم کرد. اسناد موجود را دوباره بیان کنید و مستندات اعضای موجود را با جزئیات بنویسید. همچنین پیوندهای مرتبط را به مفاهیم مرتبط اضافه خواهم کرد تا کاربران بتوانند خود را بهتر با مفاهیم مرتبط آشنا کنند.
هفته 6 تا 8:
اسناد C++ فعلی در بیشتر قسمت های کتابخانه ناقص هستند، بنابراین من بیشتر وقت را صرف پر کردن اسناد C++ خواهم کرد.
هفته 9 تا 11:
در این دوره من روی ساختارهای داده اصلی کار خواهم کرد. آموزش های هر ساختار داده را بازسازی کنید، یک نمای کلی سطح بالا و همچنین جزئیات استفاده از نمونه را مستند کنید.
هفته پایانی:
من از هفته آخر برای تهیه گزارش نهایی خود از کارهای انجام شده در دوره اسناد 12 هفته ای خود استفاده خواهم کرد. من همچنین این زمان را صرف بررسی و نهایی کردن مستندات خواهم کرد.