DIPY प्रोजेक्ट

इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.

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

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

DIPY

तकनीकी लेखक:

अरीशा तारिक

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

बेहतर तरीके से स्ट्रक्चर करना और असली उपयोगकर्ताओं पर फ़ोकस

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

मानक अवधि (तीन महीने)

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

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

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

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

मुझे ये काम करने हैं:

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

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

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

डेवलपर गाइड:

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

TEMPLATE

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

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

• वेलकम नोट

TOC

आचार संहिता

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

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

मेरी मदद करने के लिए मुझे क्या जानने की ज़रूरत है?

अगर आपको कोड में योगदान देने के लिए मदद चाहिए, तो हमारा प्रोजेक्ट [insert list of प्रोग्रामिंग लैंग्वेज, फ़्रेमवर्क या टूल इस्तेमाल करें.] अगर आपको अभी तक कोड से योगदान नहीं देना है, तो कोई बात नहीं! आपके पास दस्तावेज़ से जुड़ी समस्याएं [दस्तावेज़ लेबल या समस्या को ट्रैक करने वाले टैग का लिंक] या डिज़ाइन से जुड़ी समस्याएं [अगर आपके प्रोजेक्ट के डिज़ाइन से जुड़ी समस्याएं ट्रैक होती हैं, तो समस्या के बारे में जानकारी देने वाले टैग का लिंक] भी देखा जा सकता है. अगर आपको कोड का योगदान करना है और हमारी ओर से इस्तेमाल की जाने वाली टेक्नोलॉजी के बारे में ज़्यादा जानना है, तो यहां दी गई सूची देखें. संसाधनों (ट्यूटोरियल, वीडियो, किताबें) की बुलेट वाली सूची शामिल करें. इन संसाधनों का इस्तेमाल करके, योगदान देने वाले नए लोग यह जान सकते हैं कि प्रोजेक्ट में योगदान देने के लिए, उपयोगकर्ताओं को किन बातों की जानकारी होनी चाहिए.

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

इस सेक्शन में, मुझे इंस्टॉल करने की ज़रूरी प्रोसेस और दूसरी चीज़ें जोड़नी होंगी. चलाकर $project इंस्टॉल करें: प्रोजेक्ट इंस्टॉल करें

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

योगदान करने का तरीका

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

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

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

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

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

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

कोड के ज़रिए आपका पहला योगदान

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

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

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

स्टाइल गाइड

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

सहायता

अगर आपको समस्याएं आ रही हैं, तो कृपया हमें बताएं. अगर आपको मदद चाहिए, तो हमारी ईमेल पाने वाले लोगों की सूची से सवाल पूछें. इस सूची में: [e-mail], IRC चैट या [आपके प्रोजेक्ट में इस्तेमाल होने वाले दूसरे कम्यूनिकेशन प्लैटफ़ॉर्म की सूची बनाएं].

लाइसेंस

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

समय की तय सीमा और बातचीत:

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