इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- अर्डुइनो
- तकनीकी लेखक:
- AghaSaad04
- प्रोजेक्ट का नाम:
- तीसरे पक्ष के दस्तावेज़ की लाइब्रेरी
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मैं एक अनुभवी तकनीकी लेखक हूं. मैं तीन साल से ज़्यादा समय से अच्छी क्वालिटी के सॉफ़्टवेयर दस्तावेज़, इस्तेमाल के लिए गाइड, मैन्युअल, एल्गोरिदम विश्लेषण, प्रोजेक्ट के दस्तावेज़, रिसर्च पेपर लिख रहा/रही हूं. इस प्रोजेक्ट में, मैं तीसरे पक्ष की सभी लाइब्रेरी का दस्तावेज़ तैयार करूंगा/करूंगी. मेरा लक्ष्य उन लाइब्रेरी का दस्तावेज़ तैयार करना है जो Arduino में बनी हैं और जिन्होंने इसमें योगदान दिया है, ताकि डेवलपर को इन लाइब्रेरी के बारे में ज़्यादा से ज़्यादा जानकारी मिल सके. मुझे ये टास्क पूरे करने होंगे:
लाइब्रेरी के काम का दस्तावेज़ बनाएं लाइब्रेरी को बेहतर बनाने का तरीका बताएं, ताकि वे ज़रूरत के हिसाब से काम कर सकें
उदाहरण के लिए
ऐसी स्थिति में, Arduino की NESController लाइब्रेरी के बारे में पूरे दस्तावेज़ मौजूद होने चाहिए. योगदान देने वालों के लिए, इसके दस्तावेज़ में इसकी सुविधाएं, साथ काम करने की सुविधा, उदाहरण, और ऐप्लिकेशन जोड़े जाने चाहिए. दस्तावेज़ में इस्तेमाल के बारे में पहले ही जानकारी दी गई है. इसमें काफ़ी सुधार किए जा सकते हैं. Nbiot-arduino, NBIoT मॉड्यूल ऐक्सेस करने वाली एक Arduino लाइब्रेरी है. इसके इस्तेमाल, बिल्ड और टेस्ट, और डीबग के विकल्पों को बढ़ाकर, इसके दस्तावेज़ को बेहतर बनाया जा सकता है. कोड स्निपेट वाले उदाहरण भी शामिल किए जाने चाहिए. Arduino की सबसे तारांकित लाइब्रेरी, ArduinoJson चैनल पर अपनी लाइब्रेरी को इस्तेमाल करने के उदाहरण मौजूद हैं. इनमें हर क्लास और फ़ंक्शन के बारे में जानकारी देने वाले एपीआई रेफ़रंस, अक्सर पूछे जाने वाले सवाल, जो हर सवाल का जवाब देते हैं, और अपने उपयोगकर्ताओं के लिए प्रोग्राम लिखने वाली AduinoJson Assistant, दस्तावेज़ों में शामिल हैं. इसी तरह, उन सभी लाइब्रेरी के लिए ज़्यादा जानकारी वाले दस्तावेज़ अपलोड किए जाने चाहिए जिनके दस्तावेज़ों में सुधार करने और उन्हें बढ़ाने की ज़रूरत है. इंटरनेट ऑफ़ थिंग्स (IoT) के क्षेत्र में काम करने का अनुभव होने पर, मुझे माइक्रो-कंट्रोलर के बारे में बुनियादी जानकारी है. मुझे Python, Java, C, C++, HTML5, JavaScript, और C# जैसी कई प्रोग्रामिंग भाषाओं में महारत हासिल है. मुझे अपने तकनीकी लेखन कौशल और इलेक्ट्रॉनिक्स, माइक्रो-कंट्रोलर, प्रोग्रामिंग की जानकारी के ज़रिए Arduino में योगदान देने में मेरी दिलचस्पी है. मुझे ज़्यादा जानकारी पाने के साथ-साथ, अपने कौशल और जानकारी को बेहतर बनाना है.
इस्तेमाल में आसान सिंटैक्स और कई तरह की सुविधाओं की वजह से, मुझे अपने हर कॉन्टेंट को स्टाइल देने के लिए Markdown का इस्तेमाल करना है.
टेंप्लेट
यह उन टेंप्लेट में से एक है जिसका इस्तेमाल दस्तावेज़ बनाने के लिए किया जा सकता है. इसमें बदलाव किया जा सकता है और दस्तावेज़ की ज़रूरतों के मुताबिक नए सेक्शन जोड़े जा सकते हैं.
$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 से ज़्यादा घंटे देती हूं, लेकिन किसी समस्या की स्थिति में, मैं वीकेंड में उन घंटों का पेमेंट करूंगी.कम्यूनिटी बॉन्ड पीरियड के दौरान, मैं बातचीत के तरीकों के बारे में चर्चा करूंगा/करूंगी और अपने मेंटॉर के साथ हर हफ़्ते होने वाली मीटिंग, साधन, और समय को तय करूंगा/करूंगी. मैं अपने मेंटॉर को अपने काम के बारे में अप-टू-डेट रखूंगा. साथ ही, ईमेल के ज़रिए अपने काम की जानकारी, मेरे मेंटॉर के साथ शेयर करूंगा/करूंगी. बातचीत करने के लिए, मुझे टीम व्यूअर पसंद है. ऐसा इसलिए है, क्योंकि स्क्रीन शेयर करने जैसी कई सुविधाओं के साथ इसे इस्तेमाल करना आसान है.
आने वाले समय के लिए प्लान
GSoD’19 के बाद, आने वाले समय के लिए मेरे प्लान काफ़ी समझ आए. मैं दूसरे प्रोजेक्ट में भी संगठन के लिए योगदान देना जारी रखूंगा. मेरी कोशिश रहेगी कि दस्तावेज़ के तरीके से लेकर सुरक्षा के नज़रिए से इसे हर तरह से बेहतर बनाए जाए. अगर मुझे मौका मिलेगा, तो मैं संगठन की किसी भी मीटिंग में ज़रूर शामिल होूंगा.
नियम और शर्तें
मैं ऊपर बताए गए तरीके से काम करने के लिए सहमत हूं. साथ ही, किसी भी तरह का गर्भपात होने पर, मुझे इसके लिए ज़िम्मेदार माना जाएगा. मुझे पता है कि इस प्रोजेक्ट के लिए समर्पित रहने की कितनी ज़रूरत है, मैं आपको भरोसा दिलाता हूं कि मैं अपना पूरा सीज़न इस प्रोजेक्ट के लिए लगा रहा हूं, ताकि मैं बेहतरीन काम कर सकूं.
पूरा प्रस्ताव पढ़ने के लिए धन्यवाद. अगर आपका कोई और सवाल है, तो कृपया हमसे संपर्क करें.