इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- कलेक्टिव खोलें
- तकनीकी लेखक:
- एना ए सो
- प्रोजेक्ट का नाम:
- सामान्य सहायता दस्तावेज़ को बेहतर बनाएं
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
पहली झलक आम तौर पर दस्तावेज़ों वाले ऐसे पेज आते हैं जिनमें बिना किसी समर्थन मीडिया (वीडियो, GIF, इमेज) के निर्देश दिए गए होते हैं, जबकि एक ही चैप्टर के दूसरे सेक्शन में ज़्यादा पूरी एंट्री होती है - उदाहरण के लिए, कलेक्टिव में बदलाव करें में सिर्फ़ निर्देश दिए गए होते हैं, जबकि फ़िस्कल होस्ट में सहायक मीडिया शामिल होता है.
मैंने जो पेज ब्राउज़ किए हैं उनमें, वैकल्पिक लेख विशेषता का इस्तेमाल करके किसी मीडिया के बारे में नहीं बताया गया है. इमेज के बारे में जानकारी न होने की वजह से, स्क्रीन रीडर इस्तेमाल करने वालों और धीमे इंटरनेट कनेक्शन का इस्तेमाल करने वाले लोगों को दस्तावेज़ की पूरी जानकारी नहीं मिल पाती. इस वजह से, हो सकता है कि कोई भी मीडिया लोड न हो पाए.
दस्तावेज़ के कुछ सेक्शन, अक्सर पूछे जाने वाले सवालों और यूज़र इंटरफ़ेस पर नेविगेट करने के लिए सीधे तौर पर दिए गए निर्देशों, जैसे कि फ़िस्कल होस्ट बदलें को मर्ज करते हैं. दस्तावेज़ों के इंटरफ़ेस में कोई विषय-सूची नहीं है. इसलिए, अगर किसी उपयोगकर्ता को रजिस्ट्रेशन रिकॉर्ड में बदलाव के नतीजों के बारे में पता है और वह सिर्फ़ मकसद के लिए निर्देश चाहता है, तो वह दस्तावेज़ को ज़्यादा शब्दों में और बहुत ज़्यादा छूने वाला लग सकता है.
तकनीकी दस्तावेज़ों की भाषा एक जैसी है, लेकिन सार्वजनिक तौर पर उपलब्ध स्टाइल गाइड में इस बारे में बहुत कम जानकारी दी गई है कि दस्तावेज़ कैसे लिखा जाना चाहिए. योगदान देने वाले पेज पर, तकनीकी दस्तावेज़ों में योगदान के बारे में बताया गया है. इसलिए, Open कलेक्टिव और संभावित योगदान देने वाले, दोनों को ही दिशा-निर्देशों का ज़्यादा से ज़्यादा फ़ायदा मिलेगा.
प्रस्ताव मेरा सुझाव है कि उपयोगकर्ताओं के सहायता पेजों की समीक्षा करें और उनके प्रज़ेंटेशन और मौजूदा स्ट्रक्चर पर फिर से विचार करें.
मेथडोलॉजी और टाइमलाइन मुझे ओपन कलेक्टिव डॉक्यूमेंटेशन को बेहतर बनाने के लिए कम्यूनिटी के साथ काम करना है, ताकि अलग-अलग समय के लिए लगातार सुझाव, शिकायत या राय को प्रमोट किया जा सके.
कम्यूनिटी के साथ जुड़ने की अवधि (1 अगस्त से 1 सितंबर, 2019): ओपन कलेक्टिव कम्यूनिटी के बारे में जानना! अहम और शुरुआती प्रोजेक्ट के सक्रिय सदस्यों का इंटरव्यू लेते हुए, उनसे दस्तावेज़ की मौजूदा स्थिति के बारे में सवाल पूछते हैं (रिपोर्ट #1). क्वेरी और समस्याओं को ट्रैक करने के लिए इस्तेमाल किए जाने वाले सभी इंटरनल सिस्टम और ओपन कलेक्टिव दस्तावेज़ में उनका दस्तावेज़ बनाने की प्रक्रिया का ध्यान रखते हुए (रिपोर्ट #2). दस्तावेज़ के मौजूदा वर्शन में गुप्त समस्याओं का मूल्यांकन और उन्हें हल करने के लिए योजना तैयार करने की रिपोर्ट (रिपोर्ट #3).
2 से 6 सितंबर: पहला फ़ीडबैक और अडजस्टमेंट साइकल. इसमें, कम्यूनिटी के साथ जुड़ने की अवधि के दौरान कम्यूनिटी की सभी टिप्पणियों और सुझावों को ध्यान में रखा जाता है. क्या हमारी योजना आगे बढ़ने के लिए तैयार है? क्या इसमें कुछ ऐसा है जिसमें बदलाव करने की ज़रूरत है? (रिपोर्ट #4)
9 से 20 सितंबर: दस्तावेज़ के कम पॉप्युलेट चैप्टर के साथ कॉन्सेप्ट की पुष्टि करने वाला कॉन्टेंट तैयार करना. सार्वजनिक स्टाइल गाइड का ड्राफ़्ट (रिपोर्ट #5).
23 से 25 सितंबर: आकलन के लिए सिद्धांत के प्रमाण का सबमिशन (क्लोज़्ड ग्रुप).
26 से 27 सितंबर: क्या लाइव होने से पहले, हमारे कॉन्सेप्ट में कोई बदलाव करने की ज़रूरत है? क्या हमें ज़्यादा समय चाहिए? उसी हिसाब से बदलाव करें. (रिपोर्ट #6)
30 सितंबर से 9 अक्टूबर: कॉन्सेप्ट का सबूत लाइव होता है. सुझाव, शिकायत या राय का दूसरा साइकल (सार्वजनिक ग्रुप).
10 से 15 अक्टूबर: कॉन्सेप्ट के आकलन और अडजस्टमेंट साइकल का फ़ाइनल प्रूफ़. (रिपोर्ट #7)
16 से 20 अक्टूबर: गतिविधियों से छोटा ब्रेक [1].
21 अक्टूबर से 23 नवंबर: पब्लिक स्टाइल गाइड आखिरी है (रिपोर्ट #8). उपयोगकर्ता के दस्तावेज़ वाले सभी पेजों के लिए, स्टाइल गाइड में दिए गए सभी निर्देशों को लागू करना (रिपोर्ट #9). की गई सभी गतिविधियों के आकलन की रिपोर्ट और समुदाय के लिए आगे के सुझाव (रिपोर्ट #10).
अनुरोध करने पर प्रोजेक्ट की अवधि बढ़ाई जा सकती है.
[1]: मेरे Docs के सीज़न से पहले यात्रा की योजना है.
डिलीवरेबल्स - की गई गतिविधियों पर दस सार्वजनिक रिपोर्ट - ओपन कलेक्टिव और बाहरी योगदान देने वालों, दोनों के लिए पब्लिक स्टाइल गाइड का इस्तेमाल किया जा सकता है - उपयोगकर्ता के दस्तावेज़ों वाले पेजों को बेहतर बनाया गया है