इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CERN-HSF
- तकनीकी लेखक:
- SabitaR
- प्रोजेक्ट का नाम:
- ऑलपिक्स स्क्वेयर वाले दस्तावेज़ों को फिर से तैयार करना और उन्हें व्यवस्थित करना
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
अवलोकन मैंने CERN-HSF के Allpix Squared प्रोजेक्ट को दो मुख्य वजहों से चुना है:
स्किल डेवलप करना: इस प्रोजेक्ट के मौजूदा दस्तावेज़ में पूरी जानकारी दी गई है और इसमें एक से ज़्यादा कॉन्टेंट फ़ॉर्मैट को शामिल किया गया है. इस बड़े दस्तावेज़ सुइट को ऑडिट करने और फिर से बनाने से, मुझे जानकारी देने के तरीके और लिखने के कौशल को बेहतर बनाने में मदद मिलेगी. इसके अलावा, प्रोजेक्ट डोमेन (कण भौतिकी!) मेरे लिए नया है. यह मुझे डेवलपर के साथ बातचीत करने के अपने कौशल को बेहतर बनाने की चुनौती देता है. मेरा मानना है कि टेक्निकल राइटर, डेवलपर से मिले इनपुट को प्रोसेस कर सकते हैं और हर लेवल के लोगों के लिए काम का कॉन्टेंट पेश कर सकते हैं. ऐसा तब किया जा सकता है, जब हम ज़रूरी बैकग्राउंड रिसर्च करें और सही सवाल पूछें. इस प्रोजेक्ट से, मुझे इस सिद्धांत की जांच करने में मदद मिलेगी!
तकनीकी जानकारी: इस प्रोजेक्ट के लिए ह्यूगो की ज़रूरत है - यह एक ऐसा टूल है जो मेरी सीखने की सूची में सबसे ऊपर है. मुझे LaTeX-Markdown-Hugo-GitLab-CI का वर्कफ़्लो सीखने का इंतज़ार रहेगा.
टेक्निकल राइटर के बारे में जानकारी हासिल करने के दौरान, मैंने प्रोजेक्ट मेंटॉर से कुछ हद तक बातचीत की और दस्तावेज़ सुइट के मौजूदा स्ट्रक्चर के बारे में जाना. मैंने एक डेमो वेबसाइट (https://ap2-demo.netlify.app/) भी बनाई थी, ताकि यह जांच की जा सके कि मैं अपनी Windows मशीन पर ह्यूगो और Docsy को सही तरीके से कॉन्फ़िगर कर सकता हूं या नहीं. मैं वेबसाइट को Netlify पर डिप्लॉय कर सका, लेकिन Gitlab पेजों पर नहीं. इस प्रोजेक्ट के मौजूदा डिप्लॉयमेंट वर्कफ़्लो को बनाए रखने के लिए, मुझे Hugo Docsy थीम को Gitlab पेज पर डिप्लॉय करने का तरीका बताना है.
अनुमानित प्रोजेक्ट के नतीजे - प्रोजेक्ट की एक व्यवस्थित वेबसाइट है, जो दस्तावेज़, कोड रेफ़रंस, ट्यूटोरियल, और खबरें इंटिग्रेट करती है. - फिर से व्यवस्थित की गई और समीक्षा की गई उपयोगकर्ता गाइड - कैसे करें दस्तावेज़, अक्सर पूछे जाने वाले सवाल, और आम तौर पर होने वाली समस्याओं के उपलब्ध उदाहरणों से लिया गया ट्यूटोरियल वर्कफ़्लो.
प्रोजेक्ट टूल Allpix Squared के मौजूदा दस्तावेज़ में GitLab और Gitlab CI के साथ-साथ LaTeX, Doxygen, Pandoc, और Hugo का इस्तेमाल किया गया है. मैंने प्रोजेक्ट के मेंटॉर और मैंने MathJax प्लगिन की मदद से, कॉन्टेंट को LaTeX से Markdown में ले जाने के बारे में बातचीत की. अगर मैं सफल हो जाता हूं, तो दस्तावेज़ वर्कफ़्लो में ह्यूगो, मार्कडाउन, Doxygen, git, और Gitlab CI शामिल होंगे. ट्यूटोरियल को एक ही वेबसाइट/प्लैटफ़ॉर्म पर रखने के लिए, मैं ह्यूगो और मार्कडाउन का इस्तेमाल करूंगी. मुझे यह जानना है कि ट्यूटोरियल के लिए Codelabs-as-a-Tool (ClaaT) का इस्तेमाल कैसे किया जा सकता है. उम्मीद है कि इस जुलाई में मैं ClaaT-Hugo वर्कफ़्लो को टेस्ट करना चाहता हूं और अगर चुने गए हैं, तो मेंटॉर के साथ इस पर चर्चा करना चाहूंगी.
प्रोजेक्ट की अवधि मेरा अनुरोध है कि Allpix Squared प्रोजेक्ट को तीन महीने (14 सितंबर, 2020 से 30 नवंबर, 2020) के अंदर पूरा करना होगा और इस दौरान मुझे हर हफ़्ते करीब 15 घंटे देने होंगे. ज़रूरत पड़ने पर, इन घंटों में मेंटॉर की मीटिंग और उनसे जुड़े ईमेल भेजे जाएंगे. मुझे कम्यूनिटी के साथ जुड़ने और प्रोजेक्ट को फ़ाइनल करने के लिए, GSoD की टाइमलाइन का पालन करना है.
प्रोजेक्ट से जुड़े काम यहां बताया गया है कि मुझे Allpix Squared दस्तावेज़ सुइट में अपने सुझाए गए अपडेट किस तरह लागू करने हैं: 1. रिसर्च करें, चर्चा करें, और विकल्पों को एक्सप्लोर करें (17 अगस्त से 13 सितंबर, 2020): - प्रोजेक्ट की ज़रूरी शर्तों को समझें - मौजूदा दस्तावेज़ों में छूटी हुई जानकारी की पहचान करने के लिए Allpix Squared इंस्टॉल करें. - ज़रूरी क्रेडेंशियल का अनुरोध करें. - Allpix Squared के अलग-अलग उपयोगकर्ताओं के लिए उपयोगकर्ता वर्कफ़्लो बनाएं - उपयोगकर्ता की भूमिका के हिसाब से कॉन्टेंट को कैटगरी में बांटें - LaTeX फ़ाइलों को Markdown में बदलने के नतीजों की जांच करें - सोर्स डेटा स्टोर करने की जगहों को इकट्ठा करें या एक से ज़्यादा git डेटा स्टोर करने की जगहों के साथ काम करने का तरीका समझें - बोनस: ट्यूटोरियल के लिए, CLaaT कम्यूनिटी को एक विकल्प के तौर पर टेस्ट करें - बोनस: योगदान देने वाले लोगों को जल्दी से जोड़ने के लिए गाइड की मदद से, जल्दी मदद पाने के लिए गाइड की मदद लें
कॉन्टेंट को फिर से तैयार करना, उसकी समीक्षा करना, और उसे बेहतर बनाना (14 सितंबर से 19 अक्टूबर, 2020): हर हफ़्ते दो टास्क, हर टास्क में करीब पांच से सात घंटे. इस टाइमलाइन में, अचानक होने वाली देरी या समस्याओं को हैंडल करने के लिए, बफ़र वीक शामिल होता है.
- उपयोगकर्ता के वर्कफ़्लो को ध्यान में रखते हुए, मौजूदा कॉन्टेंट और उपयोगकर्ताओं की कैटगरी की समीक्षा करें
- अलग-अलग उपयोगकर्ताओं के लिए, कॉन्टेंट वर्कफ़्लो को आउटलाइन और टेस्ट करें
- जो कॉन्टेंट मौजूद नहीं है उसका सोर्स बनाएं और उसे बेहतर बनाएं
- LaTeX फ़ाइलों को Markdown में बदलें
- उपयोगकर्ता गाइड और डेवलपर गाइड की विषय सूची को फ़ाइनल करें
- उपयोगकर्ता और डेवलपर गाइड की PDF फ़ाइलें जनरेट करें
- बोनस: उदाहरणों और समस्याओं से जुड़े ट्यूटोरियल के लिए कॉन्टेंट तैयार करना
- बोनस: कैसे करें के उदाहरणों के लिए ट्यूटोरियल वर्कफ़्लो सेटअप करें टाइमलाइन: पांच हफ़्ते (दस्तावेज़ डेवलप करने का चरण)
वेबसाइट बनाएं (19 अक्टूबर - 30 नवंबर, 2020): हर हफ़्ते एक-दो टास्क, हर टास्क में करीब पांच से सात घंटे. इस टाइमलाइन में समस्याओं को हल करने और आउटपुट को बेहतर बनाने के लिए, बफ़र वीक शामिल है.
- पब्लिश करने के वर्कफ़्लो को समझना और उसकी जांच करना
- ह्यूगो और Docsy की मदद से वेबसाइट का स्ट्रक्चर बनाएं
- Docsy का इस्तेमाल करके, मौजूदा अपने-आप डिप्लॉयमेंट और वर्कफ़्लो को मैनेज करने के तरीके की जांच करना
- Doxygen से कॉन्टेंट इकट्ठा करें
- LaTex या Markdown कॉन्टेंट की मदद से इस्तेमाल करने के लिए, गाइड, ट्यूटोरियल, और इस्तेमाल के लिए गाइड तैयार करें
- प्रोजेक्ट की वेबसाइट का लुक और स्टाइल तय करें (लोगो, कलर, टेंप्लेट, लेआउट, लिंक, उपयोगिता, और Gitlab CI/CD) टाइमलाइन: छह हफ़्ते (दस्तावेज़ तैयार करने का चरण)