Technical Documentation क्या है?

तकनीकी दस्तावेज क्या है? [What is Technical Documentation?] [In Hindi]

सॉफ्टवेयर उद्योग में Technical Documentation - विभिन्न प्रकार के लेखन के विपरीत, तकनीकी दस्तावेज बनाने का मंत्र पुन: प्रयोज्य है। यद्यपि सामग्री के मूल संदर्भ को संशोधित किया जा सकता है, लेकिन पहले उपलब्ध सामग्री का पुन: उपयोग या रीमॉडेलिंग करके सर्वोत्तम तकनीकी दस्तावेज़ बनाया जा सकता है। तकनीकी दस्तावेज प्रकृति और आपके द्वारा लिखे जा रहे डोमेन के साथ भिन्न होते हैं। लेकिन हर कंपनी की अपनी स्टाइल गाइड और फॉर्मेट होती है जिसका आपको पालन करना होता है। हालांकि यह एक कठिन है, अंतिम परिणाम इसके लायक है। 

एक तकनीकी लेखक के लिए महत्वपूर्ण कौशल [Important Skills for a Technical Writer] [In Hindi]

तकनीकी लेखक के रूप में सफल होने के लिए कुछ महत्वपूर्ण लक्षण इस प्रकार हैं;

1. टेक्नोलॉजिकल नॉलेज से तात्पर्य प्रौद्योगिकी की संभावित समझ से है। लिखना शुरू करने से पहले, अपना शोध करें। चिंता न करें यदि आप सब कुछ नहीं समझते हैं, लेकिन अपने दर्शकों के लिए प्रभावी और सार्थक जानकारी देने के लिए पर्याप्त रूप से बनाए रखना बहुत महत्वपूर्ण है।
2. स्पष्ट रूप से लिखने की क्षमता किसी भी तकनीकी लेखक का एक पूर्ण कौशल है। हमेशा समझने की कोशिश करें और स्पष्ट और संक्षिप्त रूप से जानकारी को पास करें। अगर आप लिखते समय गलती करते हैं तो चिंता न करें। जैसे उपकरण का उपयोग करें; व्याकरण या SME (विषय-विषय विशेषज्ञ) से सहायता लें।
3. समस्या-समाधान या समस्या निवारण कौशल बुनियादी अभी तक मौलिक है। कई सॉफ़्टवेयर दस्तावेज़ों को समस्या-समाधान और समस्या निवारण कौशल की आवश्यकता होती है। इसलिए, घबराएं नहीं, इसके बजाय, शांत रहें और समाधान खोजने की कोशिश करें।
4. किसी दस्तावेज़ को प्रारूपित करते समय क्रॉस-फ़ंक्शनल टीम के साथ मिलना महत्वपूर्ण है। आपको समय सीमा, उत्पाद रिलीज़ और उत्पादों से संबंधित तथ्यों के बारे में अपडेट रहना चाहिए।
5. जब आप किसी उत्पाद पर काम कर रहे हों तो एसएमई (सब्जेक्ट मैटर एक्सपर्ट्स) के साथ बातचीत करने की क्षमता महत्वपूर्ण होती है। एसएमई के साथ संवाद करने से आपके शोध दस्तावेज में एक समग्र दृष्टिकोण आएगा। एसएमई आपके इंजीनियरिंग मैनेजर, प्रोडक्ट ओनर या हेड आर्किटेक्ट-कोई हो सकता है जो किसी विषय को बेहतर तरीके से जानता हो।
6. यदि आप एक तकनीकी लेखक हैं, तो उत्पाद रिलीज के दौरान अंतिम समय में बदलाव या अक्षम लेखन के साथ काम करने के लिए ओवरटाइम काम करने के मामले में लचीलापन अपरिहार्य है।
7. यदि आप तकनीकी लेखक के रूप में काम करते हैं, तो जटिल विचारों को चित्रमय रूप से प्रस्तुत करने की क्षमता एक आवश्यकता नहीं है, बल्कि मूल्य भी बढ़ाती है।

