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