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