साल 2021 की केस स्टडी रिपोर्ट

मौजूदा फ़ेज़:
Docs का सीज़न 2021 प्रोग्राम 14 दिसंबर, 2021 को खत्म हो गया. टाइमलाइन देखें.

ध्यान दें: इस रिपोर्ट में, प्रोग्राम के मूल आवेदनों और संगठनों की फ़ाइनल केस स्टडी का डेटा शामिल होता है. पूरी केस स्टडी, 2021 Season of Docs के नतीजों वाले पेज से लिंक की गई हैं.

Season of Docs के बारे में जानकारी

Season of Docs, एक ऐसा प्रोग्राम है जिसका मकसद पर्यावरण को बनाए रखना है. इसे Google Open Source Programs Office मैनेज करता है. Season of Docs के लक्ष्य ये हैं:

• दस्तावेज़ों की मदद से, प्रोजेक्ट की समस्याओं को हल करने के लिए, ओपन सोर्स प्रोजेक्ट के लिए सहायता उपलब्ध कराना
• तकनीकी लेखकों को ओपन सोर्स में अनुभव पाने के अवसर दें
• ओपन सोर्स, दस्तावेज़, और तकनीकी लेखन के बारे में जागरूकता बढ़ाना
• ओपन सोर्स दस्तावेज़ों में असरदार मेट्रिक के बारे में जानकारी इकट्ठा करना और शेयर करना

'दस्तावेज़ों का सीज़न' के बारे में ज़्यादा जानकारी, इस कार्यक्रम की वेबसाइट पर उपलब्ध है.

साल 2021 के प्रोग्राम की खास जानकारी

साल 2021 में कार्यक्रम में हुए बदलाव

साल 2019 और 2020 में, संगठनों और तकनीकी लेखकों ने सीज़न ऑफ़ द डॉक्स प्रोग्राम में अलग-अलग आवेदन किया था. साथ ही, सीज़न ऑफ़ द डॉक्स प्रोग्राम के एडमिन ने तकनीकी लेखकों को संगठनों के साथ जोड़ा था. संगठनों ने तकनीकी लेखकों के साथ काम करने के लिए, उन्हें मेंटर उपलब्ध कराए. इन लेखकों को उनके काम के लिए, उनकी जगह के हिसाब से स्टाइपेंड दिया गया. इस प्रोग्राम में यह मेज़र किया गया कि तकनीकी लेखक, मेंटर, और संगठन के एडमिन, प्रोग्राम में शामिल होने से संतुष्ट हैं या नहीं. हालांकि, इसमें दस्तावेज़ से जुड़े नतीजों को मेज़र नहीं किया गया.

साल 2021 में, Season of Docs की टीम ने इस प्रोग्राम में अहम बदलाव किए. इन बदलावों के तहत, दस्तावेज़ से मिलने वाले नतीजों को मेज़र करने पर फ़ोकस किया गया. साथ ही, संगठनों और तकनीकी लेखकों को ज़्यादा सुविधाएं दी गईं.

• ऐसे संगठन जिन्होंने प्रोजेक्ट के प्रस्ताव सबमिट किए हैं. इनमें बजट और सुझाई गई मेट्रिक शामिल हैं
• अब तक, तकनीकी लेखक Google के ज़रिए आवेदन करके, संगठनों से जुड़ने की कोशिश करते थे. हालांकि, अब वे सीधे तौर पर उन संगठनों से आवेदन कर सकते हैं जिन्हें मंज़ूरी मिली है
• स्वीकार किए गए संगठनों को Open Collective के ज़रिए अनुदान मिले. उन्होंने इसका इस्तेमाल, तकनीकी लेखकों को पेमेंट करने के लिए किया
• तकनीकी लेखकों के लिए, संगठनों ने वेतन तय किया था
• संगठनों ने फ़ाइनल आकलन और केस स्टडी सबमिट की हैं. साथ ही, फ़ॉलोअप सर्वे के जवाब दिए हैं

साल 2021 की सामान्य जानकारी

संगठन

