इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Arduino
- टेक्निकल राइटर:
- AghaSaad04
- प्रोजेक्ट का नाम:
- तीसरे पक्ष की लाइब्रेरी का दस्तावेज़ बनाना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मैं एक अनुभवी तकनीकी लेखक हूं. मैं तीन साल से ज़्यादा समय से, अच्छी क्वालिटी के सॉफ़्टवेयर दस्तावेज़, उपयोगकर्ता गाइड, मैन्युअल, एल्गोरिदम का विश्लेषण, प्रोजेक्ट दस्तावेज़, और रिसर्च पेपर लिख रहा/रही हूं. इस प्रोजेक्ट में, मैं तीसरे पक्ष की सभी लाइब्रेरी का दस्तावेज़ बनाऊंगा. मेरा मकसद, Arduino की बनाई गई और योगदान वाली लाइब्रेरी का दस्तावेज़ बनाना है, ताकि डेवलपर उनकी पूरी क्षमता का इस्तेमाल कर सकें. मैं ये काम करूंगा/करूंगी:
लाइब्रेरी के काम करने के तरीके की जानकारी दें ज़रूरी ज़रूरतों के हिसाब से लाइब्रेरी को बेहतर बनाने का तरीका बताएं
उदाहरण के लिए
Arduino की NESController लाइब्रेरी के लिए, अच्छी तरह से दस्तावेज़ तैयार करना ज़रूरी है. योगदान देने वाले लोगों के लिए, दस्तावेज़ में इसकी सुविधाएं, काम करने के तरीके, उदाहरण, और ऐप्लिकेशन शामिल किए जाने चाहिए. दस्तावेज़ में, इस्तेमाल के बारे में पहले से ही बताया गया है. हालांकि, इसमें और भी सुधार किए जा सकते हैं. Nbiot-arduino, NBIoT मॉड्यूल को ऐक्सेस करने के लिए Arduino लाइब्रेरी है. इसके दस्तावेज़ को बेहतर बनाने के लिए, इसके इस्तेमाल, बिल्ड और टेस्ट, डीबग करने के विकल्पों को बढ़ाया जा सकता है. कोड स्निपेट वाले उदाहरण भी शामिल करने चाहिए. Arduino की सबसे स्टार वाली लाइब्रेरी ArduinoJson को ऐसे उदाहरणों के तौर पर देखा जा सकता है जिनमें अलग-अलग स्टेशन में लाइब्रेरी को इस्तेमाल करने का तरीका, एपीआई रेफ़रंस, जिसमें हर क्लास और फ़ंक्शन की जानकारी होती है, अक्सर पूछे जाने वाले सवाल और अपने उपयोगकर्ताओं के लिए प्रोग्राम लिखने वाले AduinoJson Assistant को शामिल किया गया है. इसी तरह, उन सभी लाइब्रेरी के लिए ज़्यादा जानकारी वाले दस्तावेज़ तैयार किए जाने चाहिए जिनके दस्तावेज़ों को बेहतर बनाने और उनमें ज़्यादा जानकारी जोड़ने की ज़रूरत है. इंटरनेट ऑफ़ थिंग्स (IoT) के क्षेत्र में काम करने का अनुभव होने की वजह से, मुझे माइक्रो-कंट्रोलर के बारे में बुनियादी जानकारी है. मुझे Python, Java, C, C++, HTML5, JavaScript, C# जैसी कई प्रोग्रामिंग भाषाओं का ज्ञान है. मुझे Arduino के लिए योगदान देने में काफ़ी दिलचस्पी है. इसके लिए, मैं अपनी तकनीकी लेखन कौशल और इलेक्ट्रॉनिक्स, माइक्रो-कंट्रोलर, प्रोग्रामिंग के बारे में अपनी जानकारी का इस्तेमाल करूंगा. मैं ज़्यादा जानने के साथ-साथ, अपने कौशल और जानकारी को बढ़ाने के लिए उत्सुक हूं.
मैं अपनी सभी लेखन शैली के लिए मार्कडाउन का इस्तेमाल करूंगा, क्योंकि इसका सिंटैक्स इस्तेमाल करना आसान है और इसमें कई सुविधाएं हैं.
टेंप्लेट
यह उन टेंप्लेट में से एक है जिनका इस्तेमाल दस्तावेज़ बनाने के लिए किया जा सकता है. इसमें बदलाव किया जा सकता है और दस्तावेज़ की ज़रूरतों के हिसाब से नए सेक्शन जोड़े जा सकते हैं.
$projectName/Library Name
--------
In this section, I will give background information of the library,
what does this library use, on what languages and framework it is based on,
what are the dependencies of this library/project where it will be used
Features
--------
I will add features of the project here like
- this library creates connection between server and client
- Make things faster
Installation
------------
In this section I will add the installation procedure and dependencies that
needs to be installed.
Install $project by running:
install project
Contribute
----------
For the contributors, I will add this section in documentation.
- Issue Tracker: github.com/$project/$project/issues
- Source Code: github.com/$project/$project
Support
-------
This section can also be added
If you are having issues, please let us know.
We have a mailing list located at: project@google-groups.com
License
-------
This section will tell about the license of the project.
This project is licensed under the BSD.
समय की प्रतिबद्धता और कम्यूनिकेशन
मैं हर हफ़्ते 45 से ज़्यादा घंटे काम करूंगा. हालांकि, अगर कोई समस्या आती है, तो मैं उन घंटों को शनिवार और रविवार को पूरा करूंगा. कम्यूनिटी बॉन्ड की अवधि के दौरान, मैं अपने मेंटर के साथ बातचीत के तरीकों के बारे में बातचीत करूंगा. साथ ही, हर हफ़्ते होने वाली मीटिंग, मीटिंग के तरीके, और उन मीटिंग के समय को तय करूंगा. मैं अपने काम के बारे में अपने मेंटर को अप-टू-डेट रखूंगा. साथ ही, अपने काम की जानकारी ईमेल के ज़रिए अपने मेंटर के साथ शेयर करूंगा. मैं बातचीत के लिए Team Viewer का इस्तेमाल करना पसंद करूंगा, क्योंकि इसका इस्तेमाल करना आसान है. साथ ही, इसमें स्क्रीन शेयर करने जैसी कई सुविधाएं भी हैं.
आने वाले समय के प्लान
GSoD 2019 के बाद, मेरे आने वाले समय के प्लान साफ़ तौर पर तय हैं. मैं संगठन के अन्य प्रोजेक्ट में भी योगदान देता/देती रहूंगा. मैं इसे दस्तावेज़ से लेकर सुरक्षा के सभी पहलुओं में बेहतर बनाने की कोशिश करूंगा. अगर मुझे कभी भी मौका मिलेगा, तो मैं संगठन की किसी भी मीटिंग में ज़रूर शामिल होऊंगा/होंगी.
नियम और शर्तें
मैं पूरी तरह से सहमत हूं कि मैं ऊपर बताए गए तरीके से काम करूंगा और अगर गर्भपात होता है, तो मुझे इसकी जवाबदेही लेनी होगी. मुझे पता है कि इस प्रोजेक्ट के लिए, पूरी तरह से समर्पित होना ज़रूरी है. हम आपको भरोसा दिलाते हैं कि हम इस प्रोजेक्ट के लिए अपना पूरा सीज़न समर्पित कर रहे हैं, ताकि हम सबसे अच्छा काम कर सकें.
पूरा प्रस्ताव पढ़ने के लिए धन्यवाद. अगर आपका कोई और सवाल है, तो कृपया हमसे संपर्क करें.