तकनीकी लेखकों के लिए गाइड

मौजूदा चरण:
नतीजे का एलान टाइमलाइन किया गया.

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

क्या आपको Docs प्रोग्राम के सीज़न में हिस्सा लेना चाहिए?

इन सवालों की मदद से, यह समझने में मदद पाएं कि Docs प्रोग्राम के सीज़न में, स्वीकार किए गए किसी संगठन के साथ काम करने में आपकी दिलचस्पी है या नहीं.

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

आपको ओपन कलेक्टिव खाता बनाने के साथ-साथ, कार्यक्रम की ज़रूरी शर्तों को भी पूरा करना होगा. कृपया ध्यान दें कि आपके पास कानूनी तौर पर, अपने घर में किए गए काम के लिए फ़ंड पाने की अनुमति होनी चाहिए. Docs प्रोग्राम के एडमिन, टैक्स से जुड़ी सलाह नहीं दे सकते या आपके काम से जुड़ी ज़रूरी शर्तों के बारे में सवालों के जवाब नहीं दे सकते.

सीज़न ऑफ़ Docs में हिस्सा लेने वाले एक कुशल तकनीकी लेखक के तौर पर, आपको ओपन सोर्स में काम करने का अनुभव पाने के लिए पैसे दिए जाएंगे. साथ ही, बेहतर दस्तावेज़ों की मदद से अपने प्रोजेक्ट की मुख्य ज़रूरत पूरी करने के लिए, आपको पैसे भी दिए जाएंगे.

सीज़न ऑफ़ Docs प्रोग्राम में तकनीकी लेखक के तौर पर हिस्सा लेना

एक्सप्लोरेशन (विश्लेषण का तरीका) का चरण

संगठन के आवेदन 25 मार्च, 2022 को रात 18:00 बजे यूटीसी पर बंद हो जाएंगे. हमारा सुझाव है कि तकनीकी लेखक जल्द से जल्द संभावित प्रोजेक्ट को एक्सप्लोर करना शुरू कर दें. हालांकि, संगठन 16 मई, 2022 को रात 18:00 बजे यूटीसी से पहले, किसी भी समय काम करने के लिए तकनीकी लेखकों को चुन सकते हैं.

  • अपनी पसंद के प्रोजेक्ट ढूंढें
    • ओपन सोर्स संगठनों से सीधे 'Docs का सीज़न' पेज पर दिए गए निर्देशों का इस्तेमाल करके संपर्क करें या Docs GitHub रिपॉज़िटरी पर जाएं. यहां उन संगठनों को खोजा जा सकता है जिन्होंने Docs के सीज़न में हिस्सा लेने में दिलचस्पी दिखाई है. आपको Write the Docs Slack से #सीज़न-of-docs चैनल पर भी दिलचस्पी रखने वाले संगठन मिल सकते हैं.
    • प्रोजेक्ट चुनने के कुछ तरीके:
      • किसी ऐसी भाषा में प्रोजेक्ट चुनें जिसे आप जानते हैं या जिसमें आपकी दिलचस्पी है, जैसे कि JavaScript या C.
      • मशीन लर्निंग, ओपन साइंस या रोबॉटिक्स जैसी टेक्नोलॉजी या डोमेन में अपनी पसंद का कोई प्रोजेक्ट चुनें.
      • समुदाय की सेहत के हिसाब से कोई प्रोजेक्ट चुनें! उनके चर्चा फ़ोरम में समय बिताएं, योगदान देने वालों के सोशल मीडिया खाते देखें (अगर वे वहां अपने प्रोजेक्ट के बारे में बात करते हैं), और अगर शामिल होने से जुड़ा कोई दस्तावेज़ है, तो उसे देखें.
      • अगर आपको किसी ऐसे प्रोजेक्ट पर काम करना है जो प्रोजेक्ट की सूची में मौजूद नहीं है, तो उससे संपर्क करें और उन्हें आवेदन करने के लिए कहें!
  • प्रोजेक्ट के प्रस्ताव वाले पेजों की समीक्षा करें
    • तीन से पांच प्रोजेक्ट बनाने के बाद, हर प्रोजेक्ट के प्रस्ताव वाला पेज देखें
    • आपको सवाल पूछने चाहिए, सुझाव देने चाहिए, और उन चैनलों का इस्तेमाल करके सुझाव देने चाहिए जिन्हें प्रोजेक्ट में शामिल किया गया है. इनका इस्तेमाल करके, आप अपने सुझाव, शिकायत या राय शेयर कर सकते हैं और चर्चा कर सकते हैं
  • अपनी पसंद का स्टेटमेंट सीधे संगठन को सबमिट करें. अपनी दिलचस्पी के ब्यौरे में, आपको दिखाएं कि संगठन के प्रोजेक्ट प्रपोज़ल में तय किए गए लक्ष्यों को आप किस तरह हासिल करेंगे.
    • 'Docs का सीज़न' के लिए दिलचस्पी के स्टेटमेंट टेंप्लेट का इस्तेमाल करें. छोटा होना बेहतर है!
    • अपनी पसंद का स्टेटमेंट सबमिट करने के लिए, संगठन के आइडिया पेज पर दिए गए निर्देशों का इस्तेमाल करें. अगर संगठन ने किसी खास शर्त को शामिल किया है, तो पक्का करें कि आप अपने स्टेटमेंट में उन ज़रूरतों को पूरा करते हैं.
    • अपनी पसंद का स्टेटमेंट सबमिट करने का मतलब है कि आप संगठन की आचार संहिता और Docs के आचार संहिता का पालन करने के लिए सहमत हैं.

ऐप्लिकेशन का फ़ेज़

  • Docs के सीज़न तक, स्वीकार किए जाने वाले संगठनों के एलान का इंतज़ार करें:
    • अगर स्वीकार किए गए संगठन आपके साथ काम करना चाहेंगे या आपके पसंद के स्टेटमेंट पर चर्चा करना चाहेंगे, तो वे सीधे आपसे संपर्क करेंगे.
    • संगठनों के लिए, सिर्फ़ ऐसे तकनीकी लेखकों के साथ काम करना नहीं होता जिन्होंने संगठन के आवेदन की आखिरी तारीख से पहले, अपनी पसंद के स्टेटमेंट सबमिट किए हों. मंज़ूरी मिलने के बाद, वे और जानकारी मांग सकते हैं. संगठनों को 16 मई, 2022 को 18:00 बजे यूटीसी से पहले, किसी टेक्निकल राइटर को चुनना होगा.
    • संगठनों को पसंद के गलत स्टेटमेंट पर सुझाव, शिकायत या राय देने की ज़रूरत नहीं है.

प्रोजेक्ट डेवलपमेंट का चरण

  • संगठन के साथ मिलकर एक शेड्यूल बनाएं. इसमें तय की गई तारीख और समय पर डिलीवर किए जाने वाले ऐप्लिकेशन की जानकारी शामिल करें.

आखिरी आकलन और केस स्टडी

  • संगठन के साथ मिलकर काम करें और फ़ाइनल इवैलुएशन और केस स्टडी के लिए ज़रूरी जानकारी दें.