DIPY प्रोजेक्ट

इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.

प्रोजेक्ट की खास जानकारी

ओपन सोर्स संगठन:

DIPY

टेक्निकल राइटर:

आरीशा तारिक

प्रोजेक्ट का नाम:

ऐप्लिकेशन को पूरी तरह से नए सिरे से बनाना और असली उपयोगकर्ताओं पर फ़ोकस करना

प्रोजेक्ट की अवधि:

स्टैंडर्ड अवधि (तीन महीने)

प्रोजेक्ट का विवरण

मैं एक सॉफ़्टवेयर इंजीनियर हूं और मुझे तकनीकी लेखन में महारत हासिल है. मेरे पास अच्छी क्वालिटी के सॉफ़्टवेयर दस्तावेज़, उपयोगकर्ता गाइड, मैन्युअल, और प्रोजेक्ट के ब्यौरे लिखने का चार साल से ज़्यादा का अनुभव है. मेरा घर इस्लामाबाद, पाकिस्तान (टाइमज़ोन: यूटीसी + 5) में है. फ़िलहाल, मैं Outreachy में इंटर्न के तौर पर काम कर रही हूं. यह इंटर्नशिप 18 अगस्त तक चलेगी. मैंने OpenELIS Global संगठन में, टेक्निकल राइटर के तौर पर Docs के Google सीज़न में हिस्सा लिया है. मूल दस्तावेज़ फ़्रेंच में था, सीमित था, और पुराना था. इसलिए, मैंने असली उपयोगकर्ता के लिए, अंग्रेज़ी में पूरी जानकारी वाला और अपडेट किया गया दस्तावेज़ तैयार किया. मुझे मई से अगस्त 2020 के बीच, Open Food Facts सर्वर के बैकएंड डेवलपर के तौर पर, Perl &Raku संगठन में आउटरीची प्रोग्राम में चुना गया. बैक-एंड डेवलपमेंट के अलावा, इस इंटर्नशिप का एक मुख्य काम, POD फ़ॉर्मैट में मॉड्यूल और फ़ंक्शन के लिए दस्तावेज़ बनाना है. मैंने पिछले साल ओपन-सोर्स की दुनिया में कदम रखा था. मैंने कुछ ओपन-सोर्स प्रोजेक्ट में योगदान दिया और बाद में Google Season of Docs में हिस्सा लिया. इस साल, मुझे Outreachy में चुना गया. यह प्रोग्राम, ओपन सोर्स और मुफ़्त सॉफ़्टवेयर में अलग-अलग तरह के लोगों को शामिल करने के लिए काम करता है. मेरे पास Git का अच्छा ज्ञान है, क्योंकि मेरा Outreachy प्रोजेक्ट GitHub पर होस्ट किया गया है. साथ ही, मार्च से मैं Open Food Facts और Mozilla Fenix में नियमित तौर पर योगदान दे रही हूं. मैं पिछले तीन सालों से Linux का इस्तेमाल कर रहा हूं और तब से टर्मिनल कमांड का इस्तेमाल कर रहा हूं.

मैंने दस्तावेज़ बनाने के लिए, Sphinx, Read the docs, और Markdown जैसे टूल और भाषाओं का इस्तेमाल किया है. मुझे यह आइडिया पसंद आया है और मैं इस पर काम करना चाहता/चाहती हूं. इसकी वजह यह है कि मेरे पास इस तरह के काम का अनुभव है. साथ ही, मुझे अपनी जानकारी और कौशल का इस्तेमाल करके, DIPY में योगदान देना अच्छा लगेगा. मेरे पास डिजिटल इमेज प्रोसेसिंग, कंप्यूटर विज़न, और मशीन लर्निंग के क्षेत्र में अनुभव है. इससे मुझे न्यूरोइमेजिंग को बेहतर तरीके से समझने और दस्तावेज़ बनाने में मदद मिलेगी. मुझे मेडिकल के क्षेत्र में काफ़ी अनुभव है. मैंने डॉक्टरों, मरीज़ों, लैबोरेट्री, और एम्बुलेंस ड्राइवरों के लिए एक मेडिकल वेबसाइट बनाई है. मैंने एक ऐसे सिस्टम पर काम किया था जिसका इस्तेमाल डॉक्टर, मरीज़, नर्स, लैब असिस्टेंट, और रिसर्चर करते हैं. इससे मुझे ऐसा दस्तावेज़ बनाने में मदद मिलेगी जिसे दर्शक आसानी से समझ सकें.

