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