इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- ScummVM
- तकनीकी लेखक:
- कैडी
- प्रोजेक्ट का नाम:
- दस्तावेज़ का पोर्टल लॉन्च करना
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
मकसद:
- अलग-अलग सोर्स से बड़ी मात्रा में जानकारी इकट्ठा करके और जानकारी को फिर से लिखकर, साफ़, एक जैसा, और पूरा होने के लिए, अच्छी क्वालिटी और अलग-अलग असली उपयोगकर्ता के दस्तावेज़ बनाने के लिए.
- दस्तावेज़ ऐसे होने चाहिए जिन्हें टेक्नोलॉजी की जानकारी रखने वाले उपयोगकर्ताओं की मदद के बजाय, आसानी से समझा जा सके.
- स्टैटिक-साइट जनरेटर का इस्तेमाल करके, दस्तावेज़ों का पोर्टल बनाने के लिए.
- आने वाले समय में ओपन सोर्स में योगदान देने वालों के लिए, टेंप्लेट और 'कैसे करें' निर्देशों का इस्तेमाल करके, असली उपयोगकर्ता के लिए दस्तावेज़ बनाएं और उन्हें आने वाले समय के लिए सुरक्षित बनाएं.
मौजूदा स्थिति:
- ScummVM से जुड़े दस्तावेज़ कई सोर्स से उपलब्ध हैं.
- जानकारी को ढूंढना कठिन होता है और अक्सर डुप्लीकेट हो जाते हैं. अनजान पेजों में खो जाना आसान होता है.
- यह जानना काफ़ी मुश्किल है कि कौनसी जानकारी हाल ही की है और कौनसी जानकारी पुरानी है.
- कुछ जानकारी मौजूद नहीं है या अधूरी है.
समस्या ठीक करना:
दस्तावेज़ का सुझाया गया स्ट्रक्चर:
लैंडिंग पेज
|-- शुरू करना
| -- Quick start guide
|-- Installing ScummVM
| |-- Nintendo 3DS
| |-- AmigaOS
| |-- Android
| |-- (every)
| |-- (common)
| |-- (supported)
|-- (प्लैटफ़ॉर्म)
|-- ScummVM का इस्तेमाल करना
| |-- लॉन्चर
| |-- ग्लोबल सेटिंग
| |-- गेम की सेटिंग
| -- Keyboard shortcuts
|-- Advanced options
| |-- Cloud and LAN
| |-- Control Mapping
| |-- Configuration
| |-- Command line options
| |-- Graphics
|-- संगीत और आवाज़
|-- सहायता
| |-- अक्सर पूछे जाने वाले सवाल
| |-- संपर्क
| |-- जानी-पहचानी समस्याएं
| -- Reporting a bug
|-- Game Notes-- प्रॉडक्ट की जानकारी
- शुरुआत करना:
नए उपयोगकर्ता अक्सर जल्द से जल्द साइट शुरू करने के लिए, आसानी से सिखाने वाली गाइड का इस्तेमाल करते हैं. कुछ प्लैटफ़ॉर्म पर ScummVM को इंस्टॉल करना मुश्किल हो सकता है, लेकिन कंप्यूटर पर इंस्टॉल करना मुश्किल हो सकता है.
क्विकस्टार्ट गाइड में ये चीज़ें शामिल होनी चाहिए:
- Windows, Mac, और Linux पर ScummVM इंस्टॉल करने का तरीका.
गेम को लोड करने, जोड़ने, और लॉन्च करने का तरीका.
ScummVM इंस्टॉल किया जा रहा है:
जिन मामलों में ऐप्लिकेशन को इंस्टॉल करना आसान नहीं है या जिनमें उपयोगकर्ता के पास मज़बूत तकनीकी आधार नहीं है उनमें ScummVM को इंस्टॉल करने के लिए पूरी जानकारी देने वाली गाइड की ज़रूरत होती है. यह गाइड, उन सभी प्लैटफ़ॉर्म पर इंस्टॉल की जा सकती है जिन पर ScummVM को इंस्टॉल किया जा सकता है.
हर इंस्टॉल पेज में ये चीज़ें शामिल होनी चाहिए:
- सिस्टम से जुड़ी कोई भी शर्त/ज़रूरी शर्तें.
- ScummVM का सही वर्शन डाउनलोड करने का तरीका.
- ScummVM इंस्टॉल करने का तरीका.
- चुने गए प्लैटफ़ॉर्म पर गेम कैसे लोड करें. खास तौर पर, जब यह उस प्लैटफ़ॉर्म के लिए न हो जिसके लिए गेम डिज़ाइन किया गया था.
ScummVM लॉन्च करने, गेम जोड़ने, और गेम लॉन्च करने का तरीका.
ScummVM का इस्तेमाल करना:
उपयोगकर्ताओं को उन रेफ़रंस दस्तावेज़ों की ज़रूरत होगी जो ScummVM के इस्तेमाल का तरीका बताते हैं.
पहचान फ़ाइल के दस्तावेज़ों में ये चीज़ें शामिल होनी चाहिए:
- लॉन्चर इंटरफ़ेस; हर विंडो और टैब कैसे दिखते हैं और वे कैसे काम करते हैं.
- ग्लोबल और गेम के हिसाब से उपलब्ध सेटिंग की जानकारी.
कीबोर्ड शॉर्टकट/हॉटकी.
बेहतर विकल्प:
बेहतर जानकारी रखने वाले उपयोगकर्ताओं को उनके लिए उपलब्ध विकल्पों के बारे में ज़्यादा तकनीकी जानकारी चाहिए, ताकि वे अपने गेम खेलने के तरीके में बदलाव कर सकें.
- गेम नोट:
उपयोगकर्ता को गेम से जुड़ी ऐसी कोई भी जानकारी चाहिए जिसे जानने की ज़रूरत हो. इसमें इनके अलावा, और भी चीज़ें शामिल हो सकती हैं: - इंस्टॉल करने के तरीके - ज़रूरी कोई भी अतिरिक्त फ़ाइल - असामान्य या अलग तरह के कंट्रोल
- ज्ञात समस्याएं:
इस सेक्शन में, रिलीज़ से जुड़ी ऐसी सभी गड़बड़ियां शामिल होनी चाहिए जिनके बारे में पहले से जानकारी है.
- प्रॉडक्ट की जानकारी:
हमारे दस्तावेज़ों का वर्शन बनाया जाएगा. हालांकि, रिलीज़ नोट सेक्शन की मदद से, सबसे नई रिलीज़ में किए गए बदलावों के बारे में खास जानकारी हासिल की जा सकती है. इसमें कुछ ऐसे विषय शामिल हो सकते हैं जो फ़िलहाल इस दस्तावेज़ के दायरे से बाहर हैं. जैसे, नए गेम या नए इंजन के बारे में जानकारी.
हमले का प्लान:
मेरा सुझाव है कि आप ScummVM इंस्टॉल करने के पेजों के लिए एक टेंप्लेट बनाएं. इससे मुझे पोर्ट के रखरखाव/डेवलपर से ज़रूरी जानकारी पाने का सबसे आसान तरीका मिलेगा. खास तौर पर, जहां यह जानकारी मौजूद नहीं है या मौजूद नहीं है. मौजूदा दस्तावेज़ में दी गई जानकारी, मेरे पास पहले से ही भर जाएगी. इसके बाद, इस बात की जांच की जा सकती है कि जानकारी पूरी, सटीक, और मुद्रा में है या नहीं. इसके अलावा, ज़रूरत के मुताबिक दस्तावेज़ में जोड़ी जा सकती है.
इसके बाद, मैं मौजूदा दस्तावेज़ों को ध्यान से पढ़ूंगा; README, विकी, और वेबसाइट. आगे बढ़ते हुए, मैं ज़रूरत के हिसाब से हर सेक्शन को फिर से लिखूंगी और सभी जानकारी डालूंगा/जोड़ूंगी और पूरी जानकारी नए पोर्टल में डालूंगा/डालूंगी. मैं इस बात का भी ध्यान रखेगा कि कौनसी जानकारी कहां से ली गई है, ताकि यह पक्का किया जा सके कि पोर्टल के लाइव होने के बाद, कोई डबल-अप, कॉन्ट्राडिक्शन या दूसरी अनियमितताएं न हों.
इस दौरान, मैं मेंटॉर, डेवलपर, पोर्ट का रखरखाव करने वाले लोगों, और विषय की जानकारी रखने वाले अन्य विशेषज्ञों के साथ संपर्क करूंगा/करूंगी, ताकि छूटी हुई जानकारी इकट्ठा की जा सके. साथ ही, यह भी पक्का किया जाएगा कि हर पेज अप-टू-डेट और जानकारी से जुड़ा हो.
साथ मिलकर काम करने और मेंटॉर की अनुमति के आधार पर, मुझे लिखने की पूरी प्रक्रिया के दौरान, ScummVM कम्यूनिटी के लिए काम पर बना पोर्टल ऐक्सेस करना है. ऐसा इसलिए, ताकि रीयल-टाइम में सुझाव मिल सके और यह पक्का किया जा सके कि इस दौरान कोई भी जानकारी न छूटे.
हमारा सुझाव है कि आप स्टाइल गाइड का इस्तेमाल करें, जैसे कि Google डेवलपर दस्तावेज़ की स्टाइल गाइड. इससे यह पक्का किया जा सकेगा कि आगे के सभी दस्तावेज़ों में आपको एक जैसा अनुभव मिलेगा.
जहां भी मुमकिन हो, मैं स्क्रीनशॉट, GIF, और दूसरे विज़ुअल एलिमेंट का इस्तेमाल करूंगा/करूंगी, ताकि आप बेहतर तरीके से समझ सकें.
सुझाई गई टाइमलाइन:
कम्यूनिटी बॉन्डिंग 17 अगस्त से 13 सितंबर, 2020
प्रोजेक्ट को बेहतर बनाने और दस्तावेज़ के स्ट्रक्चर और कॉन्टेंट जैसी जानकारी को अंतिम रूप देने के लिए, मेंटॉर और ScummVM कम्यूनिटी के लोगों से बात करते रहें.
पहला हफ़्ता 14 सितंबर से 20 सितंबर
- प्लैटफ़ॉर्म के हिसाब से, इंस्टॉल करने के पेजों के लिए टेंप्लेट बनाएं.
- टेंप्लेट में किसी भी मौजूदा जानकारी को पहले से ही भरें और ज़्यादा जानकारी के लिए, इसे पोर्ट का रखरखाव करने वाले सही लोगों/डेवलपर को असाइन करें.
दूसरा हफ़्ता 21 सितंबर से 27 सितंबर
- दस्तावेज़ का नया पोर्टल सेट अप करें.
तीसरा हफ़्ता 28 सितंबर से 4 अक्टूबर
ScummVM का इस्तेमाल करना: - इंटरफ़ेस - ग्लोबल सेटिंग ScummVM इंस्टॉल करना: - पूरे किए जा चुके टेंप्लेट के तौर पर, प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन गाइड मुझे वापस दी जाती हैं.
चौथा हफ़्ता 5 अक्टूबर से 11 अक्टूबर
ScummVM का इस्तेमाल करना: - गेम सेटिंग - कीबोर्ड शॉर्टकट ScummVM इंस्टॉल करना: - पूरे हो चुके टेंप्लेट के तौर पर, प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन गाइड मुझे वापस दी जाती हैं
पांचवां हफ़्ता 12 अक्टूबर से 18 अक्टूबर
बेहतर विकल्प: - क्लाउड और LAN - मैपिंग कंट्रोल करें ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से, पूरे हो चुके टेंप्लेट के तौर पर इंस्टॉल करने की गाइड, मुझे वापस दी गई हैं
छठा हफ़्ता 19 अक्टूबर से 25 अक्टूबर
बेहतर विकल्प: - कॉन्फ़िगरेशन - कमांड लाइन के विकल्प ScummVM इंस्टॉल करना: - पूरे हो चुके टेंप्लेट के तौर पर, प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन गाइड मुझे वापस दी गई हैं
सातवां हफ़्ता 26 अक्टूबर से 1 नवंबर
बेहतर विकल्प: - ग्राफ़िक - ऑडियो ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन गाइड, पूरे किए गए टेंप्लेट के तौर पर मुझे वापस दी गई हैं
आठवां हफ़्ता 2 नवंबर से 8 नवंबर
सहायता: - अक्सर पूछे जाने वाले सवाल - संपर्क - ज्ञात समस्याएं
ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन गाइड, पूरे हो चुके टेंप्लेट के तौर पर मुझे वापस दी जाती हैं
नौवां हफ़्ता 9 नवंबर से 15 नवंबर
सहायता: - किसी गड़बड़ी की शिकायत करें - गेम के नोट - प्रॉडक्ट की जानकारी
ScummVM इंस्टॉल करना: - उन सभी प्लैटफ़ॉर्म गाइड को पूरा करें जो अभी तक पूरी नहीं हुई हैं.
10वां हफ़्ता 16 नवंबर से 22 नवंबर
- पोर्टल से जुड़े किसी भी फ़ैसले को फ़ाइनल एडिट करना, प्रूफ़रीड करना, और उसे फ़ाइनल करना. जैसे, साइडबार नेविगेशन, थीम/सीएसएस में बदलाव करना वगैरह.
- पक्का करें कि सभी लिंक उम्मीद के मुताबिक काम कर रहे हों.
- देखें कि इमेज/gif सही तरीके से दिख रहे हैं या नहीं.
11वां हफ़्ता 23 नवंबर से 30 नवंबर
- सभी बचे हुए काम पूरे करें और पोर्टल को आधिकारिक तौर पर लॉन्च करें!
- पोर्टल लॉन्च हो जाने के बाद, मेंटॉर की सलाह लेकर दूसरे सोर्स से गैर-ज़रूरी जानकारी हटाएं.