यदि आप एक अच्छे लेखक नहीं हैं, तो चिंता न करें। लेखन कभी भी संपूर्ण नहीं हो सकता है, हमेशा सुधार की गुंजाइश है। हालांकि, किसी दस्तावेज़ को पुनरावृत्त करना आवश्यक है।

प्रलेखन के प्रकार [Types of documentation] [In Hindi] 

प्रलेखन प्रक्रिया का उपयोग कई कारणों से किया जा सकता है।

दस्तावेज़ीकरण दूसरों (और कभी-कभी स्वयं) को परिणामों की पुष्टि और सत्यापन करने में मदद करता है।

प्रलेखन कार्टोग्राफी की तरह है। अपने लिए नए क्षेत्र की खोज करने के बाद (अपने इनोवेटिव ऐप्स और उत्पादों का निर्माण) हमें उपयोगकर्ताओं को अपना रास्ता खोजने के लिए विस्तृत दिशा-निर्देश प्रदान करना चाहिए।

कुछ विभिन्न प्रकार के प्रलेखन में शामिल हैं:

1. एंड-यूज़र प्रलेखन (End-User Documentation): रोजमर्रा के ग्राहकों के लिए उपयोगकर्ता मैनुअल यह समझने के लिए कि उत्पाद या ऐप को कैसे इकट्ठा किया जाता है, उपयोग किया जाता है,
2. आवश्यकताएँ प्रलेखन (Requirements documentation): एक Product development team के उद्देश्य, लक्ष्यों, और किसी दिए गए उत्पाद, परियोजना या सुविधा का मूल्य
3. विपणन प्रलेखन (Marketing Documentation): आंतरिक और बाहरी दोनों के लिए Marketing team के लिए विवरण, कंपनी की ओर से आम जनता के साथ संवाद करने के लिए मानक और दिशानिर्देश
4. तकनीकी दस्तावेज (Technical Documentation): डेवलपर्स या निर्माताओं द्वारा वर्णित उत्पाद या सेवा के हर घटक का उपयोग करने के तरीके के बारे में इंजीनियरों के लिए विस्तृत जानकारी

दस्तावेज़ीकरण प्रकारों की यह सूची संपूर्ण नहीं है और यद्यपि उपरोक्त सभी प्रकार के दस्तावेज़ों में उनके आदर्श उपयोग के मामले हैं, कोई भी एक-दस्तावेज़-फ़िट-फिट नहीं है। वास्तव में, अधिकांश व्यवसायों में एक से अधिक प्रकार के Documenation होंगे।

क्यों दस्तावेज़ में प्रगति बेतरतीब ढंग से खारिज या समाप्त कर रहे हैं? [Why are documents in progress randomly dismissed or terminated?] [In Hindi]

जबकि एक तकनीकी लेखक किसी उत्पाद के दस्तावेजीकरण के लिए पर्याप्त मात्रा में निवेश करता है, कभी-कभी प्रगति के दस्तावेज या तो बेतरतीब ढंग से खारिज या समाप्त कर दिए जाते हैं। नीचे तकनीकी लेखकों द्वारा उद्धृत पांच कारण दिए गए हैं;

1. प्रभावों और आवश्यकताओं के विश्लेषण के बिना शुरू किए गए दस्तावेज़।
2. दस्तावेज़ों को समय की अवधि में परिवर्तन की आवश्यकता होती है क्योंकि यह व्यापार रणनीति और उद्देश्य के साथ संरेखित नहीं करता है।
3. उन परियोजनाओं से संबंधित दस्तावेज़ जो अब सॉफ़्टवेयर कंपनियों के लिए प्राथमिकता नहीं हैं।
4. दस्तावेज़ जो स्पष्टता, पूर्णता और संक्षिप्तता के संदर्भ में चिह्न या मानक तक नहीं हैं। इसके अलावा, गरीब प्रलेखन के रूप में जाना जाता है।
5. दस्तावेज़ (उदाहरण के लिए, मैनुअल) जो एक समय सीमा के भीतर वितरित नहीं किए जा सकते हैं।