इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- Open Collective
- टेक्निकल राइटर:
- Anna e só
- प्रोजेक्ट का नाम:
- सामान्य सहायता दस्तावेज़ को बेहतर बनाना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
पहली नज़र में क्या दिखता है आम तौर पर, दस्तावेज़ के पेजों पर निर्देशों के साथ मीडिया (वीडियो, GIF, इमेज) नहीं दिखता. हालांकि, उसी चैप्टर के दूसरे सेक्शन में ज़्यादा जानकारी होती है. उदाहरण के लिए, Edit Collective में सिर्फ़ निर्देश हैं, जबकि Add Fiscal Host में मीडिया शामिल है.
मैंने जिन पेजों को ब्राउज़ किया है उनमें, ऑल्ट टेक्स्ट एट्रिब्यूट का इस्तेमाल करके किसी भी मीडिया की जानकारी नहीं दी गई है. इमेज के ब्यौरे न होने की वजह से, स्क्रीन रीडर का इस्तेमाल करने वाले लोग और धीमे इंटरनेट कनेक्शन का इस्तेमाल करने वाले लोग दस्तावेज़ को पूरी तरह से समझ नहीं पाते. ऐसा इसलिए होता है, क्योंकि धीमे इंटरनेट कनेक्शन पर कोई भी मीडिया लोड नहीं हो पाता.
दस्तावेज़ के कुछ सेक्शन अक्सर पूछे जाने वाले सवालों और यूज़र इंटरफ़ेस पर नेविगेट करने के निर्देशों को मर्ज करते हैं, जैसे कि फ़िस्कल होस्ट बदलें. दस्तावेज़ के इंटरफ़ेस में विषय सूची नहीं होती है. इसलिए, अगर उपयोगकर्ता को रजिस्ट्रेशन रिकॉर्ड में बदलाव के नतीजों के बारे में पता है और वह सिर्फ़ सही निर्देश पाना चाहता है, तो वह दस्तावेज़ को ज़्यादा शब्दों वाला और बहुत ज़्यादा टैनजंटल मान सकता है.
तकनीकी दस्तावेज़ों की भाषा एक जैसी होती है. हालांकि, सार्वजनिक तौर पर उपलब्ध स्टाइल गाइड में, दस्तावेज़ को लिखने के तरीके के बारे में बहुत कम जानकारी दी गई है. योगदान पेज पर, तकनीकी दस्तावेज़ों में योगदान देने के बारे में बताया गया है. इसलिए, ज़्यादा बेहतर दिशा-निर्देशों से Open Collective और संभावित योगदानकर्ता, दोनों को फ़ायदा मिलेगा.
प्रस्ताव हमारा सुझाव है कि उपयोगकर्ताओं के सहायता पेजों की समीक्षा की जाए. साथ ही, उनके प्रज़ेंटेशन और मौजूदा स्ट्रक्चर को फिर से तैयार किया जाए.
तरीका और टाइमलाइन मुझे कम्यूनिटी के साथ मिलकर काम करके, Open Collective के दस्तावेज़ों को बेहतर बनाना है. इसके लिए, हम अलग-अलग समयावधि के लिए लगातार सुझाव, राय या शिकायत देने की सुविधा को बढ़ावा देंगे.
कम्यूनिटी बॉन्डिंग पीरियड (1 अगस्त से 1 सितंबर, 2019): Open Collective कम्यूनिटी के बारे में जानना! लोकप्रिय और नए प्रोजेक्ट के सक्रिय सदस्यों का इंटरव्यू लेकर, उनसे दस्तावेज़ की मौजूदा स्थिति के बारे में सवाल पूछना (रिपोर्ट #1). क्वेरी और समस्याओं को ट्रैक करने के लिए इस्तेमाल किए जाने वाले सभी इंटरनल सिस्टम और Open Collective के दस्तावेज़ों (रिपोर्ट #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]: सीज़न ऑफ़ द डॉक्स के लिए आवेदन करने से पहले, यात्रा की योजना बनाई गई थी.
डिलीवर किए जाने वाले आइटम - की गई गतिविधियों के बारे में 10 सार्वजनिक रिपोर्ट - एक सार्वजनिक स्टाइल गाइड, जिसका इस्तेमाल Open Collective और बाहरी योगदान देने वाले लोग कर सकते हैं - उपयोगकर्ता के दस्तावेज़ के पेजों को फिर से डिज़ाइन किया गया