इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CERN-HSF
- टेक्निकल राइटर:
- जॉन
- प्रोजेक्ट का नाम:
- CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials मेंटर: Olivier Couet, Axel Naumann
खास जानकारी: सॉफ़्टवेयर को उपयोगकर्ताओं के बीच सफलतापूर्वक और बेहतर तरीके से अपनाने के लिए, दस्तावेज़ बनाना ज़रूरी है. उपयोगकर्ताओं के लिए साफ़, सटीक, और पूरी जानकारी देने वाला दस्तावेज़, सॉफ़्टवेयर को इस्तेमाल करने में उनकी मदद करता है. इससे वे अपने लक्ष्यों को हासिल कर पाते हैं. साथ ही, साफ़ तौर पर दिए गए उदाहरण और ट्यूटोरियल, उपयोगकर्ताओं के लिए बेहतर टूल के तौर पर काम करते हैं. इनकी मदद से, वे तुरंत सीख सकते हैं.
हम भौतिक विज्ञान के लिए डेटा विश्लेषण और विज़ुअलाइज़ेशन की जगह पर भौतिक विज्ञानियों, शोध करने वालों, और डेवलपर के ROOT के इस्तेमाल की जांच कर रहे हैं. इससे पता चला है कि उपयोगकर्ताओं के लिए आसान और अपडेट किए गए दस्तावेज़ाें का एक फ़ायदा है. खास तौर पर, सोर्स कोड के बड़े होने और उसके बढ़ने की वजह से, दस्तावेज़ सिस्टम को एक साथ बेहतर बनाने से फ़ायदा मिलता है. इससे उपयोगकर्ताओं को ROOT के सभी फ़ायदे मिल पाते हैं.
मौजूदा दस्तावेज़ की खास जानकारी और विश्लेषण फ़िलहाल, उपयोगकर्ता के लिए उपलब्ध दस्तावेज़ में एक गाइड दी गई है. इससे फ़िज़िसिस्ट, सामान्य लोगों की तुलना में ROOT को ज़्यादा आसानी से अपना सकते हैं. इसके अलावा, डाइनैमिक Python बाइंडिंग जैसे कुछ विषयों में बेहतर और आसान दस्तावेज़ बनाने के लिए सुधार किए जा सकते हैं. इसी तरह, नए डेटा फ़ॉर्मैट RNTuple में ज़रूरी जानकारी नहीं है. फ़िलहाल, मौजूदा दस्तावेज़ में ROOT 7 से जुड़े ट्यूटोरियल मौजूद नहीं हैं.
तरीका: ओलिवर से बातचीत करने के बाद, हमें पता चला कि ऊपर बताई गई समस्याओं को हल करने के लिए, मुख्य तौर पर विशेषज्ञ शोधकर्ताओं और आम दर्शकों के बीच मौजूद नॉलेज गैप की पहचान करनी होगी. साथ ही, उस गैप को दूर करने के लिए दस्तावेज़ बनाना होगा. इसके अलावा, डाइनैमिक Python बाइंडिंग के बारे में ज़्यादा जानकारी वाला दस्तावेज़ लिखना होगा, ROOT 7 के लिए “आधुनिक विश्लेषण के लिए ट्यूटोरियल” लागू करना होगा, और RNTuple के लिए ज़्यादा जानकारी वाली तकनीकी जानकारी बनानी होगी. इस प्रोसेस के दौरान, दस्तावेज़ में Jupyter नोटबुक शामिल की जा सकती हैं, ताकि उपयोगकर्ताओं को सीखने के लिए टूल मिल सकें.
टाइमलाइन: इस प्रोजेक्ट के चरणों का अनुमान इस तरह है: मौजूदा दस्तावेज़ और सोर्स कोड को पढ़ते समय, विशेषज्ञ शोधकर्ताओं और आम दर्शकों के बीच मौजूद ज्ञान के अंतर की पहचान करना → 1-2 हफ़्ते इस अंतर को कम करने के लिए दस्तावेज़ बनाना और उसे फिर से बनाना → 3 हफ़्ते डाइनैमिक Python बाइंडिंग के बारे में ज़्यादा जानकारी वाला दस्तावेज़ लिखना → 3 हफ़्ते डाइनैमिक Python बाइंडिंग के लिए ट्यूटोरियल लागू करना → 3 हफ़्ते ROOT 7 के लिए ट्यूटोरियल लागू करना → 4 हफ़्ते RNTuple के लिए ज़्यादा जानकारी वाली तकनीकी जानकारी बनाना → 3 हफ़्ते प्रोजेक्ट के मकसद पूरे हो गए हैं, इसकी समीक्षा करना → 1 हफ़्ता
डिलीवर किए जाने वाले आइटम और सफलता के लिए दिशा-निर्देश: बिना किसी अंतर के, उपयोगकर्ता के लिए एक ही दस्तावेज़ उपलब्ध कराना सबसे नई सुविधाओं को दिखाने के लिए, उपयोगकर्ता के लिए पूरी तरह से अपडेट किया गया दस्तावेज़, जैसे कि नई डेरिव्ड क्लास Jupyter notebooks की मदद से ट्यूटोरियल