मौजूदा चरण:
Docs का साल 2020 का सीज़न 15 मार्च, 2021 को खत्म हो गया है. टाइमलाइन
देखें.
इस पेज पर तकनीकी लेखकों के लिए दिशा-निर्देश दिए गए हैं कि इस साल के Docs के सीज़न में अपनी प्रोजेक्ट रिपोर्ट कैसे बनाई जा सकती है.
प्रोजेक्ट रिपोर्ट सबमिट करना
प्रोजेक्ट पूरा करने का चरण शुरू होने के बाद, तकनीकी राइट गाइड के प्रोजेक्ट फ़ाइनल करने वाले सेक्शन में दिए गए फ़ॉर्म को भरकर, अपनी प्रोजेक्ट रिपोर्ट सबमिट की जा सकती है.
प्रोजेक्ट रिपोर्ट में शामिल की जाने वाली जानकारी
इस सेक्शन में बताया गया है कि अपनी प्रोजेक्ट रिपोर्ट में किस तरह की जानकारी दी जा सकती है. प्रोजेक्ट रिपोर्ट फ़ॉर्म में, फ़्री-टेक्स्ट फ़ील्ड और कई विकल्प वाले सवाल शामिल होंगे.
आपके दफ़्तर का लिंक
आपने जो काम किया है उसका ब्यौरा देने वाला लिंक दें.
लिंक, एक ऐसे दस्तावेज़ पर ले जाएगा जिसमें पूरे किए गए काम का कम शब्दों में ब्यौरा, ओपन सोर्स प्रोजेक्ट को इसके डेटा स्टोर करने की जगह में मर्ज किया गया दस्तावेज़, प्रोजेक्ट की मौजूदा स्थिति की खास जानकारी, और चुनौतियों और सीखों की सूची शामिल होनी चाहिए.
यह लिंक, वेबसाइट पर पब्लिश किए गए Docs के नतीजों के सीज़न में दिखेगा. पब्लिश किए गए नतीजों में, प्रोग्राम के दौरान आपके पूरे किए गए काम को दिखाया जाता है. पब्लिश किए गए नतीजे, आपके रेज़्यूमे में जवाब लिखने का एक बेहतरीन तरीका है.
आपको अपने प्रोजेक्ट की रिपोर्ट सबमिट करने से पहले, अपने मेंटॉर के साथ लिंक शेयर करना चाहिए और समीक्षा करने के लिए कहना चाहिए.
प्रोजेक्ट रिपोर्ट के लिए ज़रूरी शर्तें
इन ज़रूरी शर्तों को ध्यान में रखें:
- लिंक किए गए कॉन्टेंट से, Docs के सीज़न में पूरे किए गए काम को पहचानना आसान होना चाहिए. जैसे, आपके किए गए बदलाव या आपके लिखे गए नए दस्तावेज़.
- काम किसी स्थिर जगह पर होना चाहिए. सबमिट करने के बाद, यूआरएल को नहीं बदला जा सकता.
कोई दूसरा व्यक्ति आपके कॉन्टेंट को इस लिंक के टारगेट पर इस्तेमाल कर पाए या उस पर मौजूद कॉन्टेंट का इस्तेमाल कर पाए.
- अगर आपका काम 100% है, तो दूसरे लोग इसका इस्तेमाल कर पाएंगे.
- अगर आपका काम पूरा नहीं हुआ है, तो आपको साफ़ तौर पर बताना होगा कि अभी क्या करना बाकी है.
अपने काम का ब्यौरा देने के अच्छे उदाहरण
आपको ये सभी या कुछ भी करने की ज़रूरत नहीं है. हालांकि, यहां कुछ ऐसे तरीके दिए गए हैं जिनकी मदद से ये शर्तें पूरी की जा सकती हैं:
एक ब्लॉग पोस्ट, वेब पेज या सार्वजनिक GitHub में योगदान दें, जो आपके काम की जानकारी देता हो. साथ ही, आपके किए गए वादों और डेटा स्टोर करने की जगहों के लिंक भी बनाता हो. अगर प्रोजेक्ट पर अब भी काम बाकी है, तो उस काम की पूरी जानकारी दें. साथ ही, हाइलाइट या चुनौती वाले पीस भी शेयर किए जा सकते हैं.
यह सबसे अच्छा विकल्प है, क्योंकि इससे आपको बहुत सारी जानकारी आसानी से शामिल करने की सुविधा मिलती है. यह अच्छा है, क्योंकि इसमें आपका काम साफ़ तौर पर दिखता है. इससे दूसरे लोग भी आपके योगदान को आसानी से समझ और इस्तेमाल कर पाते हैं.
अगर GitHub का इस्तेमाल किया जा रहा है और आपका सारा काम एक ही पुल के अनुरोध में आता है, तो उस लिंक का इस्तेमाल किया जा सकता है.
- पक्का करें कि पुल के अनुरोध में पूरी जानकारी दी गई हो.
- पक्का करें कि ब्यौरे में साफ़ तौर पर बताया गया हो कि यह काम Docs के सीज़न के लिए है.
- अगर Docs का सीज़न खत्म होने के बाद, पुल के अनुरोध पर ज़्यादा काम करने की ज़रूरत होती है, तो पक्का करें कि Docs के आखिरी सीज़न में इस बात को नोट किया गया हो.
- प्रोजेक्ट रिपोर्ट उपलब्ध कराने के इस तरीके का फ़ायदा यह है कि एक ही जगह पर बदलाव लॉग, कमियों की सूची, और समीक्षा की टिप्पणियों की सुविधा मिलती है.
अगर किसी GitHub डेटा स्टोर करने की जगह का इस्तेमाल सिर्फ़ Docs के सीज़न के लिए किया जा सकता है, तो एक ऐसी README फ़ाइल जोड़ें जिसमें आपके काम की जानकारी हो.
Google Drive में सार्वजनिक फ़ोल्डर बनाएं और उसमें अपने बनाए गए सभी पैच शामिल करें.
Google Sheets की मदद से सार्वजनिक स्प्रेडशीट बनाएं और अपने सभी कामों की सूची बनाएं.
सार्वजनिक समस्या को ट्रैक करने वाले टूल में किसी एक समस्या का लिंक दें, जिसमें आपके काम और दूसरी ज़रूरी चीज़ों की साफ़-साफ़ जानकारी दी गई हो. समस्या से आपके सभी काम ट्रैक होने चाहिए. पक्का करें कि समस्या में सभी कमियों की सूची हो या किसी अन्य तरीके से कमियों को ढूंढना आसान हो.
अपने बदलावों के यूनिफ़ाइड या कॉन्टेक्स्ट डिफ़रेंस से लिंक करें. एक ऐसा हेडर शामिल करना न भूलें जिसमें आपके तकनीकी लेखन प्रोजेक्ट का नाम और आप कौन हैं, ताकि यह अन्य लोगों के काम आ सके.
आपके काम का ब्यौरा देने के गलत उदाहरण
ये चीज़ें न करें:
- किसी टारबॉल या ज़िप फ़ाइल से लिंक करें, जिसमें पूरे प्रोजेक्ट का सोर्स कोड या आपकी वर्किंग डायरेक्ट्री हो.
- प्रोजेक्ट के प्राइमरी सोर्स रिपॉज़िटरी (डेटा स्टोर करने की जगह) में सबसे ऊपर का लिंक. उदाहरण के लिए, अगर cpython पर काम किया जा रहा है, तो यह लिंक काम का नहीं होगा: https://github.com/python/cpython.
- प्रोजेक्ट के सोर्स रिपॉज़िटरी के अपने क्लोन से लिंक करें. इससे यह देखना कठिन हो जाता है कि आपके बदलाव क्या हैं, क्योंकि आपका काम दूसरे लोगों के काम के साथ मिला हुआ है.
- सीज़न ऑफ़ Docs की वेबसाइट पर, अपने प्रोजेक्ट के ब्यौरे का लिंक दें.
मेंटॉर के लिए
कृपया सही प्रोजेक्ट रिपोर्ट बनाने में अपने तकनीकी लेखक की मदद करें. तकनीकी लेखक के काम का आकलन करने से पहले, ऐसा करना ज़रूरी है.
नीचे दी गई बातों पर ध्यान दें:
- सबमिट किया गया प्रमोशनल कॉन्टेंट, ऊपर बताई गई ज़रूरी शर्तों के मुताबिक होना चाहिए.
- सबमिशन में किए गए काम का ब्यौरा, पूरा किया गया ज़रूरी शर्तें, और किसी खास फ़ैसले की वजहें शामिल होनी चाहिए.
सीज़न ऑफ़ Docs का आइडिया यह नहीं है कि तकनीकी लेखक बहुत सारे दस्तावेज़ चर्न आउट करते हैं. यह ज़रूरी है कि ओपन सोर्स प्रोजेक्ट होस्ट करने के लिए यह काम मददगार हो.