मैंने DIPY का दस्तावेज़ पढ़ लिया है और उसमें कई खामियां पाई हैं. दस्तावेज़ में कई खामियां हैं, जिन्हें बेहतर बनाने के लिए मेरी योजना है. दस्तावेज़ की मौजूदा स्थिति: दस्तावेज़ में कोई खास स्ट्रक्चर और डिज़ाइन नहीं है इसमें नेविगेट करना, खास तौर पर नए उपयोगकर्ताओं के लिए मुश्किल और समय लेने वाला हो सकता है उपयोगकर्ताओं को गाइड से जानकारी पाने में मुश्किल हो सकती है दस्तावेज़ के कॉन्टेंट को बेहतर बनाने की ज़रूरत है नए उपयोगकर्ता के तौर पर, मुझे उपयोगकर्ता गाइड और डेवलपर गाइड को ऐक्सेस करने में मुश्किल हुई. दस्तावेज़ को इस तरह से फिर से तैयार करना होगा कि उपयोगकर्ता को ज़रूरी जानकारी आसानी से मिल सके दस्तावेज़ में एक जैसी जानकारी नहीं दी गई है

मेरा प्लान है कि मैं ये काम करूं:

दस्तावेज़ के लिए एक खास स्ट्रक्चर और टेंप्लेट तय करें दस्तावेज़ का आकार बदलें, ताकि उपयोगकर्ता आसानी से ज़रूरी जानकारी देख सकें और नेविगेट कर सकें आगे के दस्तावेज़ों के काम में समुदाय को जोड़े रखने के लिए रोडमैप या काम आइटम की सूची तैयार करें गाइड के लिए टेंप्लेट तय करें उपयोगकर्ता गाइड को फिर से लिखें, फिर से स्ट्रक्चर करें और अपडेट करें दस्तावेज़ को दोबारा लिखने, फिर से स्ट्रक्चर करने और अपडेट करने से जुड़े दस्तावेज़ को एक जैसा बनाने में नए उपयोगकर्ताओं को एक जैसा काम करने में मदद करने से जुड़ा

उपयोगकर्ता के लिए गाइड:

उपयोगकर्ता गाइड के लिए, मैं आसान और आसान भाषा के इस्तेमाल पर ध्यान दूंगा, ताकि उपयोगकर्ता सबसे जटिल सिस्टम को भी समझ सकें. बेहतर उपयोगकर्ता अनुभव के लिए, ऐसे शब्दों, संक्षिप्त शब्दों, और अंदरूनी जानकारी का इस्तेमाल नहीं किया जाना चाहिए जिनके बारे में नए उपयोगकर्ता को शायद पता न हो. हम विज़ुअल कॉन्टेंट का भी इस्तेमाल करेंगे. इसमें इमेज, एनोटेट किए गए स्क्रीनशॉट, ग्राफ़िक, और वीडियो शामिल हैं. इनसे उपयोगकर्ता को यह तुरंत पता चलता है कि सिस्टम कैसे काम करता है. अच्छे दस्तावेज़ में हेडिंग और सब-हेडिंग की हैरारकी होनी चाहिए, ताकि उपयोगकर्ता को पता चल सके कि हर सेक्शन में क्या दिखेगा. साथ ही, यह हैरारकी एक लॉजिकल फ़्लो के हिसाब से होनी चाहिए, ताकि उपयोगकर्ता को सिस्टम का इस्तेमाल करने में आसानी हो. इस प्रोजेक्ट का एक मुख्य मकसद, सुलभ कॉन्टेंट बनाना होगा. सभी दस्तावेज़ और गाइड एक ही स्टाइल में होंगे. एक से ज़्यादा दस्तावेज़ों में एक जैसे फ़ॉन्ट और एक-दूसरे से मिलते-जुलते रंगों का इस्तेमाल करना ज़रूरी है. हम यह पक्का करेंगे कि उपयोगकर्ताओं के पास, सिस्टम का इस्तेमाल करने के बारे में संगठन के ज़्यादा से ज़्यादा संसाधनों का ऐक्सेस हो.

