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

मौजूदा चरण:
दस्तावेज़ तैयार करना. टाइमलाइन देखें.

Docs का सीज़न, एक ईको-फ़्रेंडली प्रोग्राम है. इसे Google Open Source Programs Office मैनेज करता है. Docs के सीज़न के मकसद हैं:

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

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

2022 के कार्यक्रम की खास जानकारी

Docs का सीज़न कैसे काम करता है

Docs के सीज़न में, संगठन प्रोजेक्ट का प्रस्ताव सबमिट करके आवेदन करते हैं. प्रोजेक्ट के प्रस्ताव में ये चीज़ें शामिल हैं:

  • संगठन के बारे में जानकारी
  • प्रोजेक्ट में जो समस्या आ रही है उसकी जानकारी
  • प्रोजेक्ट अपनी समस्या को हल करने के लिए दस्तावेज़ का इस्तेमाल किस तरह करेगा
  • प्रोजेक्ट, अपने दस्तावेज़ (मेट्रिक) के असर का आकलन कैसे करेगा
  • काम की समयावधि
  • प्रोजेक्ट का बजट
  • कोई भी अतिरिक्त जानकारी, जैसे कि मिलते-जुलते प्रोग्राम के लिए संगठन का अनुभव या ऐसी कोई भी अन्य जानकारी जिससे Docs के सीज़न के एडमिन को अपने प्रोजेक्ट और समस्या को समझने में मदद मिल सकती है

इस कार्यक्रम में शामिल होने के बाद, संगठन अपने तकनीकी लेखकों को सीधे तौर पर भर्ती करते हैं और उनकी भर्ती करते हैं. Docs का सीज़न, संगठनों को फ़ंड देने के लिए Open Collective का इस्तेमाल करता है. साथ ही, संगठन Open Collective की मदद से, तकनीकी लेखकों को पेमेंट करते हैं. प्रोजेक्ट के बजट और पेमेंट में पारदर्शिता होती है. बजट, Docs की साइट के सीज़न पर उपलब्ध संगठन के प्रोजेक्ट के प्रपोज़ल में शामिल किए जाते हैं. साथ ही, पेमेंट Docs Open Collective खाते के सीज़न में दिखते हैं.

जब वे अपनी केस स्टडी रिपोर्ट सबमिट करते हैं, तब यह माना जाता है कि संगठनों ने प्रोग्राम को सफलतापूर्वक पूरा कर लिया है. प्रोग्राम के दौरान, संगठनों को हर महीने आकलन करने के लिए कहा जाता है. साथ ही, प्रोग्राम पूरा होने के बाद अगले साल तीन तिमाही में फिर से सर्वे करने के लिए भी कहा जाता है.

2022 की हाइलाइट

“नया दस्तावेज़ रिलीज़ होने के बाद, Casbin और Casdoor पर रोज़ाना होने वाला विज़िट करीब दोगुना हो गया और बाउंस रेट करीब 30% कम हो गया.”—कैसबिन

“इस प्रोजेक्ट का सबसे बड़ा फ़ायदा यह रहा है कि [हमारे तकनीकी लेखकों] को, हमारी कम्यूनिटी में लीडरशिप की भूमिका निभाते हुए देखा जा रहा है. योगदान देने वाले दोनों लोग, अब वर्क ग्रुप और कम्यूनिटी मीटिंग को लीड कर रहे हैं. साथ ही, हमारे प्रोजेक्ट को डिज़ाइन करने और उनके रखरखाव में भी अपना योगदान दे रहे हैं.” —moja-global

“[GSoD] ने दो काबिल तकनीकी लेखकों को भर्ती करने में हमारी मदद की है, जो कि सामान्य सेट अप में काफ़ी मुश्किल होता है. ये लेखक OpenMined में काम कर रहे हैं और उनके साथ काम करने का हमारा अनुभव बहुत अच्छा रहा है.”

इसके अलावा, नया मैनुअल नए लोगों के लिए कंप्यूटेशनल मास स्पेक्ट्रोमेट्री के लिए बहुत आसान है. इसे समझने के लिए: सीज़ेडआई अनुदान, ऐतिहासिक तौर पर वंचित लोगों को भी फ़ायदा मुहैया कराता है. साथ ही, कुछ पुरस्कार पाने वालों ने अपने छह हफ़्ते की इंटर्नशिप पीरियड को तुरंत शुरू करने के लिए, OpenMS मैन्युअल का इस्तेमाल किया है. साथ ही, इन लोगों ने नए मैन्युअल की अच्छी समीक्षा की है.” —OpenMS

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

