इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Open3D
- तकनीकी लेखक:
- रोहन राठी
- प्रोजेक्ट का नाम:
- Python और C++ API के तकनीकी दस्तावेज़
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
रूपरेखा:
प्रोजेक्ट को चार हिस्सों में बांटा जाएगा: Open3D योगदान देने वालों की गाइड को अपग्रेड करें और उसका दायरा बढ़ाएं Python API का दस्तावेज़ पूरा करें C++ एपीआई दस्तावेज़ पूरा करें कोर डेटा स्ट्रक्चर के हाई-लेवल दस्तावेज़
ब्यौरा:
मेरे प्रोजेक्ट में प्रोजेक्ट को चार हिस्सों में बांटने की योजना है:
मेरी योजना है कि नए लोगों के लिए, योगदान देने वालों की गाइड को पूरा और अपडेट किया जाए. इसमें, सोर्स कोड बनाने, दस्तावेज़ बनाने, और डेवलपर कम्यूनिटी में शामिल होने के बारे में सिलसिलेवार निर्देश दिए गए हैं. लिखित गाइड के अलावा, मुझे एक वीडियो भी बनाना है. इसमें YouTube चैनल के लिए सोर्स कोड बनाने का तरीका बताया जाएगा. मैं एक गाइड भी जोड़ूंगी कि कैसे नए डेवलपर, pybind और doxygen का इस्तेमाल करके sphinx के बनाए गए सोर्स कोड में बदलाव करके, दस्तावेज़ में योगदान दे सकते हैं.
Python API से जुड़े दस्तावेज़ को बड़ा करें. फ़िलहाल, Python API में क्लास और मेंबर फ़ंक्शन के लिए बेसिक डॉकस्ट्रिंग शामिल हैं. इनसे, फ़ंक्शन के बारे में साफ़ तौर पर जानकारी नहीं मिलती. मेरी योजना है कि Python API के दस्तावेज़ को अलग तरीके से बनाया जा सके. इससे एपीआई को आसानी से समझा जा सकेगा और उसके फ़ंक्शन ज़्यादा साफ़ हो जाएंगे. मेरा मकसद अलग-अलग इलाकों में इस्तेमाल किए जाने वाले काम के 3D ग्राफ़िक कॉन्सेप्ट के लिंक भी जोड़ना है (उदाहरण: Camera में इस्तेमाल किया जाने वाला इंट्रिंसिक मैट्रिक्स)
C++ API से जुड़े दस्तावेज़ को पूरा करें. फ़िलहाल, C++ दस्तावेज़ में Python दस्तावेज़ के मुकाबले ऐसी कोई docस्ट्रिंग नहीं है. मुझे क्लास और उनसे जुड़े सदस्य के फ़ंक्शन और डेटा सदस्यों के बारे में पूरी जानकारी देनी है .
कोर डेटा स्ट्रक्चर के हाई और लो लेवल के दस्तावेज़. मेरा मकसद अलग-अलग डेटा स्ट्रक्चर के कोड को समझना है, जैसे कि TriangleMesh, LineSet, OcT साथ ही, ट्यूटोरियल को बेहतर बनाकर, स्ट्रक्चर में शामिल इस्तेमाल और सिद्धांतों के बारे में बड़े लेवल के दस्तावेज़ उपलब्ध कराएं. मैं आपको इसके इस्तेमाल से जुड़े उदाहरण की जानकारी देने के साथ-साथ, स्ट्रक्चर में शामिल सिद्धांतों के लिए काम के लिंक भी दूंगा. अगर समय मिले, तो मैं ज़्यादा आसान कामों पर काम करूंगा. जैसे, कुछ टास्क कैसे पूरे किए जाएं, इसकी जानकारी देना, ताकि नए उपयोगकर्ताओं को सॉफ़्टवेयर का इस्तेमाल करने में मदद मिल सके.
प्रोजेक्ट शेड्यूल-
1 अगस्त से 1 सितंबर:
मेरे मेंटॉर को जानें. कोडबेस के अलग-अलग हिस्सों में, ज़रूरी दस्तावेज़ के लेवल के बारे में गहराई से चर्चा करें. साथ ही, इस बात पर भी चर्चा करें कि लो लेवल बनाम हाई लेवल के दस्तावेज़ों के मामले में आपको गहराई से बातचीत कैसे करनी चाहिए. मुझे कोडबेस को समझने और कॉन्सेप्ट को समझने में भी इस समय का समय मिलेगा, ताकि मैं उन्हें बेहतर तरीके से दर्ज कर सकूं.
पहला और दूसरा हफ़्ता:
मैं योगदान देने वालों की गाइड को अपडेट करके उसका समय बढ़ा दूंगा. मैं सोर्स कोड बनाने के तरीकों से जुड़े दस्तावेज़ों में सुधार करूंगा. हम दस्तावेज़ वाले सेक्शन में एक सेक्शन भी जोड़ देंगे. इसमें बताया जाएगा कि योगदान देने वाले नए लोग, दस्तावेज़ में किस तरह मदद कर सकते हैं. मैं सोर्स कोड बनाने के बारे में सिलसिलेवार तरीके से बताने वाला एक YouTube वीडियो भी बनाऊंगा.
तीसरा से पांचवां हफ़्ता:
मैं Python API को बढ़ाने पर काम करूंगा. मौजूदा सदस्यों को नए तरीके से लिखें और उनकी ज़्यादा जानकारी देने वाला दस्तावेज़ लिखें. हम मिलते-जुलते कॉन्सेप्ट के लिए काम के लिंक भी जोड़ेंगे, ताकि लोग इन कॉन्सेप्ट को बेहतर तरीके से समझ सकें.
छठा से 8 हफ़्ता:
मौजूदा C++ दस्तावेज़, लाइब्रेरी के ज़्यादातर हिस्से में अधूरे हैं. इसलिए, मुझे C++ दस्तावेज़ों को भरने में ज़्यादा समय लगेगा
9 से 11वां हफ़्ता:
इस दौरान, मैं मुख्य डेटा स्ट्रक्चर पर काम करूंगा. हर डेटा स्ट्रक्चर के ट्यूटोरियल दोबारा तैयार करें. साथ ही, हाई लेवल की खास जानकारी और इस्तेमाल के उदाहरण के बारे में दस्तावेज़ दें.
आखिरी हफ़्ता:
मैं 12 हफ़्ते की दस्तावेज़ों की अवधि के दौरान किए गए काम की आखिरी रिपोर्ट तैयार करने के लिए, आखिरी हफ़्ते का इस्तेमाल करूंगा/करूंगी. मुझे इस समय का इस्तेमाल दस्तावेज़ की समीक्षा करने और उसे पूरा करने में भी मदद मिलेगी.