इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- एचपीएक्स
- तकनीकी लेखक:
- रस्टोबॉग
- प्रोजेक्ट का नाम:
- मौजूदा HPX दस्तावेज़ों में बदलाव करें और उन्हें व्यवस्थित करें
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मेरा प्रस्ताव है कि मौजूदा HPX दस्तावेज़ के कॉन्टेंट में बदलाव किया जाए और उसे व्यवस्थित किया जाए. मेरा प्रस्ताव सामान्य अवधि (तीन महीने) वाले प्रोजेक्ट के लिए है, जो STE||AR ग्रुप के मैन्युअल ""HPX बिल्ड सिस्टम और लॉन्चिंग"" (1) और ""HPX ऐप्लिकेशन कॉन्फ़िगर करना" (2) के दो चैप्टर में बदलाव करने पर फ़ोकस करता है.
""HPX बिल्ड सिस्टम और लॉन्चिंग"" वाले चैप्टर में व्याकरण से जुड़ी कई गड़बड़ियां हैं. साथ ही, इसमें गुमराह करने वाली भाषा और “CMake” जैसे शब्दों के बड़े अक्षरों का इस्तेमाल अलग-अलग है. इसके अलावा, इसमें दोहराई गई जानकारी भी है, जिसे मेरी ज़रूरत के हिसाब से फिर से व्यवस्थित करने, इकट्ठा करने, और ट्रिम करने की योजना है. हालांकि ""HPX ऐप्लिकेशन को कॉन्फ़िगर करना"" के चैप्टर में भी व्याकरण की कुछ गड़बड़ियां हैं जिन पर ध्यान देने की ज़रूरत है, लेकिन इस चैप्टर के लिए मेरी मुख्य चिंता है कि यह लोगों के लिए आसान है या नहीं. इस चैप्टर में डिज़ाइन से जुड़ी तीन बड़ी समस्याएं हैं जिन्हें मुझे ठीक करना है:
कुछ टाइटल टेक्स्ट में छिपा होते हैं. इस वजह से, चैप्टर को पढ़ना मुश्किल होता है. फ़िलहाल, उपयोगकर्ता को हर टेबल का मकसद समझने के लिए मैन्युअल को ध्यान से पढ़ना होगा. इसके अलावा, ज़्यादातर उपयोगकर्ता निर्देश मैन्युअल का इस्तेमाल नहीं करते हैं. खास तौर पर तब, जब उन्होंने पहले ही कॉन्टेंट पढ़ लिया हो. इसके बजाय, मेरी योजना है कि हर टेबल का शीर्षक साफ़ और अलग हो, जिसे आसानी से तब देखा जा सके, जब कोई उपयोगकर्ता टेक्स्ट को स्क्रोल करे.
किसी खास शीर्षक के तहत कई प्रॉपर्टी की सूची बनाने पर, प्रॉपर्टी एक क्रम में नहीं होतीं. हालांकि, प्रॉपर्टी को एक ही थीम के तहत एक साथ रखा जाता है, लेकिन इनमें कोई सबग्रुप नहीं होता. ऐसा होने पर, जानकारी बिखरी हुई लगती है. उदाहरण के लिए, उपयोगकर्ता को शहर से जुड़ी कई प्रॉपर्टी दिख सकती हैं. कुछ प्रॉपर्टी किसी दूसरे विषय से जुड़ी हो सकती हैं और कुछ दूसरी प्रॉपर्टी किसी इलाके के बारे में हो सकती हैं. शीर्षक में अंदरूनी स्ट्रक्चर न होने की वजह से, किसी खास उप-विषय की पूरी जानकारी नहीं मिल सकती. इसलिए, मेरी योजना है कि कई चार्ट को फिर से व्यवस्थित किया जाए, ताकि हर हेडिंग में एक जैसी जानकारी को ज़्यादा साफ़ तौर पर ग्रुप किया जा सके.
कुछ निर्देशों को पूरी तरह से समझने के लिए, उपयोगकर्ताओं को एक सेक्शन से दूसरे सेक्शन पर जाने या मैन्युअल को दो अलग-अलग टैब में खोलने के लिए मजबूर किया जाता है. ऐसे कुछ पॉइंट हैं जहां चैप्टर, उपयोगकर्ता को पिछले सेक्शन में मौजूद एक वाक्य पर इस तरह भेजता है कि पाठक को निर्देश को समझने के लिए ऊपर की ओर स्क्रोल करना पड़ता है या हाइपरलिंक पर जाना पड़ता है. ऐसा इसलिए होता है, क्योंकि मैन्युअल में अस्पष्ट भाषा का इस्तेमाल किया जाता है, जैसे कि पिछले सेक्शन में "यह चरण 11वें चरण के बाद पहले बनाया गया था". यह तरीका दोहराव को हटा देता है, लेकिन इससे निर्देशों को समझना मुश्किल हो जाता है. ऐसा इसलिए, क्योंकि इन टास्क को किसी खास क्रम में पहले से तैयार करना ज़रूरी है. इसके बजाय, मेरा सुझाव है कि ज़्यादा सटीक शब्दों को शामिल करें, ताकि उपयोगकर्ताओं को सेक्शन या दस्तावेज़ों के बीच स्विच करके, पढ़ने की प्रोसेस में रुकावट न आए.
अगर मैं स्टैंडर्ड टाइमलाइन के खत्म होने से पहले इन सेक्शन को पूरा कर लूं, तो मुझे STE||AR ग्रुप के उपयोगकर्ता दस्तावेज़ में जाकर, “HPX क्यों?” (3) पेज को भी साफ़ करना है. इस पेज पर दोहराई जाने वाली शुरुआती जानकारी है, जिससे इसे एक साथ जोड़कर देखा जा सकता है. साथ ही, इसमें कैपिटल लेटर (खास तौर पर कठिन शब्दावली) और बोलने में भी अंतर होने की उम्मीद है, जिससे यह एक असमानता की तरह दिखता है. मेरा लक्ष्य STE||AR ग्रुप के काम के बारे में ज़्यादा यूनिफ़ाइड और सटीक जानकारी देना होगा.