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