तकनीकी लेखक के साथ काम करना

मौजूदा चरण:
'Docs' प्रोग्राम का 2019 सीज़न 6 मार्च, 2020 को खत्म हुआ. टाइमलाइन देखें.

यहां ओपन सोर्स संगठनों के लिए कुछ दिशा-निर्देश दिए गए हैं कि किसी ऐसे तकनीकी लेखक के साथ काम कैसे करें जिसे आप Docs के सीज़न में मेंटॉर कर रहे हैं:

  • ओपन सोर्स की दुनिया और अपने समुदाय के सामने तकनीकी लेखक के बारे में बताएं.
  • आपके प्रोजेक्ट में योगदान देने में शामिल टूल और प्रोसेस का इस्तेमाल करने में तकनीकी लेखक की मदद करें.
  • अपने प्रॉडक्ट के बारे में पूरी जानकारी दें, ताकि तकनीकी लेखक को प्रॉडक्ट के बारे में समझने में आसानी हो. इससे टेक्निकल राइटर का आत्मविश्वास बढ़ाने में मदद मिलती है. साथ ही, वह प्रोजेक्ट के लिए अपने लेखन में ज़्यादा प्रामाणिकता से काम कर पाता है.
  • अपनी ऑडियंस की ज़रूरतों के बारे में बताएं. जैसे, आपके प्रॉडक्ट का इस्तेमाल करने वाले डेवलपर और/या प्रॉडक्ट का इस्तेमाल करने वाले दूसरे ग्रुप की ज़रूरतें.
  • ज़रूरी दस्तावेज़ डिज़ाइन करने में तकनीकी लेखक की मदद करने के लिए, उनके साथ इस्तेमाल के ज़रूरी उदाहरण लें.
  • दस्तावेज़ लिखने से पहले, जब तकनीकी लेखक को इसे समझने की ज़रूरत हो, तब कोड का इस्तेमाल करें.
  • तकनीकी लेखक को विषय की जानकारी देने वाले ज़रूरी विशेषज्ञों से संपर्क करें. इसका मतलब है कि डेवलपर या प्रोजेक्ट में योगदान देने वाले अन्य लोग, जो आपके प्रॉडक्ट के उन पहलुओं के लिए ज़िम्मेदार हैं जिन्हें दस्तावेज़ में शामिल किया जाएगा.
  • पक्का करें कि तकनीकी लेखक को विषय-वस्तु के विशेषज्ञों और समुदाय के अन्य सदस्यों से समय और संसाधन मिले.
  • जहां ज़रूरी हो वहां दस्तावेज़ में सही कोड सैंपल जोड़ने के लिए, तकनीकी लेखक की मदद लें.

ध्यान रखने वाली बातें

यह ज़रूरी नहीं है कि Docs के सीज़न में ओपन सोर्स मेंटॉर, तकनीकी लेखक ही हों. मेंटॉर के पास दस्तावेज़ बनाने की जानकारी होना ज़रूरी नहीं है. टेक्निकल राइटर, इन स्किल को प्रोजेक्ट में शामिल करते हैं. साथ ही, इन्हें मेंटॉरशिप के काम में भी इस्तेमाल करते हैं.

इसके बजाय, मेंटॉर अपनी जानकारी को ओपन सोर्स समुदाय, प्रॉडक्ट, और उन प्रक्रियाओं और टूल के बारे में जानकारी देते हैं जिनका इस्तेमाल ओपन सोर्स प्रोजेक्ट करता है.

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