इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- OpenMRS
- टेक्निकल राइटर:
- इंद्रधनुष
- प्रोजेक्ट का नाम:
- नए डेवलपर के लिए, OpenMRS से जुड़े तकनीकी दस्तावेज़ों को बेहतर बनाना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
वजह
COVID-19 महामारी का असर दुनिया पर पड़ रहा है. यह बात और भी साफ़ है कि OpenMRS जैसा ओपन सोर्स मेडिकल रिकॉर्ड सिस्टम, इस तरह की मुश्किलों से निपटने में मददगार साबित हो सकता है. नए डेवलपर को OpenMRS के नेटवर्क पर नेविगेट करने, उन्हें शामिल करने की प्रोसेस को कम करने, और ज़्यादा से ज़्यादा नए लोगों को OpenMRS के डेवलपमेंट में तुरंत योगदान देने की अनुमति देने के लिए, कम शब्दों में, साफ़ तौर पर, और अप-टू-डेट दस्तावेज़ होना ज़रूरी है. नए डेवलपर के लिए, दो दस्तावेज़ मौजूद हैं: • डेवलपर के तौर पर शुरुआत करना • डेवलपर मैन्युअल हालांकि, कुछ कॉन्टेंट पुराने हैं और फ़ॉर्मैट को बेहतर बनाने की ज़रूरत है. इस प्रोजेक्ट का मकसद, कॉन्टेंट को अपडेट करना और इन दो दस्तावेज़ों के फ़ॉर्मैट को बेहतर बनाना है, ताकि इन दस्तावेज़ों को इस्तेमाल करना आसान हो सके.
दायरा
- इन दो दस्तावेज़ों के कॉन्टेंट को फिर से व्यवस्थित और फ़ॉर्मैट करें. 'डेवलपर के तौर पर शुरुआत करना' दस्तावेज़ के लिए: a. निर्देश के 17 चरणों को सेक्शन में बांटें, हर सेक्शन में कम चरण हों, ताकि उपयोगकर्ता को आसानी से फ़ॉलो किया जा सके. b. चरणों के क्रम को फिर से व्यवस्थित करें. कुछ चरणों को एक साथ किया जा सकता है. c. टेबल में अन्य विकी पेजों के लिंक दें, ताकि निर्देश कम शब्दों में और आसानी से पढ़े जा सकें.
डेवलपर मैन्युअल के लिए: a. शुरुआती कुछ चैप्टर में, OpenMRS के बैकग्राउंड की जानकारी को छोटा किया जा सकता है. ज़्यादा जानकारी के लिए, उपयोगकर्ताओं को OpenMRS.org पेज पर भेजा जा सकता है. b. सेट अप करने के चैप्टर को, डेवलपमेंट प्रोसेस वाले चैप्टर से पहले ऊपर लाया जाना चाहिए
कॉन्टेंट अपडेट करें. डेवलपर दस्तावेज़ के तौर पर शुरू करने के लिए: a. Linux और Windows के लिए एनवायरमेंट सेट अप को अपडेट करें (Docker का परिचय दें) b. IntelliJ और Eclipse के लिए IDE कॉन्फ़िगरेशन अपडेट करना. जहां भी लागू हो, डेवलपर मैन्युअल या डेवलपर गाइड का लिंक. d. पक्का करें कि लिंक किए गए सभी कॉन्टेंट अप-टू-डेट हों.
डेवलपर मैन्युअल के लिए: a. डेवलपमेंट वर्कफ़्लो के बारे में बताना. b. डेवलपमेंट टीमों को व्यवस्थित करने का तरीका बताएं. साथ ही, यह भी बताएं कि टीम के सदस्य एक साथ कैसे काम करते हैं. टीम मीटिंग और टीम की चर्चाओं के लिंक जोड़ें. नए डेवलपर को उन टीमों को ढूंढने में मदद करें जिनमें उन्हें शामिल होना है. c. सिस्टम सेटअप के चैप्टर में Docker जोड़ें. d. अलग-अलग तरह के मॉड्यूल (रेफ़रंस ऐप्लिकेशन मॉड्यूल, OWA मॉड्यूल, और प्लैटफ़ॉर्म मॉड्यूल) के बारे में ज़्यादा जानकारी जोड़ें. साथ ही, यह भी बताएं कि ये मॉड्यूल एक साथ कैसे काम करते हैं. हर तरह के मॉड्यूल को बनाने और डिप्लॉय करने का तरीका बताने के लिए, आसान उदाहरण कोड जोड़ें. f. हर तरह के मॉड्यूल के लिए, टेस्ट के आसान उदाहरण जोड़ें.
ऑडियंस का विश्लेषण
डेवलपर के तौर पर शुरुआत करने और डेवलपर मैन्युअल के तौर पर, टारगेट ऑडियंस उन डेवलपर के लिए है जिन्हें OpenMRS के बारे में कम या बिलकुल भी जानकारी नहीं है. डेवलपर दो तरह के हो सकते हैं: पहले तरह के डेवलपर, जूनियर डेवलपर होते हैं. इनके पास सॉफ़्टवेयर डेवलपमेंट का कम या कोई अनुभव नहीं होता. उदाहरण के लिए, ओपन सोर्स सॉफ़्टवेयर डेवलपमेंट के बारे में जानने के लिए, असल दुनिया के प्रोजेक्ट खोज रहे GSoC के छात्र-छात्राएं. इन डेवलपर के लिए, इन दोनों दस्तावेज़ों में ज़रूरत के मुताबिक जानकारी और रेफ़रंस होने चाहिए, ताकि वे अपने ज्ञान में कमी को पूरा कर सकें और कम समय में OpenMRS प्रोजेक्ट में योगदान दे सकें. जूनियर डेवलपर के मुख्य लक्ष्य ये हैं: 1. OpenMRS (MySQL, Java Spring) में हिस्सा लेने के लिए ज़रूरी स्किल के बारे में जानें. React.js, Git वगैरह) के बारे में जानें. साथ ही, इन स्किल को सीखने के लिए संसाधन ढूंढें. 2. OpenMRS समुदाय से जुड़ें और बातचीत करने के टूल के बारे में जानें. 3. एनवायरमेंट और आईडीई सेट अप करें. 4. OpenMRS SDK टूल इंस्टॉल करें. 5. डेवलपमेंट वर्कफ़्लो को समझें. 6. नए मॉड्यूल बनाने के लिए आसान कोड बनाएं. 7. नए मॉड्यूल डिप्लॉय करें. 8. टेस्ट मॉड्यूल. 9. Pull request करने के लिए, Git का इस्तेमाल करें. दूसरी तरह की ऑडियंस, मिड-लेवल डेवलपर या सीनियर डेवलपर हैं. ये अपने संगठन की ज़रूरतों के हिसाब से OpenMRS को कस्टमाइज़ करना चाहते हैं या OpenMRS में योगदान देना चाहते हैं. इन अनुभवी डेवलपर के लिए, इन दोनों दस्तावेज़ों में OpenMRS के बारे में खास जानकारी दी जानी चाहिए. साथ ही, इन दस्तावेज़ों की मदद से, डेवलपर को डेवलपर गाइड और अन्य संसाधनों में, टेक्नोलॉजी के बारे में ज़्यादा जानकारी दी जानी चाहिए. अनुभवी डेवलपर के मुख्य लक्ष्य ये हैं: 1. OpenMRS 2 के डेटा मॉडल और आर्किटेक्चर को समझना. OpenMRS कम्यूनिटी में शामिल हों और कम्यूनिकेशन टूल के बारे में जानें. 3. OpenMRS कोड रिपॉज़िटरी के लिंक ढूंढें. 4. इस बारे में ज़्यादा जानकारी वाले संसाधन पाएं.
प्रोजेक्ट प्लान
प्लानिंग का फ़ेज़: • 'दायरा' सेक्शन में सेट किए गए लक्ष्यों को बेहतर बनाएं • पुराने कॉन्टेंट की पहचान करें • दोनों दस्तावेज़ों के लिए आउटलाइन बनाएं • आउटलाइन को मेंटर और विषय के विशेषज्ञों (एसएमई) को दिखाएं • प्रोजेक्ट प्लान को अपडेट करें
कॉन्टेंट डेवलपमेंट का फ़ेज़ • Docker के बारे में जानें, इंस्टॉल करने के सभी चरणों को पूरा करें, और आसान उदाहरण कोड/टेस्ट कोड बनाएं • सवाल पूछने के लिए स्मॉल-मीडियम एंटरप्राइज़ (एसएमई) के साथ इंटरव्यू करें • दोनों दस्तावेज़ों का पहला ड्राफ़्ट तैयार करें
कॉन्टेंट की समीक्षा और पब्लिश करना • कॉन्टेंट में खुद बदलाव करना • समीक्षकों (मेंटर और स्मॉल एंटरप्राइज़) और असली उपयोगकर्ताओं को सुझाव/राय देने के लिए, ड्राफ़्ट भेजना • ड्राफ़्ट में बदलाव करना • दोनों दस्तावेज़ों को OpenMRS के विकी पेज पर पब्लिश करना. • प्रोजेक्ट रिपोर्ट लिखना
शुरुआती काम
मैंने Linux सिस्टम में डेवलपमेंट एनवायरमेंट सेट अप करने और OpenMRS SDK टूल सेट अप करने पर कुछ काम किया है. मैं आईडीई को कॉन्फ़िगर कर रहा/रही हूं. मेरे पास, आसान मॉड्यूल बनाने और टेस्ट कोड लिखने का काम जारी है.
रेफ़रंस और चर्चाएं
28500 2 https://https://www. https://. - उनकी