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