इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CERN-HSF
- टेक्निकल राइटर:
- LuckInTheRain
- प्रोजेक्ट का नाम:
- ROOT दस्तावेज़ को बेहतर बनाना और उसमें नई जानकारी जोड़ना
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
इस प्रोजेक्ट का मकसद, ROOT के दस्तावेज़ को बेहतर बनाना है. यह डेटा विश्लेषण और डेटा प्रज़ेंटेशन के लिए मुख्य सॉफ़्टवेयर सिस्टम है. इसका इस्तेमाल दुनिया भर में हाई-एनर्जी फ़िज़िक्स कम्यूनिटी करती है.
प्रोजेक्ट के लिए, तकनीकी लेखक के तौर पर मेरे पास कई स्किल हैं. साथ ही, मुझे ROOT (6 और 7) के बारे में भी जानकारी है. साथ ही, मुझे प्रोजेक्ट के लिए ज़रूरी अन्य कॉम्पोनेंट के बारे में भी जानकारी है, जैसे कि:
- C++
- Python
- Git/GitHub
- वेबसाइट बनाने के टूल (एचटीएमएल, मार्कडाउन, Jekyll)
मैंने रूट दस्तावेज़ में तीन मुख्य हिस्सों की पहचान की है:
- वेब साइट https://root.cern,
- C++ क्लास की रेफ़रंस गाइड https://root.cern/doc/master/,
- फ़ोरम https://root-forum.cern.ch
मुझे लगता है कि ROOT के दस्तावेज़ (नया "ROOT मैन्युअल") को इन क्षेत्रों में बेहतर बनाने और उनमें कुछ और जोड़ने की ज़रूरत है:
- यह जानकारी, भौतिक विज्ञान से जुड़े लोगों के अलावा, शुरुआती चैप्टर में ज़्यादा सुलभ और समझने लायक होनी चाहिए.
- ROOT की सामान्य सुविधाओं के बारे में बताने वाले और ट्यूटोरियल बनाए जाएंगे.
- इसमें कुछ नए विषय और अपडेट शामिल किए जाएंगे. साथ ही, इनके बारे में ज़्यादा जानकारी और उदाहरण भी दिए जाएंगे.
इनमें से कुछ इस तरह के हैं:
- Python बाइंडिंग
- मैथमैटिक लाइब्रेरी
- बेहतर ग्राफ़िक्स टूल (TRatioPLot, THStack) के लिए मैन्युअल जानकारी
- डेटा माइनिंग विश्लेषण के नए टूल (RDataFrame और RNtuple)
- नए मुख्य डेटा फ़ॉर्मैट (RDataFrame और RNtuple) के लिए, ज़्यादा जानकारी वाले तकनीकी स्पेसिफ़िकेशन और ट्यूटोरियल की ज़रूरत होती है.
दस्तावेज़ में, उपयोगकर्ताओं के अहम सवालों के जवाब शामिल करने होंगे. जैसे, ROOT फ़ोरम में पोस्ट किए गए सवालों के जवाब. इसके लिए, सबसे ज़्यादा पूछे जाने वाले सवालों का बारीकी से विश्लेषण करना ज़रूरी है. इसके बाद, उन्हें नए "ROOT मैन्युअल" या रेफ़रंस गाइड में कुछ नए ट्यूटोरियल में दस्तावेज़ों के हिस्सों में बदलना होगा.
ROOT 7 की सुविधाओं के बारे में बताने वाले ट्यूटोरियल.
- ROOT 7 के नए हिस्टोग्राम
- ROOT 7 के नए ग्राफ़िक
अनुमानित समयावधि (पांच महीने):
- पहला चरण: ROOT दस्तावेज़ और ट्यूटोरियल के लिए टास्क और दायरे की परिभाषा: दो हफ़्ते.
- दूसरा चरण: रूट फ़ोरम से उपयोगकर्ताओं के अहम सवालों को इकट्ठा करें और उनका विश्लेषण करें: दो हफ़्ते
- तीसरा चरण: ROOT दस्तावेज़ लिखना: आठ हफ़्ते.
- चौथा चरण: ट्यूटोरियल बनाना: आठ हफ़्ते
आखिर में, मुझे यह बताना चाहिए कि मैंने पिछले साल, Google के लंबे समय से चल रहे 'दस्तावेज़ों का सीज़न' प्रोजेक्ट के तहत, ROOT के दस्तावेज़ों में योगदान दिया है. मैंने मैन्युअल का नया स्ट्रक्चर तय किया. इस साल के इस प्रस्ताव से, दस्तावेज़ के उन अन्य पहलुओं को भी पूरा करने में मदद मिलेगी जो ROOT में अब भी मौजूद नहीं हैं.