• साल 2021 के कार्यक्रम में किए गए बदलावों की वजह से, कम संगठनों ने आवेदन किया. हमने देखा कि 2021 की तुलना में 2020 में 30% कम संगठनों ने आवेदन किया. हालांकि, 2021 के संगठन के एडमिन, 2020 के एडमिन की तुलना में कार्यक्रम से थोड़े ज़्यादा संतुष्ट थे (93% बनाम 91%)

समस्याएं, दस्तावेज़ टाइप, और मेट्रिक

• ज़्यादातर प्रोजेक्ट, दस्तावेज़ बनाने पर फ़ोकस करते हैं, ताकि समस्याओं/सवालों को कम करके, रखरखाव करने वाले व्यक्ति का बोझ कम किया जा सके और/या प्रोजेक्ट में लोगों की दिलचस्पी बढ़ाई जा सके. प्रोजेक्ट में दिलचस्पी बढ़ने का मतलब है कि प्रोजेक्ट के उपयोगकर्ता या योगदान देने वाले लोग, प्रोजेक्ट में ज़्यादा हिस्सा लें.
  • स्वीकार किए गए 50% संगठनों ने ट्यूटोरियल या 'कैसे करें' वाला कॉन्टेंट बनाया है.
  • स्वीकार किए गए 50% से ज़्यादा संगठनों ने माना कि उनके मौजूदा दस्तावेज़ों में ज़रूरी जानकारी मौजूद नहीं है, वे व्यवस्थित नहीं हैं या पुराने हैं.
• आम तौर पर, प्रोजेक्ट के लिए यह जानना ज़रूरी होता है कि दस्तावेज़ों का इस्तेमाल कितना किया जा रहा है. इसके लिए, वे इंटरैक्शन का इस्तेमाल करते हैं. जैसे, दस्तावेज़ों में कम समस्याएं आना, दस्तावेज़ों पर आने वाले लोगों की संख्या बढ़ना, और प्रोजेक्ट में लोगों की भागीदारी बढ़ना.
• नवंबर 2022 तक, 30 में से 25 प्रोजेक्ट ने जवाब दिया:
  • 18 प्रोजेक्ट ने बताया कि वे अपनी मूल मेट्रिक को पूरा कर चुके हैं
  • पांच प्रोजेक्ट, बदली गई मेट्रिक की शर्तें पूरी करते थे
  • दो प्रोजेक्ट के लिए, यह कहना अभी जल्दबाजी होगी

प्रोग्राम में हिस्सा लेना

• संगठन के एडमिन के लिए, तकनीकी लेखकों को भर्ती करना, उन्हें नौकरी देना, और उन्हें पैसे देना, प्रोग्राम का सबसे मुश्किल हिस्सा था.
• नवंबर 2022 तक, 30 में से 24 संगठनों ने जवाब दिया:
  • 18 संगठन, अब भी अपने सीज़न ऑफ़ डॉक्स के तकनीकी लेखकों के साथ काम कर रहे थे. ये लेखक, लगातार योगदान देने वाले या सवालों के जवाब देने वाले संसाधन के तौर पर काम कर रहे थे
    • चार संगठन, Season of Docs के तकनीकी लेखकों के साथ पेमेंट लेकर काम कर रहे थे

साल 2021 की हाइलाइट

• कई प्रोजेक्ट में यह जानकारी दी गई थी कि उनके तकनीकी लेखक का मकसद, सीज़न ऑफ़ डॉक्स प्रोग्राम खत्म होने के बाद भी अपने प्रोजेक्ट पर काम करना है
• Metanorma के लिए, ज़रूरी शर्तें पूरी करने वाले तकनीकी लेखकों ने इतनी संख्या में आवेदन किया कि उन्हें एक और लेखक को भी हायर करने के लिए, मैचिंग फ़ंड मिल गया. इस लेखक को, प्रोग्राम के दौरान, Season of Docs के तहत काम करने वाले लेखक के साथ काम करना था
• Moja Global को पता चला कि कम्यूनिटी, दस्तावेज़ बनाने में काफ़ी दिलचस्पी ले रही है. इसलिए, उसने दस्तावेज़ बनाने के लिए एक नया वर्किंग ग्रुप सेट अप किया, ताकि ज़्यादा से ज़्यादा लोग प्रोजेक्ट के दस्तावेज़ बनाने में हिस्सा ले सकें

