इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CERN-HSF
- तकनीकी लेखक:
- जॉन
- प्रोजेक्ट का नाम:
- CERN-HSF - आम ऑडियंस के लिए अडॉप्शन, डाइनैमिक Python बाइंडिंग, और ट्यूटोरियल के लिए रूट दस्तावेज़
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
CERN-HSF - आम लोगों को अपनाए जाने, डाइनैमिक Python बाइंडिंग, और ट्यूटोरियल के लिए रूट दस्तावेज़ मेंटॉर: ओलिवियर कूएट, एक्सेल नोमैन
संक्षेप में: उपयोगकर्ताओं के लिए सॉफ़्टवेयर का सफल और कुशलता से इस्तेमाल करने के लिए दस्तावेज़ ज़रूरी हैं. साफ़, सटीक और पूरी जानकारी देने वाले उपयोगकर्ता दस्तावेज़ से, उपयोगकर्ताओं को सॉफ़्टवेयर के इस्तेमाल में महारत हासिल होती है, ताकि वे अपने लक्ष्यों को पूरा करने की कोशिश कर सकें. इसी तरह, साफ़ तौर पर दिखाए गए उदाहरण और ट्यूटोरियल एक ऐसे टूल का काम करते हैं जिससे लोग तेज़ी से सीख सकते हैं.
भौतिक वैज्ञानिकों, शोधकर्ताओं, और डेवलपर के डेटा विश्लेषण और भौतिक विज्ञान के विज़ुअलाइज़ेशन के लिए, हम आरओओटी के इस्तेमाल की जांच कर रहे हैं. इससे, उपयोगकर्ता के लिए आसान और अपडेट किए गए दस्तावेज़ों के फ़ायदे समझने में मदद मिलती है. खास तौर पर, सोर्स कोड के विस्तार और इसके बढ़ने की वजह से, दस्तावेज़ सिस्टम को आगे बढ़ने से फ़ायदा मिल रहा है. इससे, उपयोगकर्ताओं को रूट की सभी सुविधाओं का ज़्यादा से ज़्यादा फ़ायदा मिल पाएगा.
मौजूदा दस्तावेज़ों की खास जानकारी और विश्लेषण फ़िलहाल, उपयोगकर्ता के दस्तावेज़ में एक गाइड दी गई है. इसकी मदद से, भौतिक विज्ञानी आम ऑडियंस के मुकाबले आसानी से आरओओटी फ़ॉर्मैट का इस्तेमाल कर सकते हैं. इसके अलावा, डाइनैमिक Python बाइंडिंग जैसे कुछ विषयों में सुधार किए जा सकते हैं, ताकि बेहतर और साफ़ तौर पर जानकारी दी जा सके. इसी तरह, RNTuple के नए डेटा फ़ॉर्मैट में पूरी जानकारी मौजूद नहीं है. फ़िलहाल, मौजूदा दस्तावेज़ में रूट 7 से जुड़े ट्यूटोरियल मौजूद नहीं हैं.
तरीका: ऑलिवियर से बातचीत करने के बाद, यह महसूस हुआ कि ऊपर बताई गई समस्याओं को ठीक करने के लिए, मुख्य रूप से विशेषज्ञों और आम लोगों के बीच उपलब्ध जानकारी में मौजूद असमानताओं की पहचान करना, इस अंतर को दूर करने के लिए दस्तावेज़ बनाना, डाइनैमिक Python बाइंडिंग के बारे में ज़्यादा जानकारी वाला दस्तावेज़ लिखना, ROOT 7 के लिए "आधुनिक विश्लेषण के लिए ट्यूटोरियल" लागू करना, और RNTuple के लिए पूरी जानकारी देना शामिल होना चाहिए. इन कदमों के साथ ही, इस प्रक्रिया के दौरान दस्तावेज़ में Jupyter notebooks शामिल की जा सकती हैं, ताकि इस्तेमाल करने वालों को छूकर महसूस किए जा सकने वाले और इंटरैक्टिव लर्निंग टूल मदद मिल सकें.
टाइमलाइन: प्रोजेक्ट के चरणों का अनुमान ये है: विशेषज्ञों से रिसर्च करने वाले और आम दर्शकों के बीच जानकारी के अंतर की पहचान करें (मौजूदा दस्तावेज़ और सोर्स कोड पढ़ते समय) → 1-2 हफ़्ते इस अंतर को कम करने के लिए दस्तावेज़ बनाएं और रीफ़ैक्टर करें → तीन हफ़्ते डाइनैमिक Python बाइंडिंग का ज़्यादा जानकारी वाला दस्तावेज़ लिखें → तीन हफ़्ते डाइनैमिक Python बाइंडिंग के लिए ट्यूटोरियल लागू करें → 3 हफ़्ते OT3 हफ़्ते के ट्यूटोरियल लागू करें
सफलता के लिए डिलीवरी और दिशा-निर्देश: बिना किसी गैप के सिंगल यूनिफ़ाइड उपयोगकर्ता दस्तावेज़ सबसे नई सुविधाओं को दिखाने के लिए पूरी तरह से अपडेट किया गया उपयोगकर्ता दस्तावेज़, जैसे कि नई डिराइव्ड क्लास Jupyter notebooks के ज़रिए ट्यूटोरियल