इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- INCF
- टेक्निकल राइटर:
- hq
- प्रोजेक्ट का नाम:
- ओपन न्यूरोसाइंस के लिए, LORIS ट्रेनिंग दस्तावेज़
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
I. खास जानकारी
लॉन्गिट्यूडिनल ऑनलाइन रिसर्च ऐंड इमेजिंग सिस्टम (एलओआरआईएस), न्यूरोइमेजिंग रिसर्च के लिए वेब-फ़ेसिंग प्रोजेक्ट मैनेजमेंट प्लैटफ़ॉर्म है. यह ओपन साइंस की कई पहलों का समर्थन करता है. दस्तावेज़, LORIS में अहम भूमिका निभाते हैं. खास तौर पर, दस्तावेज़ से LORIS के उपयोगकर्ताओं और डेवलपर को सॉफ़्टवेयर की जानकारी समझने में मदद मिलती है. इससे वे प्लैटफ़ॉर्म का बेहतर तरीके से इस्तेमाल कर सकते हैं या सॉफ़्टवेयर के डेवलपमेंट में योगदान दे सकते हैं. इस दौरान, LORIS दस्तावेज़ भी अपडेट किए जाने चाहिए. इस प्रोजेक्ट का मकसद, LORIS के दस्तावेज़ों को बेहतर बनाना है.
II. वर्तमान स्थिति
फ़िलहाल, LORIS सभी दस्तावेज़ों को होस्ट करने के लिए, Github Wiki, Read the Docs, और LORIS.ca वेबसाइट का इस्तेमाल करता है. खास तौर पर, LORIS GitHub Wiki, सबसे बड़ी संख्या में LORIS दस्तावेज़ों को होस्ट करता है. साथ ही, अलग-अलग LORIS ट्यूटोरियल, प्रज़ेंटेशन, उपयोगकर्ता गाइड, और सिलसिलेवार तरीके से दिए गए निर्देश, अलग-अलग प्लैटफ़ॉर्म पर होस्ट किए जाते हैं . LORIS के मौजूदा दस्तावेज़ में, LORIS के डेवलपर और उपयोगकर्ताओं के लिए गाइड दी गई हैं. हालांकि, इसे और बेहतर बनाने और व्यवस्थित करने से फ़ायदा हो सकता है. खास तौर पर, दस्तावेज़ के अपडेट और तकनीकी जानकारी में सुधार करने से.
III. कम्यूनिटी को मिलने वाले फ़ायदे
ओपन न्यूरोसाइंस के लिए, LORIS के ट्रेनिंग दस्तावेज़ों को बेहतर बनाने से, रिसर्चर और डेवलपर को ज़्यादा उपयोगकर्ता-अनुकूल टूल का फ़ायदा मिलेगा. इससे वे अपनी स्टडी में डेटा इकट्ठा करने की प्रोसेस को बेहतर बना पाएंगे. खास तौर पर, इस प्रोजेक्ट से LORIS के इंस्टॉलेशन/सेटअप से जुड़े दस्तावेज़ों को अपडेट और बेहतर बनाया जा सकता है. साथ ही, नए उपयोगकर्ताओं को ट्रेनिंग देने वाले असली उपयोगकर्ता के लिए उपलब्ध कॉन्टेंट को भी बेहतर बनाया जा सकता है. इसके अलावा, इस प्रोजेक्ट का मकसद, माइग्रेट करने में मदद करना और LORIS GitHub wiki के दस्तावेज़ को अपडेट करके, 'Docs पढ़ें' के तौर पर अपडेट करना है. हालांकि, हो सकता है कि प्रोजेक्ट में डेटा के संबंधों के बारे में बताने और आर्किटेक्चर विज़ुअलाइज़ेशन को बेहतर बनाने के लिए, डेटाबेस डायग्राम उपलब्ध कराया जाए. आखिर में, इस प्रोजेक्ट से लोगों को LORIS, ओपन साइंस के संदर्भ, और इसके इस्तेमाल के उदाहरणों के बारे में बताने वाले कॉन्टेंट को अपडेट और बेहतर बनाया जाएगा.
IV. प्रोजेक्ट के लिए आपकी व्यक्तिगत खूबियां
पिछले कुछ सालों में, मैंने कई तकनीकी प्रोजेक्ट में हिस्सा लिया है. इनसे मुझे तकनीकी लेखन में काफ़ी अनुभव मिला है. खास तौर पर, टीम के कई पिछले प्रोजेक्ट में दस्तावेज़ लिखने की ज़िम्मेदारी मेरी थी. मुझे लगता है कि मेरे पास Read the Docs, Sphinx, Mkdocs, markdown, LaTeX वगैरह जैसे तकनीकी लेखन टूल इस्तेमाल करने का काफ़ी अनुभव है. साथ ही, STEM कोर्स में पढ़ाने के मेरे पिछले अनुभव से, तकनीकी बातचीत में मेरी स्किल भी बेहतर हुई है. INCF के साथ मिलकर, मस्तिष्क विज्ञान से जुड़े ओपन प्रोजेक्ट के लिए LORIS ट्रेनिंग दस्तावेज़, मेरे लिए एक बेहतरीन अवसर होगा. इन दस्तावेज़ों की मदद से, मैं LORIS में तकनीकी लेखन की अपनी तकनीकों को लागू कर पाऊंगा. इसके अलावा, मेरी दिलचस्पी न्यूरोइमेजिंग के क्षेत्र में है. इसलिए, मैं इस क्षेत्र में अपने तकनीकी ज्ञान को लागू करने के अवसर ढूंढ रहा हूं. INCF के साथ, रीप्रोड्यूस किए जा सकने वाले न्यूरोसाइंस प्रोजेक्ट के लिए, LORIS ट्रेनिंग दस्तावेज़ मेरे लिए एक अहम अनुभव होगा.
V. डिलीवर किए जाने वाले कॉन्टेंट का फ़ॉर्मैट
- मौजूदा LORIS दस्तावेज़ों को माइग्रेट और अपडेट करना
- LORIS के इंस्टॉलेशन/सेटअप से जुड़े दस्तावेज़ों की समीक्षा करना, उन्हें अपडेट करना, और बेहतर बनाना. साथ ही, नए उपयोगकर्ताओं को ट्रेनिंग देने वाले असली उपयोगकर्ता के लिए उपलब्ध कॉन्टेंट में मौजूद अंतर को पूरा करना
- डेटाबेस डायग्राम जनरेट करने में मदद करता है, ताकि डेटा के बीच के संबंधों (जैसे, विषय, स्टडी विज़िट) को बताया जा सके और आर्किटेक्चर विज़ुअलाइज़ेशन को बेहतर बनाया जा सके
- LORIS API के दस्तावेज़ को अपडेट और बेहतर बनाने में मदद करना
- लोगों को LORIS, उसके ओपन साइंस कॉन्टेक्स्ट, और उसके इस्तेमाल के उदाहरणों के बारे में बताने वाले कॉन्टेंट को अपडेट और बेहतर बनाने में मदद करना. इसमें अलग-अलग मीडिया फ़ॉर्मैट का इस्तेमाल किया जाएगा
VI. टाइमलाइन
कम्यूनिटी बॉन्डिंग (17 अगस्त से 13 सितंबर) a) LORIS सॉफ़्टवेयर और टीम वर्कफ़्लो के बारे में पूरी जानकारी पाना. b) LORIS के इंस्टॉलेशन/सेटअप से जुड़े दस्तावेज़ की समीक्षा करना, उन्हें अपडेट करना, और बेहतर बनाना.
पहला हफ़्ता (14 सितंबर से 20 सितंबर) LORIS के दस्तावेज़ों को GitHub के विकी से Read the Docs पर अपडेट और माइग्रेट करना.
दूसरा हफ़्ता (21 सितंबर से 27 सितंबर) a) असली उपयोगकर्ता के लिए एलओआरआईएस से जुड़े मौजूदा कॉन्टेंट की समीक्षा करना. b) मौजूदा दस्तावेज़ों के आधार पर, नए उपयोगकर्ताओं को ट्रेनिंग देने वाले LORIS के असली उपयोगकर्ताओं के लिए उपलब्ध कॉन्टेंट में मौजूद अंतर को भरना शुरू करें.
तीसरा हफ़्ता (28 सितंबर - 4 अक्टूबर) नए उपयोगकर्ताओं को ट्रेनिंग देने वाले LORIS के असली उपयोगकर्ता के लिए उपलब्ध कॉन्टेंट में मौजूद गैप को पूरा करें.
चौथा हफ़्ता (5 अक्टूबर से 11 अक्टूबर) a) LORIS के मौजूदा डेटाबेस आर्किटेक्चर को समझना. b) LORIS प्लैटफ़ॉर्म के लिए डेटाबेस डायग्राम लागू करना शुरू करना.
पांचवां हफ़्ता (12 अक्टूबर - 18 अक्टूबर) a) LORIS डेटाबेस डायग्राम जनरेट करने का टास्क पूरा करें. b) मौजूदा LORIS एपीआई की समीक्षा करें और एपीआई दस्तावेज़ को बेहतर बनाने में मदद करें.
छठा हफ़्ता (19 अक्टूबर से 25 अक्टूबर) LORIS API के दस्तावेज़ को बेहतर बनाने पर काम जारी रखना.
सातवां हफ़्ता (26 अक्टूबर - 1 नवंबर) LORIS API के दस्तावेज़ को बेहतर बनाएं.
आठवां हफ़्ता (2 नवंबर से 8 नवंबर) लोरिस के बारे में लोगों को बताने वाले मौजूदा कॉन्टेंट की समीक्षा करें. साथ ही, ओपन साइंस के कॉन्टेक्स्ट को अपडेट और बेहतर बनाएं.
नौवां हफ़्ता (9 नवंबर से 15 नवंबर) लोरिस के बारे में लोगों को बताने वाले कॉन्टेंट में, ओपन साइंस के संदर्भ में अपडेट और सुधार करें.
10वां हफ़्ता (16 नवंबर से 22 नवंबर) एलओआरआईएस के बारे में लोगों के बारे में जानकारी देने वाले कॉन्टेंट में, इस्तेमाल के उदाहरणों को अपडेट करने और उन्हें बेहतर बनाने में मदद करें.
11वां हफ़्ता (23 नवंबर से 29 नवंबर) लोगों को LORIS से रूबरू कराने वाले कॉन्टेंट के इस्तेमाल के सभी उदाहरणों को अपडेट करें और उनमें सुधार करें.
प्रोजेक्ट पूरा करना (30 नवंबर से 5 दिसंबर) a) मैंने जो दस्तावेज़ बनाए हैं उन्हें हटाना. b) GitHub पर बनाए गए सभी पुल रिक्वेस्ट मर्ज करना और मैंने जो समस्याएं बताई हैं उन्हें ठीक करना. c) प्रोजेक्ट की आखिरी रिपोर्ट तैयार करना और उसे Google को सबमिट करना.
VII. आने वाले समय के लिए डिलीवर की जाने वाली सेवाएं
Google Season of Docs 2020 के बाद, मैं LORIS के दस्तावेज़ों में अपना योगदान देना जारी रखना चाहता/चाहती हूं. खास तौर पर, मुझे LORIS के डेवलपर के साथ नई रिलीज़ के लिए दस्तावेज़ अपडेट करने और बनाने की संभावना के बारे में बात करनी है. इसके अलावा, मुझे Google Season of Docs प्रोजेक्ट के दौरान बनाए गए दस्तावेज़ों की समीक्षा करने के लिए कुछ और समय चाहिए. साथ ही, यह भी देखना है कि इनमें सुधार की कोई जगह है या नहीं. आखिर में, मेरे पास इंजीनियरिंग की बैकग्राउंड है. इसलिए, आने वाले समय में मैं LORIS सॉफ़्टवेयर के दूसरे पहलुओं में योगदान देने के लिए तैयार हूं. जैसे, सॉफ़्टवेयर डेवलपमेंट.