साल 2021 का खास जानकारी वाला डेटा

साल 2021 में, 82 संगठनों ने आवेदन किया था. इनमें से 30 ओपन सोर्स संगठनों को इस कार्यक्रम में शामिल किया गया. (चुने जाने की ज़रूरी शर्तों के बारे में जानने के लिए, ऐप्लिकेशन बनाने से जुड़ी गाइड देखें.) इस कार्यक्रम में हिस्सा लेने वाले संगठनों की पूरी सूची, Season of Docs की वेबसाइट पर देखी जा सकती है. 2021 के कार्यक्रम में हिस्सा लेने के लिए, स्वीकार किए गए सभी 30 संगठनों ने अपनी केस स्टडी की आखिरी रिपोर्ट सबमिट कर दी है.

संगठनों के बारे में जानकारी

सीज़न ऑफ़ डॉक्स 2021 में हिस्सा लेने वाले संगठनों ने अलग-अलग तरह के ओपन सोर्स प्रोजेक्ट दिखाए. साल 2021 के कोहॉर्ट में ये शामिल थे:

• भाषा से जुड़े बड़े प्रोजेक्ट, जैसे कि Julia, Perl, और R
• शिक्षा, जलवायु, फ़िनटेक, स्वास्थ्य सेवा, लाइब्रेरी सेवाएं, मशीन लर्निंग, मास स्पेक्ट्रोमेट्री, सार्वजनिक समझौते, और रोबोटिक्स से जुड़े प्रोजेक्ट
• डेवलपर के हिसाब से बनाए गए प्रोजेक्ट. इनमें, चॉस इंजीनियरिंग टूल, फ़ज़र, चैटबॉट SDK, सॉफ़्टवेयर कॉम्पोज़िशन के विश्लेषण की पाइपलाइन, परफ़ॉर्मेंस मॉनिटरिंग टूल, और विज़ुअल प्रोग्रामिंग टूल शामिल हैं
• दस्तावेज़ बनाने वाले टूल के लिए दस्तावेज़ बनाने के प्रोजेक्ट. जैसे, Redocly और Metanorma

Python इकोसिस्टम प्रोजेक्ट सबसे बड़ी सबकैटगरी थी. साल 2021 के कोहॉर्ट में ArviZ, NumPy, MicroPython, PyMC3, PyTorch-Ignite, और SymPy शामिल थे.

हमने प्रोजेक्ट के बारे में कोई मेटाडेटा इकट्ठा नहीं किया है. जैसे, प्रोजेक्ट की शुरुआत की तारीख, योगदान देने वाले लोगों की भौगोलिक जानकारी, योगदान देने वाले लोगों की संख्या या उपयोगकर्ताओं की संख्या.

हमने प्रोजेक्ट से यह बताने के लिए कहा था कि उन्होंने किस ओपन सोर्स लाइसेंस का इस्तेमाल किया है.

साल 2021 में शामिल संगठनों ने दस्तावेज़ से जुड़ी जो समस्याएं बताई हैं वे ओपन सोर्स प्रोजेक्ट और तकनीकी दस्तावेज़, दोनों में बहुत आम हैं.

साल 2021 के प्रोग्राम में, संगठनों को इन मुख्य समस्याओं को हल करने की उम्मीद थी:

ध्यान दें कि संगठन, दस्तावेज़ से जुड़ी कई समस्याओं की शिकायत कर सकते हैं. ज़्यादा जानकारी के लिए, सीज़न ऑफ़ द डॉक्स 2021 का नतीजों का पेज देखें. इस पेज पर, हर संगठन की पूरी केस स्टडी का लिंक मौजूद है.

बनाए गए दस्तावेज़ों के टाइप

साल 2021 की केस स्टडी में, ट्यूटोरियल सबसे ज़्यादा इस्तेमाल किए गए दस्तावेज़ों में से एक थे.

