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