साल 2022 में, Docs of Docs प्रोग्राम ने 67 आवेदनों में से 31 प्रोजेक्ट स्वीकार किए और 30 प्रोजेक्ट ने इस प्रोग्राम को पूरा किया. स्वीकार किए गए 31 संगठनों में से 17 संगठनों में, दोबारा आवेदन करने वाले संगठन शामिल थे.

स्वीकार किए गए 31 प्रोजेक्ट में 58 तकनीकी लेखकों की भर्ती की गई. 190 से ज़्यादा तकनीकी लेखकों ने इस प्रोग्राम में हिस्सा लेने में अपनी दिलचस्पी दिखाई है. इसके लिए, Docs GitHub के रेपो के सीज़न में अपनी संपर्क जानकारी और अपने पोर्टफ़ोलियो के लिंक जोड़े.

2022 कार्यक्रम के लिए:

  • आवेदन करने की प्रोसेस के साथ सभी संगठनों को अच्छा अनुभव मिला
  • सभी संगठनों को प्रोग्राम की वेबसाइट दस्तावेज़/कॉन्टेंट से अच्छा अनुभव मिला
  • 93% संगठनों को प्रोग्राम से अच्छा अनुभव मिला
  • 90% संगठनों को लगता है कि उनका दस्तावेज़ प्रोजेक्ट सफल रहा

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

Docs 2022 के सीज़न में हिस्सा लेने वाले संगठनों ने, कई ओपन सोर्स प्रोजेक्ट का प्रतिनिधित्व किया. साल 2022 के कोहॉर्ट में ये शामिल हैं:

स्वीकार किए गए प्रोजेक्ट से दिखाए गए डोमेन दिखाता बार ग्राफ़: डेटा: 5 प्रोजेक्ट; डेवलपमेंट टूल: 4 प्रोजेक्ट; असली उपयोगकर्ता के ऐप्लिकेशन: 7 प्रोजेक्ट; हार्डवेयर और रोबोटिक्स: 2 प्रोजेक्ट; इंफ़्रास्ट्रक्चर और क्लाउड: 4 प्रोजेक्ट; प्रोग्रामिंग भाषाएं और टूल: 3 प्रोजेक्ट; विज्ञान और चिकित्सा: 3 प्रोजेक्ट; सुरक्षा: 1 प्रोजेक्ट; सोशल और कम्यूनिकेशन: 1 प्रोजेक्ट; वेब टूल और फ़्रेमवर्क: 1 प्रोजेक्ट

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

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

हर ओएसएस लाइसेंस का इस्तेमाल करने वाले प्रोजेक्ट की संख्या दिखाने वाला बार ग्राफ़: AGPL-3.0: 2 Project; Apache-2.0: 9 प्रोजेक्ट; BSD-3- क्लॉज़: 4 प्रोजेक्ट; GPL-3.0: 3 प्रोजेक्ट; LGPL 3.0: 3 प्रोजेक्ट; MIT: 5 प्रोजेक्ट; Mozilla Public लाइसेंस 2.0: 2 Project, LG-PL1 प्रोजेक्ट, BSL-PL-1.0.

डॉक्यूमेंटेशन प्रोजेक्ट के बारे में जानकारी

दस्तावेज़ से जुड़ी समस्याएं

संगठन, 2022 के कार्यक्रम के दस्तावेज़ों की मदद से जिन समस्याओं को हल करने की उम्मीद कर रहे थे उनमें ये मुख्य समस्याएं शामिल हैं:

संगठनों की ओर से रिपोर्ट की गई समस्याओं को दिखाता हुआ बार ग्राफ़: एक प्रोजेक्ट के पहलुओं के खास इस्तेमाल के मामलों के लिए दस्तावेज़ों की कमी है: 16 प्रोजेक्ट; दस्तावेज़ अव्यवस्थित हैं: 11 प्रोजेक्ट; दस्तावेज़ पुराने हैं: 7 प्रोजेक्ट; दस्तावेज़ एक जैसे नहीं हैं: 1 प्रोजेक्ट; दस्तावेज़ों को किसी दूसरे टूल, प्लैटफ़ॉर्म या फ़ॉर्मैट में बदलने की ज़रूरत है: 8 प्रोजेक्ट

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

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

