इस पेज पर Google 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 इंस्टॉल करने का तरीका जानें.
गेम को लोड करने, जोड़ने, और लॉन्च करने का तरीका.
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 नवंबर
- सभी बचे हुए आइटम तय करें और आधिकारिक तौर पर पोर्टल लॉन्च करें!
- पोर्टल लॉन्च हो जाने के बाद, मेंटॉर की सलाह से दूसरे सोर्स से गैर-ज़रूरी जानकारी हटा दें.