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