2022 की केस स्टडी में, 'कैसे करें' दस्तावेज़ ऐसे दस्तावेज़ों में सबसे ज़्यादा शामिल था जिनके बारे में बताया गया था.

बनाए गए दस्तावेज़ों के टाइप दिखाने वाला चार्ट:  कैसे करें: 12 प्रोजेक्ट; ट्यूटोरियल: 9 प्रोजेक्ट; रेफ़रंस: 8 प्रोजेक्ट; लैंडिंग पेज: 5 प्रोजेक्ट; एपीआई दस्तावेज़: 4 प्रोजेक्ट; डायग्राम, स्क्रीनशॉट, इलस्ट्रेशन: 4 प्रोजेक्ट; शुरू करना, स्टाइल गाइड, हैंडबुक: हर एक को तीन प्रोजेक्ट; उदाहरण, कॉन्सेप्ट दस्तावेज़, उपयोगकर्ता के रिसर्च: हर प्रोजेक्ट के लिए दो प्रोजेक्ट

केस स्टडी में बताए गए अन्य तरह के दस्तावेज़ों में ये शामिल हैं:

  • क्विकस्टार्ट
  • शब्दावली
  • अक्सर पूछे जाने वाले सवाल
  • नॉलेज बेस
  • घटक
  • ब्लॉग/सोशल मीडिया कॉन्टेंट
  • रखरखाव गाइड

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

ज़्यादा जानकारी के लिए, Docs 2022 सीज़न के नतीजों वाला पेज देखें. यह पेज, हर संगठन के लिए ओरिजनल प्रोजेक्ट प्रपोज़ल और पूरी केस स्टडी से जुड़ा है.

बजट

औसत बजट अनुरोध 11,679 डॉलर और मीडियन 12,150 डॉलर था. पांच संगठनों ने अनुरोध किया और सबसे ज़्यादा अनुदान ($15 हज़ार) और तीन ने सबसे कम ($5 हज़ार से $7 हज़ार के बीच) का अनुरोध किया.

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

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

टॉप प्रस्तावित मेट्रिक ये थीं:

दस्तावेज़ की सफलता की मेट्रिक दिखाने वाला बार ग्राफ़: ज़्यादा योगदान देने वाले/पाने वाले अनुरोध: 12 प्रोजेक्ट; दस्तावेज़ों में कवर की गई टारगेट जानकारी का कुल प्रतिशत: 8 प्रोजेक्ट; प्रोजेक्ट की कम समस्याएं/सवाल: सात प्रोजेक्ट; दस्तावेज़ों/दस्तावेज़ों के इस्तेमाल की संख्या में ज़्यादा लोग: 6 प्रोजेक्ट; बेहतर एसईओ: 5 प्रोजेक्ट; दस्तावेज़ों में बेहतर संतुष्टि (सर्वे के ज़रिए), प्रोजेक्ट के इस्तेमाल में बढ़ोतरी, ज़्यादा GitHub स्टार/फ़ोर्क: दो GitHub स्टार/फ़ोर्क: बनाए गए ज़्यादा GitHub प्रोजेक्ट, और दस्तावेज़ों की कुल संख्या

अन्य प्रस्तावित मेट्रिक शामिल हैं:

  • पुल के अनुरोध/योगदान के लिए ज़्यादा दस्तावेज़
  • दस्तावेज़ पेजों के बारे में ज़्यादा सीधे तौर पर सुझाव/राय देना या शिकायत करना
  • पेज पर बिताया गया समय
  • समस्याएं बताई गई हैं (इस्तेमाल के लिए प्रॉक्सी के तौर पर)
  • फ़ोरम में हिस्सा लेने वाले लोग
  • पार्टनर/वॉलंटियर/इंटिग्रेशन की संख्या
  • कम बाउंस दर
  • समुदाय में जागरूकता बढ़ाई गई.

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

साल 2023 में फ़ॉलोअप सर्वे के जवाब मिलने के बाद, हम इस रिपोर्ट को अपडेट करेंगे. इसमें हम यह जानकारी देंगे कि किन प्रोजेक्ट ने अपनी मेट्रिक हासिल की है या किन प्रोजेक्ट की मेट्रिक में बदलाव किया है.

