इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CERN-HSF
- तकनीकी लेखक:
- LuckInTheRain
- प्रोजेक्ट का नाम:
- रूट दस्तावेज़: विश्लेषण करना, उसे फिर से स्ट्रक्चर करना, और फिर से लिखना
- प्रोजेक्ट की अवधि:
- लंबे समय तक दौड़ना (पांच महीने)
प्रोजेक्ट का विवरण
यह प्रोजेक्ट चार चरणों में पूरा होगा:
1.) मौजूदा ROOT दस्तावेज़ का विश्लेषण किया जा रहा है
रूट दस्तावेज़ (वेबसाइट, उपयोगकर्ता की गाइड, C++ रेफ़रंस, ट्यूटोरियल वगैरह) का विश्लेषण और जांच इन शर्तों के आधार पर की जाती है: स्ट्रक्चरिंग, मॉड्यूलराइज़ेशन, स्टैंडर्डाइज़ेशन, ऐक्सेस मैकेनिज़्म, कंसिस्टेंसी, इस्तेमाल की गई जानकारी के टाइप, टारगेट ग्रुप के हिसाब से तैयारी और समझना. इसका मकसद, इन्फ़ॉर्मेशन मैनेजमेंट का एक सिद्धांत और स्ट्रक्चर तैयार करने के लिए एक मैट्रिक्स तैयार करना है. साथ ही, कॉन्टेंट के लिए मानक तय करने का दिशा-निर्देश तैयार करना है.
2.) ROOT टीम की मदद से, राइटिंग सॉफ़्टवेयर दस्तावेज़ बनाने का तरीका तय करना
DITA (डारविन इन्फ़ॉर्मेशन टाइपिंग आर्किटेक्चर), सॉफ़्टवेयर दस्तावेज़ के लिए OASIS स्टैंडर्ड (https://www.oasis-open.org/committees/dita/) आरओओटी टीम को पेश किया गया है. यहां पर मुख्य रूप से यह समझने पर ध्यान दिया गया है कि किसी सॉफ़्टवेयर के कॉन्टेंट को किस तरह से तैयार किया जाए. साथ ही, यह भी समझने पर ध्यान दें कि सॉफ़्टवेयर दस्तावेज़ लिखने के लिए, “कॉन्सेप्ट”, “टास्क”, और “रेफ़रंस” जैसी बुनियादी जानकारी का इस्तेमाल कैसे किया जाता है.
3.) आरओओटी दस्तावेज़ को फिर से बनाना और उसे फिर से व्यवस्थित करना
पहले दो चरणों के नतीजों के आधार पर, आरओओटी (RoOT) दस्तावेज़ को टारगेट ग्रुप, भूमिकाओं, और इस्तेमाल के उदाहरणों के मुताबिक फिर से व्यवस्थित किया जाता है. साथ ही, उसमें मॉड्यूल और उसका कॉन्टेंट तय किया जाता है. इसके लिए, कॉन्टेंट को संबंधित एलिमेंट (वेबसाइट, उपयोगकर्ताओं की गाइड, C++ रेफ़रंस, ट्यूटोरियल वगैरह) और कॉन्टेंट टाइप के हिसाब से असाइन किया जाता है. उपलब्ध जानकारी का दायरा बहुत बड़ा है, इसलिए एक सटीक रेफ़रंस स्ट्रक्चर भी बनाना ज़रूरी है. इसका मकसद, लोगों को इनके बारे में पूरी जानकारी देना है. साथ ही, यह बताना है कि वे अपनी ज़रूरतों के हिसाब से ROOT का इस्तेमाल कैसे कर सकते हैं. साथ ही, कम शब्दों में फ़िज़िक्स के बारे में बुनियादी जानकारी दी जाती है.
4.) आरओओटी दस्तावेज़ को फिर से लिखना
दस्तावेज़ के मुख्य हिस्सों, खास तौर पर उपयोगकर्ताओं के लिए गाइड को डीआईटीए के तरीके के हिसाब से फिर से लिखा गया है. स्ट्रक्चरिंग और लेखन के नियमों को स्टाइल गाइड में रिकॉर्ड किया जाता है, ताकि आने वाले समय में दस्तावेज़ों में एकरूपता बनाए जा सके. इसका मकसद ROOT टीम को आने वाले समय में खुद ही ROOT दस्तावेज़ का विस्तार करने और उनका रखरखाव करने में मदद करना है.
अनुमानित समय शेड्यूल (5 महीने):
पहला चरण: मौजूदा ROOT दस्तावेज़ का विश्लेषण करें: तीन हफ़्ते.
दूसरा चरण: आरओओटी टीम के साथ, राइटिंग सॉफ़्टवेयर दस्तावेज़ बनाने का तरीका तय करना: दो हफ़्ते.
तीसरा चरण: आरओओटी दस्तावेज़ को फिर से तैयार करना और उसे फिर से व्यवस्थित करना: चार हफ़्ते.
चौथा चरण: आरओओटी से जुड़े दस्तावेज़ फिर से लिखना: 11 हफ़्ते.