इस पेज में एक तकनीकी लेखन प्रोजेक्ट की जानकारी है, जिसे दस्तावेज़ के Google सीज़न के लिए स्वीकार किया जाता है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- GenPipes
- टेक्निकल राइटर:
- shaloo
- प्रोजेक्ट का नाम:
- 'Read The Docs' पर GenPipes दस्तावेज़ सेट अप करें
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मैंने 'Docs को पढ़ें' पर GenPipes के दस्तावेज़ सेट अप करने के लिए, तीन चरणों वाला प्लान बनाया है.
पहला चरण: PoC
नए उपयोगकर्ता / रिसर्चर के तौर पर, GenPipes के मौजूदा दस्तावेज़ों की समीक्षा करना
- छूटी हुई जानकारी और गलत जानकारी की पहचान करना
- दस्तावेज़ के लिए नए विषयों के सुझाव देना (ज़रूरी होने पर)
- टारगेट ऑडियंस को ध्यान में रखते हुए, नए उपयोगकर्ताओं पर फ़ोकस करने के लिए, जानकारी के आर्किटेक्चर का ड्राफ़्ट मैप बनाएं.
ध्यान दें: इस चरण के दौरान, हमें GitHub के नए रिपॉज़िटरी सेटअप के बारे में GenPipes के मेंटर से इनपुट भी चाहिए. इस रिपॉज़िटरी में, आरटीडी के लिए GenPipes के दस्तावेज़ होस्ट किए जा सकते हैं. इस GitHub repo का इस्तेमाल, RTD बिल्ड पाइपलाइन में सभी दस्तावेज़ इंपोर्ट करने के लिए किया जा सकता है. इसके लिए, GenPipes के डेटा को मैनेज करने के नियमों और दिशा-निर्देशों के बारे में जानकारी होनी चाहिए. अगर ऐसा नहीं है, तो स्टैंडर्ड एट्रिब्यूट का इस्तेमाल किया जा सकता है. साथ ही, पीओसी के लिए, मैं अपने GitHub खाते का इस्तेमाल करके, आरटीडी रिपॉज़िटरी के सैंपल सेटअप का डेमो दे सकता/सकती हूं. उदाहरण के लिए, https://gpdocs.readthedocs.io/en/latest/ - यह एक सैंपलर है, जिसे मैंने इस प्रस्ताव के लिए बनाया है)
पिछले चरण में की गई समीक्षा और विश्लेषण के आधार पर, GenPipes दस्तावेज़ के प्रस्तावित स्ट्रक्चर / इंडेक्स का बेरबोन स्केलेटन बनाएं और उसे आरटीडी साइट पर डालें
- इसमें GitHub रेपो बनाना (उदाहरण के लिए, Sphinx टूल का इस्तेमाल करके) और बुनियादी दस्तावेज़ फ़ाइलें बनाना शामिल है
- इसमें एक नया टीओसी भी शामिल है, जो जानकारी के अलग-अलग सेक्शन / फ़्लो के लिए, नए उपयोगकर्ताओं और अनुभवी उपयोगकर्ताओं, दोनों को ध्यान में रखता है.
खास जानकारी के बिना बने स्केलेटन टीओसी की समीक्षा करना / उसे मंज़ूरी पाना
GenPipes के जीएसओडी के आकलन के दौरान, मैंने RTD पर होस्ट किए गए इस सैंपल की मदद से, GenPipes के लिए वैल्यू बनाने की कोशिश की. कृपया ध्यान दें कि यह सिर्फ़ डेमो के लिए है. यह लिंक सुरक्षित है और इसे आरटीडी पर सार्वजनिक तौर पर नहीं दिखाया गया है. भले ही, मुझे शॉर्टलिस्ट किया जाए या नहीं, इस डेमो का इस्तेमाल GenPipes आरटीडी प्रोग्राम को शुरू करने के लिए किया जा सकता है. मैंने c3g/GenPipes GitHub रेपो में, पहले ही सोर्स की जांच कर ली है. Skype पर 'स्क्रीन शेयर करें' सुविधा की मदद से हुई बातचीत के दौरान, मेंटर रोला और हेक्टर को यह आइडिया पसंद आया था. इसलिए, मुझे लगा कि शायद GSoD के 'भगवान' भी इसे देखना चाहें. फ़िलहाल, यह सिर्फ़ एक स्केलेटन है. हालांकि, 30 जुलाई तक समय मिलने पर, मैं इसे अपडेट करूंगा.
https://genpipes.readthedocs.io/en/latest/
दूसरा चरण: GenPipes Doc v0.9 का दस्तावेज़ सेट बनाना
यह पहचान करना कि GSoD की समयावधि को ध्यान में रखते हुए, आरटीडी पर होस्ट करने के लिए कौनसे मौजूदा या मौजूदा GenPipes दस्तावेज़ों को इंपोर्ट, लिंक या स्फ़िंक्स/आरएसटी पर आधारित दस्तावेज़ में बदला जा सकता है
पहचाने गए दस्तावेज़ों को rst फ़ॉर्मैट में बदलें. अगर ज़रूरी हो, तो जहां लागू हो वहां नए दस्तावेज़ बनाएं. साथ ही, जहां भी हो सके वहां काम के दस्तावेज़ों का फिर से इस्तेमाल करें.
- इस शुरुआती दस्तावेज़ सेट को कॉन्सेप्ट के सबूत के तौर पर ReadTheDocs में इंपोर्ट करें – इसे वहां सुरक्षित रिपॉज़िटरी के तौर पर होस्ट करें. शुरुआत में एक नोट डालें, जिसमें नए उपयोगकर्ताओं को सुझाव दिया गया हो कि वे GenPipes के ओरिजनल दस्तावेज़ों पर जाएं. ऐसा तब तक करें, जब तक समीक्षा पूरी नहीं हो जाती या आधिकारिक तौर पर स्विच करने की अनुमति नहीं मिल जाती.
समीक्षा/कोर्स-सही/अपडेट करें
तीसरा चरण: आरटीडी में पहले ड्राफ़्ट को बेहतर बनाना, उसकी समीक्षा करना, और उसे पब्लिश करना
GenPipes के TOC में, GenPipes के लिए सुझाए गए नए दस्तावेज़ के स्ट्रक्चर की जानकारी भरें – शुरुआती कुछ दस्तावेज़ों (GenPipes Readme), कॉन्सेप्ट, ट्यूटोरियल वगैरह के अलावा अन्य दस्तावेज़ जोड़ें.
नए उपयोगकर्ताओं, GenPipes के पुराने उपयोगकर्ताओं, GenPipes डेवलपर वगैरह के हिसाब से, TOC में अलग-अलग सेक्शन बनाएं.
RTD (sphinx बिल्ड) की मदद से, ऑटोमेशन की सुविधा का इस्तेमाल करके काम करने की प्रोसेस के बारे में सुझाव दें और उस पर चर्चा करें. इस प्रोसेस से, GenPipes के दस्तावेज़ों को मैनेज करने और उनमें उपयोगकर्ताओं के बदलाव करने के तरीके के बारे में पता चलेगा. साथ ही, यह भी पता चलेगा कि C3G, दस्तावेज़ में योगदान देने वाले बाहरी लोगों को इसकी अनुमति देगा या नहीं. इसके लिए, दस्तावेज़ के अपडेट के लिए कुछ दिशा-निर्देश बनाने पड़ सकते हैं. ये दिशा-निर्देश, कोडिंग के दिशा-निर्देशों जैसे ही होंगे. इसके लिए, कुछ और उप-चरणों की ज़रूरत हो सकती है. उदाहरण के लिए, GenPipes के दस्तावेज़ों में, पीआर की मंज़ूरी से पहले स्पेलिंग की जांच अपने-आप होने की सुविधा.
रिपोर्ट
आखिर में, मेंटॉर के अनुभवों, लॉग, और सुझाव के आधार पर GSoD के लिए एक रिपोर्ट बनाएं.
अन्य बातें
आने वाले समय में (तीन महीने के बाद), अगर लागू हो, तो मैं GenPipes के लिए लंबे समय तक इसे मैनेज करने में मदद कर सकता हूं. ज़रूरत पड़ने पर, आप अन्य लोगों को भी इसके लिए ट्रेनिंग दे सकते हैं. हम शुरुआती तीन महीनों के नतीजों के आधार पर, इस बारे में तय कर सकते हैं.
साथ ही, हम प्रोजेक्ट के प्रस्ताव के लिए एक और आइडिया देना चाहते हैं - GenPipes के बारे में तीन पेजों का ब्रीफ़ बनाना, ताकि इसे आसानी से शामिल किया जा सके. फ़िलहाल, नए उपयोगकर्ता को GenPipes का इस्तेमाल शुरू करने से पहले कई समस्याओं का सामना करना पड़ता है. इसकी वजह यह है कि दस्तावेज़ अच्छे हैं, लेकिन वे अलग-अलग जगहों पर मौजूद हैं और नए उपयोगकर्ताओं के लिए आसान नहीं हैं. मुझे नहीं पता कि यह काम तीन महीने में हो सकता है या नहीं, लेकिन मुझे कोशिश करके देखना है.
इस प्रस्ताव और इसके इतिहास (इसे बनाने का तरीका) को https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing पर भी देखा जा सकता है