इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- 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 इंस्टॉल करने का तरीका.
गेम लोड करने, जोड़ने, और लॉन्च करने का तरीका.
ScommVM इंस्टॉल करना:
जिन मामलों में इंस्टॉल करना आसान नहीं होता या उपयोगकर्ता के पास तकनीकी जानकारी नहीं होती, उनमें उपयोगकर्ता को ScummVM को किसी भी काम करने वाले प्लैटफ़ॉर्म पर इंस्टॉल करने के लिए, पूरी जानकारी वाली गाइड की ज़रूरत होती है.
इंस्टॉलेशन के बारे में पूरी जानकारी देने वाले हर पेज पर ये चीज़ें शामिल होनी चाहिए:
- सिस्टम से जुड़ी ज़रूरी शर्तें/शर्तें.
- ScummVM का सही वर्शन डाउनलोड करने का तरीका.
- ScummVM इंस्टॉल करने का तरीका.
- चुने गए प्लैटफ़ॉर्म पर गेम लोड करने का तरीका. खास तौर पर, जब वह प्लैटफ़ॉर्म वह न हो जिसके लिए गेम डिज़ाइन किया गया था.
ScummVM को लॉन्च करने, गेम जोड़ने, और गेम लॉन्च करने का तरीका.
ScummVM का इस्तेमाल करना:
उपयोगकर्ताओं को ऐसे रेफ़रंस दस्तावेज़ों की ज़रूरत होती है जो SCommVM को इस्तेमाल करने के तरीके की जानकारी देते हैं.
रेफ़रंस दस्तावेज़ों में ये चीज़ें शामिल होनी चाहिए:
- लॉन्चर इंटरफ़ेस; हर विंडो और टैब कैसा दिखता है और कैसे काम करता है.
- ग्लोबल और गेम के हिसाब से उपलब्ध सेटिंग की जानकारी.
कीबोर्ड शॉर्टकट/हॉटकी.
बेहतर विकल्प:
गेम के बेहतर तरीके से चलने के लिए, बेहतर उपयोगकर्ताओं को उनके लिए उपलब्ध विकल्पों के बारे में ज़्यादा तकनीकी जानकारी चाहिए.
- गेम के बारे में जानकारी:
गेम से जुड़ी ऐसी जानकारी जिसे उपयोगकर्ता को जानना ज़रूरी है. इसमें ये चीज़ें शामिल हैं, लेकिन इन तक ही सीमित नहीं हैं: - इंस्टॉल करने से जुड़ी समस्याएं - ज़रूरी अतिरिक्त फ़ाइलें - असामान्य या अलग-अलग कंट्रोल
- आम तौर पर होने वाली समस्याएं:
इस सेक्शन में रिलीज़ से जुड़ी वे सभी गड़बड़ियां होनी चाहिए जिनके बारे में पहले से जानकारी है.
- रिलीज़ नोट:
हमारे दस्तावेज़ को अलग-अलग वर्शन में तैयार किया जाएगा, लेकिन रिलीज़ नोट सेक्शन की मदद से आपको नई रिलीज़ में हुए बदलावों की खास जानकारी मिल सकती है. इसमें कुछ ऐसे विषय शामिल हो सकते हैं जो फ़िलहाल इस दस्तावेज़ के दायरे से बाहर हैं. जैसे, नए गेम या नए इंजन के बारे में जानकारी.
समस्या हल करने का तरीका:
मेरा सुझाव है कि हम ScummVM इंस्टॉल करने के पेजों के लिए एक टेंप्लेट बनाएं. इससे, मुझे पोर्ट के रखरखाव करने वालों/डेवलपर से वह जानकारी आसानी से मिल जाएगी जो मुझे चाहिए. खास तौर पर, जहां यह जानकारी कम है या मौजूद नहीं है. मेरे पास मौजूदा दस्तावेज़ों में पहले से मौजूद जानकारी को पहले से ही भर दिया जाएगा. इसके बाद, इस बात की जांच की जा सकेगी कि जानकारी पूरी है या नहीं. साथ ही, यह भी देखा जा सकता है कि जानकारी सटीक है या नहीं. इसके अलावा, यह भी देखा जा सकता है कि जानकारी सही है या नहीं. इसके अलावा, ज़रूरत पड़ने पर दस्तावेज़ में जानकारी जोड़ी जा सकती है.
इसके बाद, मैं मौजूदा दस्तावेज़ों, README, विकी, और वेबसाइट को देखूंगा. जैसे-जैसे मैं काम शुरू करता जाएगा, वैसे-वैसे मैं हर सेक्शन को ज़रूरत के मुताबिक दोबारा लिखूंगा और जोड़ूंगी. साथ ही, पूरी जानकारी को नए पोर्टल में ले जाऊंगी. मैं इस बात का भी ध्यान रखूंगा कि कौनसी जानकारी कहां से ली गई थी, ताकि यह पक्का हो सके कि पोर्टल लाइव होने के बाद कोई भी दोगुने, विरोधाभास या दूसरी अनियमितताएं न हों.
इस दौरान, मैं किसी भी जानकारी को इकट्ठा करने के लिए, मेंटर, डेवलपर, पोर्ट मैनेजर, और विषय के अन्य विशेषज्ञों से संपर्क करूंगा. साथ ही, यह पक्का करूंगा कि हर पेज अप-टू-डेट और पूरी जानकारी वाला हो.
साथ मिलकर काम करने के मकसद से, मैं चाहता/चाहती हूं कि लेखन की पूरी प्रोसेस के दौरान, ScummVM कम्यूनिटी के पास पोर्टल का ऐक्सेस हो. इससे हमें रीयल-टाइम में सुझाव/शिकायत/राय मिलती रहेगी और यह पक्का किया जा सकेगा कि कोई भी जानकारी छूट न जाए. हालांकि, इसके लिए, मुझे अपने मेंटर की अनुमति लेनी होगी.
हमारा सुझाव है कि आप Google developer साइट पर दस्तावेज़ों की शैली के लिए गाइडलाइन जैसी स्टाइल गाइड का इस्तेमाल करें. इससे, इस काम और आने वाले समय में तैयार किए जाने वाले सभी दस्तावेज़ों के लिए, एक जैसी शैली का इस्तेमाल किया जा सकेगा.
जहां भी हो सके, मैं समझ को बेहतर बनाने के लिए स्क्रीनशॉट, GIF, और दूसरे विज़ुअल का इस्तेमाल करूंगा.
सुझाई गई समयावधि:
कम्यूनिटी बॉन्डिंग 17 अगस्त से 13 सितंबर, 2020
प्रोजेक्ट के विज़न को बेहतर बनाने और दस्तावेज़ के स्ट्रक्चर और कॉन्टेंट जैसी जानकारी को फ़ाइनल करने के लिए, अपने मेंटर और ScummVM कम्यूनिटी के साथ बातचीत करना जारी रखें.
पहला हफ़्ता 14 सितंबर से 20 सितंबर
- प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन पेजों के लिए टेंप्लेट बनाएं.
- टेम्प्लेट में मौजूदा जानकारी पहले से भरें और ज़्यादा जानकारी के लिए, पोर्ट को मैनेज करने वाले/डेवलपर को दें.
दूसरा हफ़्ता 21 सितंबर से 27 सितंबर
- नया डॉक्यूमेंटेशन पोर्टल सेट अप करें.
तीसरा हफ़्ता 28 सितंबर से 4 अक्टूबर
ScummVM का इस्तेमाल करना: - इंटरफ़ेस - ग्लोबल सेटिंग ScummVM इंस्टॉल करना: - मुझे प्लैटफ़ॉर्म के हिसाब से इंस्टॉल करने की गाइड मिलती हैं, क्योंकि टेंप्लेट पूरे हो चुके होते हैं.
चौथा हफ़्ता 5 अक्टूबर - 11 अक्टूबर
SCommVM का इस्तेमाल करना: - गेम की सेटिंग - कीबोर्ड शॉर्टकट ScumVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉलेशन की गाइड, पूरे हो चुके टेंप्लेट के तौर पर मुझे वापस भेज दी जाती हैं
पांचवां हफ़्ता 12 अक्टूबर से 18 अक्टूबर
बेहतर विकल्प: - क्लाउड और एलएएन - कंट्रोल मैपिंग ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉल करने की गाइड, क्योंकि मुझे पूरे टेंप्लेट वापस मिलते हैं
छठा हफ़्ता 19 अक्टूबर - 25 अक्टूबर
बेहतर विकल्प: - कॉन्फ़िगरेशन - कमांड-लाइन के विकल्प ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉल करने की गाइड, क्योंकि मुझे पूरे टेंप्लेट वापस मिलते हैं
सातवां हफ़्ता 26 अक्टूबर - 1 नवंबर
बेहतर विकल्प: - ग्राफ़िक - ऑडियो ScommVM इंस्टॉल करना: - पूरे हो चुके टेंप्लेट के तौर पर, प्लैटफ़ॉर्म के हिसाब से इंस्टॉल करने से जुड़ी गाइड मुझे वापस भेज दी गई है
आठवां हफ़्ता 2 नवंबर से 8 नवंबर
सहायता: - अक्सर पूछे जाने वाले सवाल - संपर्क - पहले से मालूम समस्याएं
ScummVM इंस्टॉल करना: - प्लैटफ़ॉर्म के हिसाब से इंस्टॉल करने के लिए गाइड, क्योंकि मुझे पूरे टेंप्लेट वापस मिलते हैं
नौवां हफ़्ता 9 नवंबर से 15 नवंबर
सहायता: - गड़बड़ी की शिकायत करना - गेम के बारे में जानकारी - रिलीज़ नोट
SCommVM इंस्टॉल करना: - जो भी प्लैटफ़ॉर्म गाइड अभी तक पूरी नहीं हुई हैं उन्हें तैयार करें.
दसवां हफ़्ता 16 नवंबर - 22 नवंबर
- पोर्टल से जुड़े किसी भी फ़ैसले को फ़ाइनल करना, जैसे कि साइडबार नेविगेशन, थीम/सीएसएस में बदलाव वगैरह. साथ ही, आखिरी बार बदलाव करना और प्रूफ़रीडिंग करना.
- पक्का करें कि सभी लिंक उम्मीद के मुताबिक काम कर रहे हों.
- देखें कि इमेज/GIF सही तरीके से दिख रहे हैं या नहीं.
11वां हफ़्ता 23 नवंबर - 30 नवंबर
- सभी बकाया आइटम तैयार करें और आधिकारिक तौर पर पोर्टल लॉन्च करें!
- पोर्टल लॉन्च होने के बाद, मेंटॉर की सलाह पर अन्य सोर्स से ग़ैर-ज़रूरी जानकारी हटाएं.