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