इस पेज पर Google 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) ताकि GSoD के खत्म होने के बाद भी, उपयोगकर्ताओं को यूज़र इंटरफ़ेस (यूआई) टेक्स्ट लिखते समय तुरंत निर्देशों का एक सेट दिखे
टेक्स्ट की समीक्षा करके उसे बेहतर बनाएं
#2 पर बनाई गई स्टाइल गाइड के आधार पर, मैं स्ट्रिंग में बदलाव करूंगा/करूंगी और GitHub पर पुल अनुरोध बनाऊंगा/बनाऊंगी.
=============
कुल समय
मुझे अब तक नहीं पता कि उपयोगकर्ता को दिखने वाली कितनी स्ट्रिंग हैं. मेरा सुझाव है कि इस प्रोजेक्ट में इनकी समीक्षा की जाए. मेरा अनुमान है कि स्टाइल गाइड बनाने में करीब तीन हफ़्ते (ड्राफ़्ट से लेकर मंज़ूरी मिलने तक) लगेंगे. यह काम, स्ट्रिंग को सिस्टम स्ट्रिंग या उपयोगकर्ता को दी जाने वाली कैटगरी के तौर पर कैटगरी में बांटने के साथ-साथ किया जा सकता है. मेरा सुझाव है कि शुरुआत में यह मानकर चलता है कि प्रोजेक्ट सामान्य अवधि (तीन महीने) का होगा. इस प्रोजेक्ट में, समीक्षा के लिए सिर्फ़ उतनी ही स्ट्रिंग शामिल की जाती हैं जितनी इस समयसीमा में मुमकिन हो सकती हैं.
मैं पहले से ही फ़ुल टाइम जॉब हूं, इसलिए मैं दिन के कुछ ही हिस्से में इस प्रोजेक्ट पर काम कर पाऊँगा. अगर आपको लगता है कि मेरे काम के घंटों को कम करने की ज़रूरत होगी, तो मैं लंबी अवधि का प्रोजेक्ट बनाने के लिए तैयार हूं.