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