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