केस स्टडी में बताए गए अन्य दस्तावेज़ों में दस्तावेज़ के तौर पर कोड पाइपलाइन, डायग्राम, शब्दावली, स्टाइल गाइड, अक्सर पूछे जाने वाले सवाल, अंतरराष्ट्रीय स्तर पर उपलब्ध कराना, कोडलैब, कॉन्टेंट मॉडल, मॉड्यूल, कॉन्सेप्ट दस्तावेज़, गड़बड़ी के मैसेज, उपयोगकर्ता के बारे में रिसर्च, रीड मी, नॉलेजबेस शामिल हैं.

इनमें से कुछ कैटगरी फ़ज़ी होती हैं. साथ ही, किसी दस्तावेज़ प्रोजेक्ट में कई तरह के दस्तावेज़ या सुविधाएं हो सकती हैं.

कई प्रोजेक्ट में, दस्तावेज़ के टाइप की योजना बनाने के लिए, Diátaxis फ़्रेमवर्क का इस्तेमाल किया गया है.

ज़्यादा जानकारी के लिए, सीज़न ऑफ़ द डॉक्स 2021 का नतीजों का पेज देखें. इस पेज पर, हर संगठन की पूरी केस स्टडी का लिंक मौजूद है.

बजट मैनेज करना

साल 2021 में, बजट के लिए किए गए अनुरोध की औसत रकम 10,200 डॉलर थी और मीडियन 10,000 डॉलर था. सिर्फ़ तीन संगठनों ने ज़्यादा से ज़्यादा अनुदान (15 हज़ार डॉलर) का अनुरोध किया और उन्हें यह अनुदान भी मिला. वहीं, तीन अन्य संगठनों ने कम से कम अनुदान (5 हज़ार डॉलर) का अनुरोध किया.

सक्रिय उपयोगकर्ताओं से जुड़ी मेट्रिक

उनकी केस स्टडी में बताए गए प्रोजेक्ट, जिन मेट्रिक का इस्तेमाल करके वे अपने दस्तावेज़ बनाने वाले प्रोजेक्ट की सफलता का आकलन कर रहे थे.

सुझाई गई मुख्य मेट्रिक ये थीं:

सुझाई गई अन्य मेट्रिक में GitHub पर स्टार, पेज पर बिताया गया समय, मेलिंग सूची के कन्वर्ज़न, उपयोगकर्ता की क्वालिटी की जांच, फ़ोरम में हिस्सा लेने वाले लोगों की संख्या, पार्टनर/वॉलंटियर/इंटिग्रेशन की संख्या शामिल थीं.

तकनीकी लेखन के प्रोजेक्ट पूरे करने और केस स्टडी सबमिट करने के बीच कम समय होने की वजह से, 2021 के ज़्यादातर कोहॉर्ट ने इतना डेटा इकट्ठा नहीं किया था जिससे यह पता लगाया जा सके कि उनकी शुरुआती मेट्रिक पूरी हुई हैं या नहीं.

ज़्यादा जानकारी के लिए, सीज़न ऑफ़ द डॉक्स 2021 का नतीजों का पेज देखें. इस पेज पर, हर संगठन की पूरी केस स्टडी का लिंक मौजूद है.

तकनीकी लेखकों के साथ काम करना

साल 2021 में, 'Docs का सीज़न' प्रोग्राम में सबसे बड़ा बदलाव यह था कि इसमें तकनीकी लेखकों के साथ प्रोजेक्ट कैसे काम करते हैं. पिछले सीज़न में, तकनीकी लेखक सीधे Google के लिए आवेदन करते थे. इसके बाद, प्रोग्राम एडमिन उन्हें प्रोजेक्ट के हिसाब से जोड़ते थे. साथ ही, उन्हें सीधे Google से एक तय रकम का स्टाइपेंड मिलता था.

साल 2021 में, तकनीकी लेखकों ने सीधे प्रोजेक्ट के लिए आवेदन किया. साथ ही, प्रोजेक्ट ने तकनीकी लेखकों को मिलने वाले पैसों का बजट तय किया. पेमेंट, सीज़न ऑफ़ डॉक्स के ओपन कलेटिव फ़ंड से किया गया.

