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