تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Open3D
- الكاتب الفني:
- روهان راثي
- اسم المشروع:
- المستندات الفنية لواجهات برمجة التطبيقات Python وC++
- مدة المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
الملخص:
سيتم تقسيم المشروع إلى 4 أجزاء: ترقية دليل المساهمين في Open3D وتوسيع نطاقه مستندات كاملة لواجهة برمجة التطبيقات Python API مستندات كاملة لواجهة برمجة التطبيقات C++ API مستندات عالية المستوى لهياكل البيانات الأساسية
الوصف:
في مشروعي، أخطّط لتقسيم المشروع إلى 4 أجزاء:
أخطّط لإكمال دليل المساهمين وتعديله ليقدّم للمبتدئين دليلاً شاملاً ومفصّلاً حول كيفية إنشاء الرمز المصدر وإعداد المستندات والانضمام إلى منتدى المطوّرين. بالإضافة إلى دليل مكتوب، أريد إنشاء فيديو يعرض الخطوات الدقيقة حول كيفية إنشاء رمز المصدر لقناة YouTube. سأضيف أيضًا دليلاً حول كيفية مساهمة المطوّرين الجدد في المستندات من خلال إجراء تغييرات على رمز المصدر الذي أنشأه Sphinx باستخدام pybind وdoxygen.
توسيع نطاق مستندات واجهة برمجة التطبيقات Python تحتوي واجهة Python API حاليًا على سلاسل توثيق أساسية للفئات ودوال الأعضاء والتي توفر وصفًا غامضًا للوظائف. أخطّط لإعادة صياغة مستندات واجهة برمجة التطبيقات Python API، ما يسهّل فهم واجهة برمجة التطبيقات ويوضّح وظائفها. أريد أيضًا إضافة روابط إلى مفاهيم الرسومات الثلاثية الأبعاد ذات الصلة المستخدَمة في مجالات مختلفة (مثل المصفوفة الداخلية المستخدَمة في الكاميرا).
أكمِل مستندات واجهة برمجة التطبيقات C++. لا توجد حاليًا سلسلة توثيق مكافئة في وثائق C++ مقارنة بوثائق بايثون. أريد توثيق الفصول والوظائف الأعضاء المرتبطة بها وعناصر البيانات بالتفصيل .
مستندات عالية المستوى ومنخفضة المستوى لهياكل البيانات الأساسية أريد فهم رمز بنية البيانات المختلفة، مثل TriangleMesh وLineSet وOctree، وإضافة تعليقات في قاعدة البيانات، وذلك لفهم المطوّرين الجدد وأي مستخدمين. بالإضافة إلى توفير مستندات عالية المستوى حول الاستخدام والمفاهيم المضمّنة في البنى من خلال تحسين الأدلة التعليمية. سأقدم أمثلة مفصلة عن الاستخدام وأضيف روابط ذات صلة إلى المفاهيم المضمنة في الهياكل. إذا سمح الوقت، سأعمل بعد ذلك على المهام الأسهل، مثل توثيق كيفية تنفيذ مهام معيّنة يمكن أن تساعد المستخدمين الجدد في الانضمام إلى البرنامج.
الجدول الزمني للمشروع-
1 أغسطس - 1 سبتمبر:
التعرّف على المرشد ومناقشة مستوى التوثيق المطلوب بالتفصيل في أجزاء مختلفة من قاعدة البيانات، ومناقشة مستوى التوثيق المفصّل مقابل التوثيق العام سأقضي أيضًا هذه الفترة في فهم قاعدة البيانات ودراسة المفاهيم حتى أتمكّن من توثيقها بشكل أفضل.
الأسبوعان 1 و2:
سأعدّل دليل المساهمين وأوسّعه. سأعمل على تحسين المستندات حول كيفية إنشاء رمز المصدر. سأضيف أيضًا قسمًا للموثّقين حول كيفية مساعدة المساهمين الجدد في عملية التوثيق. سأنشئ أيضًا فيديو على YouTube يوضّح خطوة بخطوة كيفية إنشاء رمز المصدر.
من الأسبوع 3 إلى 5:
سأعمل على توسيع نطاق واجهة برمجة التطبيقات Python API. إعادة صياغة المستندات الحالية وكتابة مستندات تفصيلية عن الأعضاء الحاليين سأضيف أيضًا روابط ذات صلة بالمفاهيم ذات الصلة حتى يتمكّن المستخدمون من التعرّف بشكل أفضل على المفاهيم المعنيّة.
من الأسبوع 6 إلى 8:
إنّ مستندات C++ الحالية غير مكتملة لمعظم أجزاء المكتبة، لذا سأقضي معظم الوقت في ملء مستندات C++.
من الأسبوع 9 إلى 11:
وخلال هذه الفترة، سأعمل على هياكل البيانات الأساسية. إعادة تنظيم الأدلة التعليمية لكل بنية بيانات، وتقديم نظرة عامة على مستوى عالٍ بالإضافة إلى مستند تفاصيل مثال على الاستخدام
الأسبوع الأخير:
سأستخدِم الأسبوع الأخير لإعداد تقريري النهائي عن العمل الذي تمّ خلال فترة التوثيق التي تبلغ 12 أسبوعًا. سأستخدِم هذا الوقت أيضًا لمراجعة المستندات ووضع اللمسات النهائية عليها.