डेवलपर गाइड:

डेवलपर गाइड में, ज़्यादा जानकारी और रेफ़रंस के लिए कॉन्टेंट शामिल होता है. इससे डेवलपर को DIPY के सोर्स कोड में योगदान देने में मदद मिलती है. यह आपके लिए उपलब्ध अलग-अलग विकल्पों को दिखाने की कोशिश करता है, ताकि आप अपनी ज़रूरत के हिसाब से सही तरीका अपना सकें. डेवलपमेंट गाइड को फिर से तैयार और व्यवस्थित करने की ज़रूरत है. मैं डेवलपर गाइड का कॉन्टेंट फिर से लिखूंगा. इसमें, डिपेंडेंसी बनाने, योगदान देने से जुड़ी गाइड, स्टाइल गाइड, कोडिंग के नियम, दस्तावेज़ से जुड़ी गाइड, डेवलपमेंट एनवायरमेंट इंस्टॉल करने, डीबग करने, जांच करने से जुड़ी गाइड, और इससे जुड़ी अन्य चीज़ें शामिल की जाएंगी. साथ ही, डेवलपर के लिए इन्हें आसानी से ऐक्सेस किया जा सकेगा. जब योगदान देने वाले नए लोग आपके प्रोजेक्ट पर अपना पहला ओपन सोर्स योगदान देने आते हैं, तो वे योगदान देने वाले दिशा-निर्देशों पर भरोसा करके अपना गाइड बनते हैं. इसलिए, दिशा-निर्देश पढ़ने में आसान होने चाहिए. साथ ही, ये पूरी और समझने में आसान होंगे. योगदान देने से जुड़ी गाइड, काम के दस्तावेज़ होते हैं. इनसे यह पता चलता है कि लोग ओपन-सोर्स प्रोजेक्ट में योगदान कैसे दे सकते हैं. प्रोजेक्ट में योगदान देने की प्रोसेस को उपयोगकर्ताओं के लिए, जितना हो सके उतना आसान और पारदर्शी बनाया जाना चाहिए. चाहे, वह: गड़बड़ी ठीक करने के लिए सुझाव सबमिट करना हो गड़बड़ी की शिकायत करना हो मेंटेनर बनना हो कोड की मौजूदा स्थिति के बारे में बातचीत करना हो नई सुविधाओं का सुझाव देना हो

TEMPLATE

यह योगदान से जुड़ी गाइड के लिए इस्तेमाल किए जा सकने वाले टेंप्लेट में से एक है. इसमें बदलाव किया जा सकता है और दस्तावेज़ की ज़रूरतों के हिसाब से सेक्शन जोड़े या हटाए जा सकते हैं.

DIPY में योगदान देना

• वेलकम नोट

TOC

आचार संहिता

• हमारे स्टैंडर्ड
• ऐसे व्यवहार के उदाहरण जो सकारात्मक माहौल बनाने में मदद करते हैं
• प्रतिभागियों के गलत व्यवहार के उदाहरण
• हमारी ज़िम्मेदारियां
• प्रोजेक्ट मेंटेन करने वालों की ज़िम्मेदारियां
• दायरा

आचार संहिता का दायरा

मुझे मदद करने के लिए क्या जानना चाहिए?

