इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- ESLint
- टेक्निकल राइटर:
- खवार
- प्रोजेक्ट का नाम:
- कॉन्फ़िगरेशन दस्तावेज़ को फिर से व्यवस्थित करना या फिर से लिखना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड लंबाई (तीन महीने)
प्रोजेक्ट का विवरण
खास जानकारी
इस प्रोजेक्ट का मकसद ESLint के लिए कॉन्फ़िगरेशन दस्तावेज़ को फिर से तैयार करना है. साथ ही, एक असरदार इन्फ़ॉर्मेशन आर्किटेक्चर बनाना है. इससे नेविगेशन आसान हो जाता है और दस्तावेज़ की उपयोगिता और उपयोगिता भी बेहतर हो जाती है.
प्रोजेक्ट की खास जानकारी मौजूदा स्थिति में, ESLint (https://eslint.org/docs/user-guide/configging) का कॉन्फ़िगरेशन दस्तावेज़ एक ही पेज पर बहुत सारी जानकारी देता है. पेज पर हेडिंग, उप-शीर्षक, और सही पैराग्राफ़ होने के बावजूद दस्तावेज़ दिलचस्प हो सकता है. पेज के किसी खास सेक्शन पर जाने का कोई तरीका नहीं है. इससे, किसी खास सेक्शन में दिलचस्पी रखने वाले उपयोगकर्ता को परेशानी होती है. जानकारी को व्यवस्थित न करने की वजह से, वह खो भी सकती है. इससे, वह अपना काम नहीं कर पाती और उपयोगकर्ताओं को ज़्यादा मेहनत करनी पड़ती है.
हालांकि, इन समस्याओं को ध्यान से कुछ चरणों को पूरा करके हल किया जा सकता है. मेरा सुझाव है कि खाते को फिर से व्यवस्थित करने के पहले चरण के तौर पर, कॉन्टेंट ऑडिट की सुविधा चालू करें. कॉन्टेंट की जांच से सिर्फ़ जानकारी देने में आ रही समस्याओं को पहचानने में मदद नहीं मिलेगी.साथ ही, कॉन्टेंट की कमियों को हाइलाइट करने में भी मदद मिलेगी. उदाहरण के लिए, पुरानी या अधूरी जानकारी. इसके बाद, मैं नॉलेज नेटवर्क को पेश करने के लिए, सूचना आर्किटेक्चर (आईए) बनाने का प्लान बनाऊंगा. इससे, हम अलग-अलग विषयों के हिसाब से जानकारी को क्लस्टर कर पाएंगे. साथ ही, मिलते-जुलते विषयों के बीच के लिंक भी ढूंढ पाएंगे. इन दोनों तरीकों से मिली अहम जानकारी का इस्तेमाल, सिंगल पेज के दस्तावेज़ को कई पेजों में बांटने के लिए किया जाएगा. इसके बाद, पूरे पैकेज को मार्कडाउन में लिंक और क्रॉस-रेफ़रंस किया जा सकता है. इस वजह से, कॉन्फ़िगरेशन दस्तावेज़ का बेहतर तरीके से व्यवस्थित किया गया वर्शन उपलब्ध होगा. इसे नेविगेट और समझना आसान होगा.
प्रेरणा भले ही मैं काफ़ी समय से ओपन-सोर्स सॉफ़्टवेयर का इस्तेमाल कर रही हूं, लेकिन मुझे इस शब्द के बारे में पूरी जानकारी है. यह ऐसी ही है जैसे लिंटिंग सॉफ़्टवेयर के बारे में मुझे पता है. जब मैंने edX से Python सीखना शुरू किया, तो मुझे आश्चर्य हुआ कि छोटी-मोटी गड़बड़ियां पूरे कोड को कैसे गड़बड़ कर सकती हैं. मुझे लगा कि आपके कोड की जांच करके, गड़बड़ियों का पता लगाना अच्छा होगा. इसके बाद, मुझे “लिंटिंग” शब्द के बारे में पता चला. मैंने अब तक लिंटिंग सॉफ़्टवेयर का सही तरीके से इस्तेमाल नहीं किया है, लेकिन मुझे यकीन है कि आने वाले समय में ये मेरे लिए काफ़ी मददगार साबित होंगे.
इलेक्ट्रिकल इंजीनियरिंग का मेरा बैकग्राउंड और प्रोग्रामिंग का कुछ अनुभव होने की वजह से, मुझे कोडिंग की समस्याओं और प्रोग्रामर की ज़रूरतों को बेहतर तरीके से समझने में मदद मिलती है. इसके अलावा, टेक्निकल और प्रोफ़ेशनल कम्यूनिकेशन में मेरी स्नातक की डिग्री, मुझे उपयोगकर्ताओं का समर्थक बनाती है. इससे मुझे लोगों की ज़िंदगी को आसान बनाने में मदद मिलती है. मेरी स्किल और विशेषज्ञता, इस प्रोजेक्ट के लिए एक अच्छा कॉम्बिनेशन साबित होगी. इससे ESLint के दस्तावेज़ को बेहतर बनाया जा सकेगा.
मकसद इस प्रोजेक्ट का मुख्य मकसद यह पक्का करना है कि ESLint के कॉन्फ़िगरेशन पेज पर मौजूद दस्तावेज़ को समझना आसान हो और वह उपयोगकर्ताओं को परेशान न करे. प्रोजेक्ट की सफलता के लिए यह ज़रूरी है कि कॉन्टेंट को नेविगेट करना आसान हो और उसमें कोई समस्या न हो. प्रोजेक्ट के अहम लक्ष्य ये हैं. - कॉन्टेंट का पूरा ऑडिट करना - जानकारी के फ़्लो को समझने के लिए, जानकारी का स्ट्रक्चर बनाना - दस्तावेज़ों को फिर से व्यवस्थित करने के लिए, जानकारी के स्ट्रक्चर को बेहतर बनाना - कॉन्टेंट के अलग-अलग सेक्शन के बीच के लिंक और रेफ़रंस की पहचान करना - रीकॉन्फ़िगरेशन की ज़रूरी शर्तों को पूरा करने के लिए, दस्तावेज़ के कुछ हिस्सों को फिर से लिखना या उनमें बदलाव करना
- पक्का करें कि कॉन्टेंट को आसानी से इस्तेमाल किया जा सके और उसे फिर से इस्तेमाल किया जा सके
प्रोजेक्ट का ब्यौरा ESLint का कॉन्फ़िगरेशन एक अहम सुविधा है. इसकी मदद से, ESLint को अपनी पसंद के मुताबिक बनाया जा सकता है. कॉन्फ़िगरेशन में दिलचस्पी रखने वाले उपयोगकर्ता, किसी एक या दो पहलुओं में ही दिलचस्पी लेते हैं. इसलिए, यह ज़रूरी है कि उपयोगकर्ता को उसकी दिलचस्पी के विषय पर ले जाया जाए, ताकि उसे बेहतर तरीके से समस्या का हल मिल सके. ESLint के कॉन्फ़िगरेशन दस्तावेज़ में, फ़िलहाल बहुत सारी काम की जानकारी मौजूद है. हालांकि, इसे इस तरह से व्यवस्थित किया गया है कि उपयोगकर्ताओं को परेशानी हो सकती है. उदाहरण के लिए, अगर किसी व्यक्ति को ESLint में तीसरे पक्ष के प्लग इन के इस्तेमाल के बारे में जानना है, तो उसे स्क्रोल करके नीचे जाना होगा. इसके बाद, उसे पार्सर, एनवायरमेंट, और ग्लोबल के बारे में जानकारी मिलेगी. यह प्रोसेस उपयोगकर्ताओं के लिए थकाऊ होती है और वे वेबसाइट से दूर जा सकते हैं. इसी तरह, अगर कोई उपयोगकर्ता पेज के बीच में है और उसे किसी खास सेक्शन पर जाना है या सिर्फ़ मिलते-जुलते विषयों को देखना है, तो उसके लिए यह आसान नहीं होगा. ऐसा इसलिए, क्योंकि उपयोगकर्ताओं को इस तरह की कोई मदद नहीं दी जाती. इन समस्याओं पर तुरंत ध्यान देने की ज़रूरत है, क्योंकि किसी भी दस्तावेज़ की क्वालिटी चाहे कितनी भी अच्छी तरह से ड्राफ़्ट की गई हो, यह इस बात पर निर्भर करता है कि वह कितने काम का है. मैं आगे होने वाली चर्चा में इनके और अन्य संबंधित मुद्दों के समाधान का सुझाव देता हूं.
कॉन्टेंट का ऑडिट करना कॉन्फ़िगरेशन दस्तावेज़ों को फिर से व्यवस्थित करने की प्रोसेस का पहला चरण, कॉन्टेंट का पूरा ऑडिट करना होगा. इस ऑडिट का मकसद, कुछ अहम समस्याओं की पहचान करना है. जैसे, पुराना कॉन्टेंट, डुप्लीकेट कॉन्टेंट, कॉन्टेंट मौजूद न होना वगैरह. इस ऑडिट के नतीजे के तौर पर बनाई गई कॉन्टेंट ऑडिट की स्प्रेडशीट, मैनेजमेंट और दस्तावेज़ टीम के साथ शेयर की जाएगी, ताकि वे इस पर सुझाव/राय दे सकें. इससे, दस्तावेज़ को स्ट्रक्चर करने और उसे पेश करने के लिए नई रणनीति बनाने में मदद मिलेगी.
इन्फ़ॉर्मेशन आर्किटेक्चर बनाना कॉन्फ़िगरेशन दस्तावेज़ में मौजूद नॉलेज नेटवर्क या जानकारी के फ़्लो को समझने के लिए, इन्फ़ॉर्मेशन आर्किटेक्चर (आईए) बनाना फ़ायदेमंद हो सकता है. कॉन्टेंट ऑडिट के नतीजों से, जानकारी के फ़्लो को समझने और उसे बेहतर बनाने में मदद मिलेगी. इसके बाद, दस्तावेज़ को बेहतर तरीके से व्यवस्थित और पेश करने के लिए, 'आईए' का बेहतर वर्शन बनाया जाएगा. बेहतर बनाए गए इस एआई से, मौजूदा कॉन्टेंट का स्ट्रक्चर ही नहीं बदलेगा, बल्कि दस्तावेज़ के अलग-अलग सेक्शन के बीच के लिंक और फ़ॉर्क की पहचान भी होगी. इससे बेहतर नेटवर्क बनेगा. उदाहरण के लिए, “नियमों को कॉन्फ़िगर करना” कॉन्टेंट के बाद, “इनलाइन टिप्पणियों की मदद से नियमों को बंद करना” पर ले जाने वाले लिंक का इस्तेमाल किया जा सकता है. इस तरह के अन्य लिंक की पहचान भी की जा सकती है. इससे दस्तावेज़ के अलग-अलग सेक्शन के बीच संबंध बनता है.
कॉन्टेंट की सूची कॉन्टेंट ऑडिट और आईए से, कॉन्टेंट की ज़्यादा जानकारी वाली सूची बनाने के लिए ज़रूरी जानकारी मिलती है. इस सूची में, दस्तावेज़ के खास सेक्शन और सब-सेक्शन के लिंक भी होते हैं. हर सेक्शन के लिए अलग-अलग फ़ाइलें बनाने और अन्य सेक्शन में सही रेफ़रंस जोड़ने से, दस्तावेज़ों के पूरे सेट को बेहतर बनाने में मदद मिल सकती है. कॉन्फ़िगरेशन दस्तावेज़ पर आने वाले उपयोगकर्ताओं के लिए, विषय सूची बनाई जा सकती है. इससे वेबसाइट पर आने वाले उपयोगकर्ताओं को मदद मिलती है. कॉन्टेंट की टेबल में, पहले और दूसरे लेवल की सभी हेडिंग शामिल की जा सकती हैं, ताकि इसे कम शब्दों में और बेहतर तरीके से बताया जा सके. उदाहरण के लिए, दस्तावेज़ों को व्यवस्थित करने के लिए, Prettier (https://prettier.io/docs/en/index.html) का इस्तेमाल किया जाता है.
सभी दस्तावेज़, Markdown का इस्तेमाल करके बनाए जाएंगे, ताकि उन्हें आसानी से व्यवस्थित किया जा सके. इस बात का खास ध्यान रखा जाएगा कि दस्तावेज़ को दोबारा इस्तेमाल किया जा सके, क्योंकि आने वाले समय में इसमें बदलाव हो सकते हैं और इसमें जानकारी बढ़ सकती है.
इस्तेमाल किए जाने वाले टूल प्रोजेक्ट पर काम करते समय, ये कुछ अहम टूल काम आ सकते हैं - ज़रूरत के हिसाब से एआई के लिए इलस्ट्रेशन बनाने के लिए Draw.io इस्तेमाल करें - Markdown में दस्तावेज़ लिखने और उनमें बदलाव करने के लिए, Atom (या कोई ऐसा ही एडिटर) इस्तेमाल करें
- दस्तावेज़ के वर्शन कंट्रोल को पक्का करने के लिए GitHub
माइलस्टोन प्रोजेक्ट के प्रस्ताव को सबमिट करने से लेकर, उसे पूरा करने तक, यहां दिए गए संभावित माइलस्टोन से यह पक्का किया जा सकेगा कि प्रोजेक्ट सही समय पर पूरा हो जाए.
10 जुलाई, 2020 से 16 अगस्त, 2020: प्रस्ताव की समीक्षा और चुनना मैं ESLint के दस्तावेज़ों को पढ़ूंगा और प्रोजेक्ट को पूरा करने के लिए ज़रूरी स्किल हासिल करूंगा. जैसे, मार्कडाउन लिखना, GitHub पर मिलकर काम करना. मैं GitHub के ज़रिए भी दस्तावेज़ में योगदान करूंगी. साथ ही, दस्तावेज़ को बेहतर तरीके से समझने के लिए, दूसरे लोगों से भी जुड़ूंगी.
17 अगस्त, 2020 से 13 सितंबर, 2020: कम्यूनिटी बॉन्डिंग कम्यूनिटी बॉन्डिंग के दौरान, मैं अपने प्रस्ताव को बेहतर बनाऊंगा. इसके लिए, मैं अपने मेंटर और संबंधित टीमों के साथ बातचीत करूंगा. अगर ज़रूरी हो, तो मैं लक्ष्यों और माइलस्टोन में भी बदलाव करूंगा. इसके अलावा, मैं उन टूल की सूची बनाऊंगा जिनका इस्तेमाल प्रोजेक्ट पर काम करने के लिए किया जाएगा.
14 सितंबर, 2020 से 19 सितंबर, 2020: कॉन्टेंट का ऑडिट प्रोजेक्ट शुरू करने के लिए, मैं कॉन्फ़िगरेशन दस्तावेज़ का पूरा ऑडिट करूंगा. इसका मकसद, कॉन्टेंट और उसके प्रज़ेंटेशन से जुड़ी समस्याओं को हाइलाइट करना होगा.
20 सितंबर, 2020 से 25 सितंबर, 2020: इन्फ़ॉर्मेशन आर्किटेक्चर (आईए) कॉन्टेंट ऑडिट के बाद, मैं कॉन्फ़िगरेशन दस्तावेज़ का आईए बनाऊंगा/बनाऊंगी. मैं नॉलेज नेटवर्क को इस तरह से पेश करने पर फ़ोकस करूंगा कि उसे समझा जा सके. इससे, जानकारी के फ़्लो को बेहतर बनाने में मदद मिलेगी.
26 सितंबर, 2020 से 30 सितंबर, 2020: लिंक और रेफ़रंस इस चरण के दौरान, मैं दस्तावेज़ के अलग-अलग सेक्शन के बीच लिंक और रेफ़रंस को मैप करने के लिए, आईए का विश्लेषण करूंगा. हम सभी सेक्शन के लिए हैरारकी भी बनाएंगे, ताकि इस प्रोसेस में आईए को बेहतर बनाया जा सके.
1 अक्टूबर, 2020 से 3 अक्टूबर, 2020: फ़ाइनल मैप कॉन्टेंट ऑडिट और आईए से मिली अहम जानकारी की मदद से, मैं एक फ़ाइनल मैप बनाऊंगा. इसे फिर से व्यवस्थित किए गए कॉन्फ़िगरेशन दस्तावेज़ में लागू किया जाएगा. इस मैप में, कॉन्टेंट की सूची, विषयों का क्रम, और दस्तावेज़ के सेक्शन के बीच लिंक और क्रॉस-रेफ़रंस की सूची शामिल होगी.
4 अक्टूबर, 2020 से 5 अक्टूबर, 2020: चर्चा इस पॉइंट पर, दस्तावेज़ में बदलाव करने से पहले, मैं अपने नतीजे और प्लान को मेंटॉर और संबंधित टीमों को बता दूंगा. उनके सुझावों से, प्लान को बेहतर बनाने और ज़रूरत पड़ने पर उसमें बदलाव करने में मदद मिलेगी.
06 अक्टूबर, 2020 से 20 अक्टूबर, 2020: फिर से लिखना और बदलाव करना इस दौरान, मैं दस्तावेज़ों के उन सेक्शन में बदलाव और अपडेट करूंगा जहां ज़रूरत है. कॉन्फ़िगरेशन दस्तावेज़ के कुछ सेक्शन को फिर से लिखा जा सकता है या उसमें कुछ नया जोड़ा जा सकता है. इस चरण में, यह पक्का किया जाएगा कि दस्तावेज़ सही, अपडेट किया गया, आसानी से इस्तेमाल किया जा सकने वाला, और फिर से इस्तेमाल किया जा सकने वाला हो.
21 अक्टूबर, 2020 से 25 अक्टूबर, 2020: सुधार और लिंक इस चरण में, मैं व्याकरण और स्ट्रक्चर से जुड़ी गड़बड़ियों को ठीक करने के लिए, अपने काम की समीक्षा करूंगा. साथ ही, यह भी पक्का करूंगा कि मेरे काम में कोई गड़बड़ी तो नहीं है. मैं आईए के मुताबिक, सेक्शन के बीच लिंक और रेफ़रंस भी जोड़ूंगी. इससे यह पक्का किया जा सकेगा कि दस्तावेज़, पहले से तैयार किए गए नॉलेज मैप का पालन कर रहा है.
26 अक्टूबर, 2020 से 31 अक्टूबर, 2020: सबमिशन के लिए फ़ाइनल वर्शन मैं सभी Markdown फ़ाइलों को लिंक करूंगा, कॉन्टेंट की सूची बनाऊंगा, और ड्राफ़्ट को मेंटर के साथ शेयर करूंगा. इसे पूरे पैकेज के तौर पर, पहले ड्राफ़्ट के तौर पर सबमिट किया जाएगा.
1 नवंबर, 2020 से 5 नवंबर, 2020: पहली समीक्षा इन पांच दिनों में, मैं अपने मेंटॉर के साथ पहले ड्राफ़्ट के बारे में चर्चा करूंगा. मुझे उनके सुझाव मिलेंगे और मैं उनके साथ अपने आइडिया पर चर्चा करूंगा, ताकि बदलावों की सूची बनाई जा सके.
06 नवंबर, 2020 से 12 नवंबर, 2020: दस्तावेज़ में पहले बदलाव करना मैं अपने मेंटर के सुझावों और राय की मदद से, दस्तावेज़ के पहले ड्राफ़्ट में बदलाव करूंगा. असल बदलाव, टिप्पणियों और सुझाव/शिकायत/राय के हिसाब से किए जाएंगे. हालांकि, फिर से इस्तेमाल करने, सटीक होने, और सुविधाओं को आसान बनाने के मकसद से, बदलाव किए जाएंगे.
13 नवंबर, 2020 से 15 नवंबर, 2020: दूसरी समीक्षा शुरुआती बदलावों के पूरा होने के बाद, मैं अपने मेंटर और संबंधित टीमों के साथ, प्रोग्रेस के बारे में एक बार फिर से बातचीत करूंगा. इन चर्चाओं में, पहले वर्शन में किए गए बदलावों पर फ़ोकस किया जाएगा. साथ ही, बदलाव करने की प्रोसेस में आने वाली अन्य समस्याओं को भी हाइलाइट किया जाएगा.
16 नवंबर, 2020 से 19 नवंबर, 2020: दूसरा बदलाव इसके बाद, मुझे दस्तावेज़ में बदलाव करने के लिए चार दिन का समय देना होगा. नतीजे के तौर पर तैयार किए गए वर्शन को फ़ाइनल रूप देने के लिए, मेंटॉर के साथ चर्चा की जाएगी. इस चरण के पूरा होने पर, दस्तावेज़ फ़ाइनल हो जाएंगे और वेबसाइट और GitHub डेटा स्टोर पर अपलोड किए जा सकेंगे.
20 नवंबर, 2020 से 23 नवंबर, 2020: वेबसाइट पर अपलोड करना ज़रूरी बदलाव करने के बाद, दस्तावेज़ों को वेबसाइट पर अपलोड कर दिया जाएगा. इस प्रोसेस में आने वाली किसी भी समस्या को ठीक कर दिया जाएगा. ऐसा इसलिए, क्योंकि हमारे पास दस्तावेज़ों पर काम करने के लिए कुछ दिन और हैं.
24 नवंबर, 2020 से 28 नवंबर, 2020: प्रोजेक्ट रिपोर्ट इन पांच दिनों में, प्रोजेक्ट की पूरी जानकारी वाली रिपोर्ट बनाई जाएगी. प्रोजेक्ट रिपोर्ट में, मकसद, समस्याओं, समस्याओं, और दिए गए समाधानों को शामिल किया जाएगा. सुझाव/शिकायत/राय के लिए, रिपोर्ट को मेंटॉर के साथ शेयर किया जाएगा.
29 नवंबर, 2020 से 30 नवंबर, 2020: प्रोजेक्ट सबमिट करना प्रोजेक्ट, सभी फ़ाइलों, और प्रोजेक्ट रिपोर्ट के साथ मेंटर को सबमिट किया जाएगा. मेंटॉर और इससे जुड़ी टीमों के साथ मीटिंग या चर्चा के ज़रिए, पूरे प्रोजेक्ट की समीक्षा की जाएगी.
प्रोजेक्ट के दौरान, मैं मेंटॉर से उनके कीमती सुझाव, शिकायत या राय जानने के लिए उनकी सलाह करूंगी. कम्यूनिटी बॉन्डिंग और प्रस्ताव की समीक्षा के दौरान, मेंटर के साथ की गई बातचीत के आधार पर इन सभी माइलस्टोन में बदलाव किया जा सकता है.
मेरे बारे में मेरे पास इलेक्ट्रिकल इंजीनियरिंग में ग्रेजुएशन की डिग्री है. साथ ही, मैंने नॉर्थ कैरलाइना स्टेट यूनिवर्सिटी से टेक्निकल और प्रोफ़ेशनल कम्यूनिकेशन में ग्रैजुएट डिग्री हासिल की है. मुझे टेक्निकल और प्रोफ़ेशनल राइटिंग और एडिटिंग, कम्यूनिकेशन और कॉन्टेंट मैनेजमेंट, वेब और मोबाइल पर इस्तेमाल से जुड़ी स्टडी, और निर्देश डिज़ाइन करने के क्षेत्र में अनुभव है. मैंने ऑनलाइन पब्लिकेशन (Global Village Space) के लिए सब-एडिटर के तौर पर काम किया है. साथ ही, Duke University में Duke Forge के लिए कम्यूनिकेशन इंटर्न के तौर पर भी काम किया है. इसके अलावा, मुझे क्रिएटिव लेखन में भी दिलचस्पी है.