मौजूदा चरण:
नतीजे का एलान
टाइमलाइन किया गया.
ओपन सोर्स संगठनों को तकनीकी लेखकों के साथ असरदार तरीके से काम करने में मदद करने के लिए, यहां कुछ दिशा-निर्देश दिए गए हैं.
टेक्निकल राइटर को ओपन सोर्स की दुनिया और अपनी कम्यूनिटी से रूबरू कराएं
- तकनीकी लेखक को अपनी कम्यूनिटी का ‘गाइड के साथ टूर’ दें. वे कहां सवाल पूछ सकते हैं? उन्हें किन नियमित मीटिंग में शामिल होना चाहिए या उन्हें ईमेल पाने वाले लोगों की किन सूचियों में शामिल होना चाहिए? उन्हें किन खातों की ज़रूरत होगी (GitHub, Discord, Slack)? पक्का करें कि वे आपके प्रोजेक्ट की आचार संहिता को समझते हों और किसी भी समस्या की शिकायत करने का तरीका जानते हों. पक्का करें कि आपका तकनीकी लेखक आपके प्रोजेक्ट का लाइसेंस समझता हो और वह सीएलए, डीसीओ पर हस्ताक्षर करने या दूसरे कानूनी समझौतों से जुड़ी, नौकरी देने वाली दूसरी कंपनियों की ज़रूरी शर्तों का पालन करता हो.
- अगर हो सके, तो उन्हें ओवरलैप होने वाले टाइम ज़ोन में मौजूद कुछ ऐसे लोगों से मिलें जो कम्यूनिटी या प्रोजेक्ट से जुड़े सवालों के जवाब दे सकें.
- अगर हो सके, तो उन्हें प्रोजेक्ट का एक मुफ़्त उपहार भेजें!
आपके प्रोजेक्ट में योगदान देने वाले टूल और प्रोसेस का इस्तेमाल करने में तकनीकी लेखक की मदद करें
- अगर आपके प्रोसेस के पूरे दस्तावेज़ नहीं हैं, तो एक समय तय करें, ताकि तकनीकी लेखक के पहले योगदान, समस्या या पुल के अनुरोध के बारे में बताया जा सके. उन्हें किन टेंप्लेट या टैग का इस्तेमाल करना चाहिए? आपके योगदान की समीक्षा किन लोगों को करनी चाहिए और समीक्षाएं कब और कैसे करनी चाहिए? अगर उनके काम में कोड सैंपल शामिल हैं, तो उनकी जांच कैसे की जा सकती है? आपके ग्राहकों को आपकी सीआई/सीडी प्रोसेस या रिलीज़ के बारे में क्या जानना ज़रूरी है?
अपने प्रोजेक्ट और उसे इस्तेमाल करने वाले लोगों को समझने में तकनीकी लेखक की मदद करें
- अपने प्रोजेक्ट के बारे में पूरी जानकारी दें, ताकि तकनीकी लेखक को प्रॉडक्ट के बारे में कॉन्सेप्ट समझ में आए. इससे टेक्निकल लेखक को अपने काम में ज़्यादा आत्मविश्वास महसूस होता है. साथ ही, वे अपने लेखन में ज़्यादा प्रामाणिकता से काम करते हैं.
- प्रोजेक्ट का इस्तेमाल करने वाले लोगों की ज़रूरतों के बारे में बताएं. जितना हो सके, उतना सटीक रहें—जैसे कि ‘डेवलपर’, ‘डेवलपर, जो वेब साइट बनाते हैं’ और ‘डेवलपर, जो इंडस्ट्रियल रोबोट की प्रोग्रामिंग करते हैं’.
- तकनीकी लेखक को विषय की जानकारी देने वाले ज़रूरी विशेषज्ञों से संपर्क करें. इसका मतलब है कि डेवलपर या प्रोजेक्ट में योगदान देने वाले अन्य लोग, जो आपके प्रोजेक्ट के उन पहलुओं के लिए ज़िम्मेदार होते हैं जिन्हें दस्तावेज़ में शामिल किया जाएगा.
- पक्का करें कि तकनीकी लेखक को विषय-वस्तु के विशेषज्ञों और कम्यूनिटी के अन्य सदस्यों से समय और संसाधन मिले.
सवाल पूछें!
- ऐसा हो सकता है कि आपके समुदाय या प्रोजेक्ट ने पहले तकनीकी लेखकों या दस्तावेज़ में योगदान देने वालों के साथ काम न किया हो. अपने ज्ञान को शेयर करते हुए सीखने के इस अवसर का फ़ायदा उठाएं! अपनी प्रोसेस और टूल के बारे में सुझाव मांगें, क्योंकि आपके तकनीकी लेखक को सुधार के लिए कुछ सुझाव मिल सकते हैं.