साल 2021 के कार्यक्रम में हिस्सा लेने वाले ज़्यादातर प्रोजेक्ट के पास, तकनीकी लेखकों को भर्ती करने या उन्हें नौकरी देने का बहुत कम या कोई अनुभव नहीं था. कई प्रोजेक्ट ने इस प्रोसेस के इस हिस्से को ऐसे बताया जिसे ज़्यादा मदद की ज़रूरत है. इस सुझाव के आधार पर, Season of Docs की टीम ने प्रोग्राम गाइड में तकनीकी लेखक के साथ कानूनी समझौते बनाने के लिए दस्तावेज़ जोड़े हैं.

कर्मचारियों को नियुक्त करने के सुझाव

प्रोजेक्ट को, सीज़न ऑफ़ दस्तावेज़ में हिस्सा लेने के इच्छुक अन्य प्रोजेक्ट के लिए सुझाव देने के लिए कहा गया था. कर्मचारियों को नियुक्त करने के लिए ये सुझाव सबसे ज़्यादा दिए गए:

• तकनीकी लेखकों को भर्ती करने के लिए, ज़रूरी दस्तावेज़ जल्द से जल्द शेयर करें. भले ही, आपको प्रोग्राम में शामिल होने की मंज़ूरी न मिली हो. अपनी कम्यूनिटी से, संभावित उम्मीदवारों के नाम बताने के लिए कहें.
• प्रोजेक्ट के चैनलों के बाहर भी शेयर किया जा सकता है. सभी को पसंद आने वाली भाषा का इस्तेमाल करें. साथ ही, ऐसे उम्मीदवारों को सीधे तौर पर आवेदन करने के लिए बढ़ावा दें जो कम प्रतिनिधित्व वाले समुदायों से हैं.
• जानें कि दस्तावेज़ बनाने की प्रोसेस के लिए कौनसे टूल ज़रूरी हैं. साथ ही, उन टूल का इस्तेमाल करने का अनुभव रखने वाले तकनीकी लेखकों को भर्ती करें.
• डिलीवर किए जाने वाले आइटम और माइलस्टोन, कम्यूनिकेशन चैनल और चेक-इन, पेमेंट की प्रोसेस और समय के बारे में, तकनीकी लेखक के लिए साफ़ तौर पर बताएं.
• कम्यूनिटी के सदस्यों को निवेश करने और उन्हें तकनीकी लेखक के तौर पर आगे बढ़ने में मदद करने के लिए, 'Docs का सीज़न' में तकनीकी लेखक के तौर पर सलाह और कोचिंग दें.
• तकनीकी लेखकों को शामिल करने, कार्यक्रम के दौरान सवालों के जवाब देने, और सहायता देने के लिए, ज़रूरत से ज़्यादा समय का बजट रखें. ऐसा तब ज़रूरी है, जब तकनीकी लेखक के पास आपके प्रोजेक्ट के डोमेन में पहले से कोई अनुभव न हो.
• आने वाले समय में इस्तेमाल करने के लिए, भर्ती, नौकरी देने, और कर्मचारियों को शामिल करने की प्रोसेस को दस्तावेज़ में रिकॉर्ड करें.

(ध्यान दें: सभी प्रोजेक्ट ने अपनी केस स्टडी में यह नहीं बताया है कि उन्होंने तकनीकी लेखक के लिए उम्मीदवारों की भर्ती कहां की.)

तकनीकी लेखकों के साथ काम करने में आने वाली सामान्य समस्याएं

COVID या अन्य बीमारियों की वजह से, कई प्रोजेक्ट के तकनीकी लेखकों को अपनी ज़िम्मेदारियों को पूरा करने के लिए, प्रोजेक्ट छोड़ने पड़े. इसके अलावा, महामारी की वजह से परिवार की ज़िम्मेदारियों को पूरा करने के लिए भी, कई लेखकों को प्रोजेक्ट छोड़ने पड़े. कुछ प्रोजेक्ट ने टाइमज़ोन के मेल न खाने या इंटरनेट कनेक्टिविटी से जुड़ी समस्याओं की वजह से, कम्यूनिकेशन से जुड़ी समस्याओं की शिकायत की है.