अगर आपको कोड में योगदान देना है, तो हमारे प्रोजेक्ट में [insert list of programming languages, frameworks, or tools that your project uses] का इस्तेमाल किया जाता है. अगर आपको अभी कोड में योगदान नहीं देना है, तो कोई बात नहीं! इसके अलावा, दस्तावेज़ से जुड़ी समस्याएं [link to the docs label or tag on your issue tracker] या डिज़ाइन से जुड़ी ऐसी समस्याएं भी देखी जा सकती हैं जिनमें हमें डिज़ाइन से जुड़ी समस्याएं आ रही हैं [link todesign label or tag on issue tracker on if your प्रोजेक्ट life issues]. अगर आपको कोड में योगदान देना है और हमारी इस्तेमाल की जाने वाली टेक्नोलॉजी के बारे में ज़्यादा जानना है, तो नीचे दी गई सूची देखें. ऐसे संसाधनों (ट्यूटोरियल, वीडियो, किताबें) की सूची शामिल करें जिनका इस्तेमाल करके, नए योगदान देने वाले लोग यह जान सकें कि प्रोजेक्ट में योगदान देने के लिए, उपयोगकर्ताओं को क्या जानना चाहिए.

डेवलपमेंट एनवायरमेंट सेट अप करना

इस सेक्शन में, मैं इंस्टॉल करने की प्रोसेस और उन डिपेंडेंसी को जोड़ूंगा जिन्हें इंस्टॉल करना ज़रूरी है. $project इंस्टॉल करने के लिए, यह कमांड चलाएं: install project

• सोर्स कोड: github.com/$project/$project
• समस्या को ट्रैक करने वाला टूल: github.com/$project/$project/issues

सहयोग करने का तरीका

किसी गड़बड़ी की शिकायत करने का तरीका

• गड़बड़ी की रिपोर्ट सबमिट करने से पहले
• मैं गड़बड़ी की अच्छी रिपोर्ट कैसे सबमिट करूं?

बदलाव सबमिट करने का तरीका

• पुल के अनुरोध के प्रोटोकॉल
• टीम का जवाब
• जवाब देने में लगने वाला समय

सुविधा को बेहतर बनाने का अनुरोध करने का तरीका

• बेहतर बनाने का सुझाव सबमिट करने से पहले
• मैं A (अच्छा) बेहतर सुझाव कैसे सबमिट करूं?

आपका पहला कोड योगदान

• शुरुआत करने वालों से जुड़ी समस्याएं
• जिन समस्याओं के लिए मदद चाहिए #### पुल का अनुरोध
• पुल अनुरोध बनाने की प्रोसेस
• पुष्टि करें कि स्थिति की सभी जांच पूरी हो रही हैं.

अगर स्थिति की जांच पूरी नहीं हो पा रही है, तो क्या होगा?

• राइटिंग टेस्ट
• टेस्ट कवरेज

स्टाइल गाइड

• Git कमिट मैसेज
• स्टैंडर्ड स्टाइल

सहायता

अगर आपको कोई समस्या आ रही है, तो कृपया हमें बताएं. अगर आपको मदद चाहिए, तो हमारी मेलिंग सूची पर सवाल पूछें. यह सूची यहां दी गई है: [e-mail], IRC चैट या [list any other communication platforms that your project uses].

लाइसेंस

इस सेक्शन में, प्रोजेक्ट के लाइसेंस के बारे में बताया जाएगा.

समय प्रतिबद्धता और संचार:

मैं हर हफ़्ते 45 से ज़्यादा घंटे काम करूंगा. हालांकि, किसी भी तरह की समस्या होने पर, मैं उन घंटों को शनिवार और रविवार को पूरा करूंगा. कम्यूनिटी बॉन्ड की अवधि के दौरान, मैं अपने मेंटर के साथ बातचीत के तरीकों के बारे में चर्चा करूंगा. साथ ही, हर हफ़्ते होने वाली मीटिंग, मीटिंग के तरीके, और उन मीटिंग के समय को तय करूंगा. मैं अपने काम के बारे में अपने मेंटर को अप-टू-डेट रखूंगा. साथ ही, अपने काम की जानकारी ईमेल के ज़रिए अपने मेंटर के साथ शेयर करूंगा. मैं बातचीत के लिए TeamViewer का इस्तेमाल करना पसंद करूंगा, क्योंकि इसका इस्तेमाल करना आसान है. साथ ही, इसमें स्क्रीन शेयर करने जैसी कई सुविधाएं भी हैं.