ज़्यादा जानकारी के लिए, Docs 2022 सीज़न के नतीजों वाला पेज देखें. यह पेज, हर संगठन के लिए ओरिजनल प्रोजेक्ट प्रपोज़ल और पूरी केस स्टडी से जुड़ा है.

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

Docs प्रोग्राम के सीज़न में, प्रोजेक्ट में तकनीकी लेखकों को सीधे तौर पर भर्ती करने, उनका इंटरव्यू लेने, उन्हें नौकरी पर रखने, और पेमेंट करने की उम्मीद होती है. तकनीकी लेखक हमारे GitHub डेटा स्टोर करने की जगह में, सीज़न ऑफ़ 'Docs' से मैनेज की जाने वाली डायरेक्ट्री में खुद को जोड़ सकते हैं. हालांकि, 'Docs का सीज़न' स्टाफ़, तकनीकी लेखकों की जांच नहीं करता और न ही उनका सुझाव देता है.

ओपन सोर्स प्रोजेक्ट के लिए, तकनीकी लेखकों को काम पर रखने के सबसे सही तरीके

प्रोजेक्ट में, तकनीकी लेखकों को भर्ती करने, उन्हें नौकरी पर रखने, और उनके साथ काम करने से जुड़े सबसे सही तरीके बताने के लिए कहा गया था. सबसे अच्छे सुझाव ये थे:

नियुक्ति

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

हाइरिंग

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

तालमेल और बातचीत

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

प्रोसेस और टूलिंग

  • एक ऐसी दस्तावेज़ प्रक्रिया बनाएं जो 'Docs का सीज़न' प्रोग्राम के आखिर तक चलती हो और जिसमें पूरा समुदाय योगदान दे सके
  • दस्तावेज़ों की समीक्षा में कम से कम उतना ही समय लगेगा जितना कि कोड की समीक्षा. पक्का करें कि इन्हें पूरा करने के लिए, ज़रूरत के मुताबिक समय दिया गया हो

साफ़ तौर पर जानकारी देने के लिए, कुछ सुझावों में बदलाव किया गया है और उन्हें छोटा किया गया है.

साल 2021 के कार्यक्रम की तरह, Docs 2022 के सीज़न में काम करने वाले ज़्यादातर तकनीकी लेखकों ने, उन संगठनों पर सीधे आवेदन किया जिनके साथ उन्होंने काम किया था.

टेक्निकल राइटर के उम्मीदवारों का सोर्स दिखाने वाला बार ग्राफ़: प्रोग्राम पर सीधे तौर पर लागू किया गया: 18; SoD GitHub या SoD का पिछला हिस्सा: 6; समुदाय का सदस्य: 5; नहीं बताया गया है: 3; जॉब साइट के ज़रिए लागू किया गया: 1

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

लेखकों के काम करने से जुड़ी तकनीकी समस्याओं को दिखाने वाला बार ग्राफ़: ताइवान में विज्ञापन नहीं दिखाने से जुड़ी समस्याएं: चार प्रोजेक्ट; बातचीत से जुड़ी समस्याएं, ताइवान में शामिल होने की प्रक्रिया, ताइवान में कौशल की कमी, डोमेन की जानकारी का अभाव, हार्डवेयर पर मालिकाना हक, मौजूदा काम में समस्या की जानकारी: हर एक प्रोजेक्ट

साल 2022 के कार्यक्रम में, कुछ प्रोजेक्ट में तकनीकी लेखकों के साथ काम करने में आने वाली समस्याओं की शिकायत की गई थी. तकनीकी लेखकों के लिए प्रोग्राम पूरा न कर पाना, बीमारी, फ़ुल-टाइम नौकरी या अपने समय की तय सीमा पूरी न कर पाने की वजह से सबसे बड़ी समस्या थी.

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

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

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

आने वाले समय के लिए सवाल

हमेशा की तरह, हम ओपन सोर्स में दस्तावेज़ों के बारे में जितना ज़्यादा जानेंगे, उतना ही ज़्यादा हम सीखना चाहेंगे!

आने वाले सीज़न में, हमें उम्मीद है कि:

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

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