प्रोजेक्ट को पता चला कि उन्होंने अपनी कम्यूनिटी में शामिल होने या अपने प्रोजेक्ट के दस्तावेज़ों के टूलचेन को सेट अप करने में आने वाली मुश्किलों को कम करके आंका था.

Open Collective के साथ बैंकिंग से जुड़ी समस्याओं या लेखकों के देश में पेमेंट से जुड़ी पाबंदियों की वजह से, कुछ प्रोजेक्ट को अपने तकनीकी लेखकों को पेमेंट करने में देरी हुई.

Open Collective के शुल्कों के बारे में कार्यक्रम के दस्तावेज़ में साफ़ तौर पर जानकारी नहीं दी गई थी: Google ने प्रोजेक्ट में पैसे ट्रांसफ़र करने के लिए, Open Collective के लेन-देन शुल्क को कवर किया था. हालांकि, पेमेंट के कुछ अन्य चैनलों (जैसे, मुद्रा बदलने पर लगने वाला शुल्क) से लिए जाने वाले लेन-देन शुल्क को कवर नहीं किया था. हम आने वाले समय में होने वाले प्रोग्राम के दस्तावेज़ों में, इस बारे में साफ़ तौर पर बताएंगे.

फ़ॉलो-अप सर्वे

'दस्तावेज़ों का सीज़न' प्रोग्राम के तहत, प्रोजेक्ट को फ़ॉलोअप सर्वे में हिस्सा लेने के लिए कहा गया था. मई, अगस्त, और नवंबर 2022 में तीन सर्वे भेजे गए थे.

फ़ॉलोअप सर्वे में, प्रोजेक्ट से यह पुष्टि करने के लिए कहा गया था कि उनके प्रपोज़ल और केस स्टडी के लिंक अब भी चालू हैं या नहीं. इस सर्वे में, उनके प्रोजेक्ट की सफलता के बारे में भी सवाल पूछे गए. यह सफलता, उनकी केस स्टडी में सेट की गई मेट्रिक के हिसाब से तय की गई. साथ ही, प्रोजेक्ट के तकनीकी लेखकों की लगातार भागीदारी और उन्हें मिलने वाले पैसे के बारे में भी सवाल पूछे गए:

1. क्या आप अब भी Season of Docs के तकनीकी लेखक के साथ काम कर रहे हैं?

1. अगर आपका तकनीकी लेखक अब भी आपके प्रोजेक्ट के लिए काम कर रहा है, तो क्या उसे किसी तरह से पैसे मिल रहे हैं?

1. क्या आपको लगता है कि इस प्रोजेक्ट के बाद, दस्तावेज़ तैयार करने की प्रोसेस पूरी हो गई है?

आने वाले समय में पूछे जाने वाले सवाल

हमेशा की तरह, ओपन सोर्स में दस्तावेज़ों के बारे में जितनी ज़्यादा जानकारी मिलती है, हम उतना ही ज़्यादा जानना चाहते हैं! आने वाले सीज़न में, हमें इन चीज़ों के बारे में जानने की उम्मीद है:

• प्रोजेक्ट के डोमेन, दस्तावेज़ टाइप के विकल्प या मेट्रिक के विकल्प से जुड़े हैं या नहीं
• प्रोजेक्ट पूरा करने और तकनीकी लेखक को अपने साथ जोड़े रखने के लिए, तकनीकी लेखक को हायर करने और उसे शामिल करने के कौनसे तरीके सबसे असरदार हैं
• दस्तावेज़ की परफ़ॉर्मेंस का आकलन करने के लिए तय की गई समयसीमा

हालांकि, हमें कई सवालों के जवाब चाहिए, लेकिन हम ओपन सोर्स प्रोजेक्ट के उन एडमिन और मैनेजर के समय का भी सम्मान करना चाहते हैं जो सीज़न ऑफ़ द डॉक्स में हिस्सा लेते हैं. इस प्रोग्राम की मुख्य प्राथमिकता, दस्तावेज़ों की मदद से प्रोजेक्ट की समस्याओं को हल करने में उनकी मदद करना है.