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