इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- माटरमोस्ट
- टेक्निकल राइटर:
- @anindita_basu
- प्रोजेक्ट का नाम:
- प्रॉडक्ट में मौजूद टेक्स्ट की समीक्षा करना और उसे बेहतर बनाना
- प्रोजेक्ट की अवधि:
- लंबे समय तक चलने वाला (पांच महीने)
प्रोजेक्ट का विवरण
मैंने Slack चैनल में शामिल होकर, एरिक से कुछ सवाल पूछे.
एरिक के जवाब के आधार पर (धन्यवाद, एरिक!), मेरा सुझाव है कि इस प्रोजेक्ट को
इस तरह से शुरू किया जाए:
स्ट्रिंग को अलग-अलग कैटगरी में बांटना
सबसे पहले, मैं यह पता लगाऊंगा कि https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json में से कौनसी स्ट्रिंग सिस्टम कंसोल की हैं और कौनसी उपयोगकर्ता के लिए हैं. मेरा सुझाव है कि सबसे पहले, उपयोगकर्ताओं को दिखने वाली स्ट्रिंग की समीक्षा की जाए.
स्ट्रिंग के लिए स्टाइल गाइड बनाना
मुझे मेन्यू आइटम, ऐक्शन बटन, लेबल, हेडिंग, टूलटिप, गड़बड़ियों, चेतावनियों, पुष्टि, सूचनाओं, और पुष्टि करने के लिए इस्तेमाल की जाने वाली स्ट्रिंग के लिए, कैपिटल लेटर, लंबाई, और शब्द के इस्तेमाल की स्टाइल तय करनी है. स्टाइल गाइड का उदाहरण देखने के लिए, https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG पर जाएं. साथ ही, मुझे स्ट्रिंग में टोकन (प्लेसहोल्डर) के इस्तेमाल के बारे में कुछ दिशा-निर्देश देने हैं. खास तौर पर, कंपोजिट स्ट्रिंग के बारे में.
मुझे इस दिशा-निर्देश को A4 साइज़ की शीट के एक पेज पर रखना है, ताकि मुमकिन हो. इसका मकसद यह है कि जो डेवलपर इन स्ट्रिंग को लिखते हैं उन्हें दिशा-निर्देश तुरंत और आसानी से मिल जाएं. साथ ही, इनका पालन करने पर, यूज़र इंटरफ़ेस (यूआई) का टेक्स्ट सभी स्क्रीन पर एक जैसा दिखेगा.
मेरा सुझाव है कि ऐसा दो वजहों से किया जाए: (a) व्याकरण और स्टाइल के मामले में टेक्स्ट मैटर में एक जैसी क्वालिटी हो (b) जीएसओडी खत्म होने के बाद भी, निर्देशों का एक सेट मौजूद हो, ताकि यूज़र इंटरफ़ेस (यूआई) का टेक्स्ट लिखते समय कोई भी व्यक्ति तुरंत इनका रेफ़रंस ले सके
टेक्स्ट की समीक्षा करना और उसे बेहतर बनाना
#2 में बनाई गई स्टाइल गाइड के आधार पर, मैं स्ट्रिंग में बदलाव करूंगा और GitHub पर पुल के लिए अनुरोध बनाऊंगा.
=============
कुल समय
मुझे अभी तक नहीं पता कि कितनी स्ट्रिंग, उपयोगकर्ता को दिखने वाली स्ट्रिंग हैं. मेरा सुझाव है कि इस प्रोजेक्ट में समीक्षा के लिए, उपयोगकर्ता को दिखने वाली स्ट्रिंग को शामिल किया जाए. मेरा अनुमान है कि ड्राफ़्ट से लेकर मंज़ूरी मिलने तक, स्टाइल गाइड बनाने में करीब तीन हफ़्ते लगेंगे. साथ ही, इस काम को स्ट्रिंग को सिस्टम स्ट्रिंग या उपयोगकर्ता के सामने दिखने वाली स्ट्रिंग के तौर पर बांटने के साथ-साथ किया जा सकता है. मेरा सुझाव है कि हम इस बात से शुरुआत करें कि यह प्रोजेक्ट तीन महीने का स्टैंडर्ड प्रोजेक्ट है. इसमें हम इस समयसीमा के दौरान, सिर्फ़ उतनी स्ट्रिंग की समीक्षा करेंगे जितनी हो सके.
मैं पहले से ही फ़ुल टाइम नौकरी कर रहा/रही हूं. इसलिए, इस प्रोजेक्ट पर दिन के कुछ समय ही काम किया जा सकता है. अगर आपको लगता है कि काम के कम घंटों की वजह से, मुझे लंबे समय तक चलने वाले प्रोजेक्ट पर काम करना पड़ेगा, तो मैं इसके लिए तैयार हूं.