सॉफ्टवेयर प्रलेखन लिखना एक प्रोग्रामर के काम में एक अभिन्न भूमिका निभाता है। जैसा कि वे कहते हैं, यदि यह दस्तावेज नहीं है, तो यह अस्तित्व में नहीं है, और ज्यादातर मामलों में, अपने कोड को उचित तरीके से दस्तावेज करना उतना ही महत्वपूर्ण है जितना वास्तव में इसे लिखना। "इससे कोई फर्क नहीं पड़ता कि आपकी लाइब्रेरी कितनी शानदार है और इसका डिज़ाइन कितना बुद्धिमान है, अगर आप अकेले इसे समझते हैं, तो यह कोई अच्छा काम नहीं करता है। दस्तावेज़ीकरण का मतलब केवल ऑटोजेनरेटेड एपीआई संदर्भ नहीं है, बल्कि एनोटेट किए गए उदाहरण और गहन ट्यूटोरियल भी हैं। आपको यह सुनिश्चित करने के लिए तीनों की आवश्यकता है कि आपके पुस्तकालय को आसानी से अपनाया जा सके, ” निकोलस ज़कास, एक प्रसिद्ध फ्रंट एंड इंजीनियर और पुस्तक लेखक ने कहा । इसीलिए आज हमने सॉफ्टवेयर प्रलेखन और तकनीकी लेखन के लिए कुछ सबसे अच्छे और सबसे अधिक उपयोग किए जाने वाले उपकरणों पर एक नज़र डालने का फैसला किया।
संलेखन उपकरण में मदद करें
संलेखन उपकरण सॉफ्टवेयर प्रलेखन और तकनीकी लेखन में एक प्रमुख भूमिका निभाते हैं, क्योंकि वे सॉफ्टवेयर प्रलेखन को डिजाइन करना, लिखना, प्रकाशित करना और बनाए रखना बहुत आसान बनाते हैं। वे आपको एंड-यूजर्स और अन्य प्रोग्रामर/कर्मचारियों दोनों के लिए सभी प्रकार की सहायता सामग्री बनाते समय आवश्यक समय और प्रयास को कम करने की अनुमति देते हैं।
मैडकैप फ्लेयर सबसे लोकप्रिय हेल्प ऑथरिंग टूल्स में से एक है, इसके फीचर्स के समृद्ध चयन के लिए धन्यवाद जो आपको हेल्प डॉक्यूमेंटेशन लिखने के अलावा बहुत कुछ करने की अनुमति देता है। MadCap Flare को उन्नत विषय-आधारित संलेखन, एकल-स्रोत प्रकाशन और सामग्री प्रबंधन के लिए डिज़ाइन किया गया था। यह आपको सहायता और ग्राहक सहायता वेबसाइट, अक्सर पूछे जाने वाले प्रश्न, ज्ञान के आधार, ऑनलाइन शिक्षण केंद्र, गाइड, नीति और प्रक्रिया नियमावली, और बहुत कुछ बनाने की अनुमति देता है। मैडकैप फ्लेयर की विशेषताएं एक ही सामग्री को कई चैनलों में पुन: उपयोग करना आसान बनाती हैं और इसे कई प्लेटफार्मों पर जल्दी से प्रकाशित करती हैं।
Document360 एक अन्य व्यापक रूप से उपयोग किया जाने वाला वेब प्लेटफ़ॉर्म है जो आपको सभी प्रकार के ज्ञान के आधार और सहायता सामग्री बनाने, प्रकाशित करने और अद्यतन करने की अनुमति देता है। इसमें मल्टी-प्रोफाइल कार्यक्षमता भी है, जिसमें एक साधारण मार्कडाउन टेक्स्ट एडिटर, नॉलेज बेस स्ट्रक्चर बनाने के लिए कैटेगरी मैनेजर, लैंडिंग पेज कस्टमाइजेशन फीचर्स, वर्जनिंग रोलबैक, बैकअप और रिस्टोर, फ्लेक्सिबल रोल्स और परमिशन एडजस्टमेंट वगैरह शामिल हैं।
Adobe RoboHelp एक और शक्तिशाली वैकल्पिक मदद संलेखन उपकरण है, जो MadCap Flare और Document360 की तुलना में सुविधाओं का थोड़ा अलग चयन प्रदान करता है। विशेष रूप से, Adobe RoboHelp आसान मल्टीफॉर्मेट प्रकाशन प्रदान करता है, जिससे आप सामग्री को लोकप्रिय आउटपुट स्वरूपों की एक विस्तृत श्रृंखला में प्रकाशित कर सकते हैं, जिसमें फ्रेमलेस रिस्पॉन्सिव HTML5, PDF, Microsoft हेल्प (CHM), और यहां तक कि कम सामान्य प्रारूप जैसे EPUB 3, KF8, और भी शामिल हैं। मोबी।
हेल्प+मैन्युअल का प्रमुख लाभ इसका सरल इंटरफ़ेस है जो WYSIWYG XML संपादक की पूर्ण कार्यक्षमता, मल्टी-चैनल प्रकाशन, मल्टीमीडिया और जटिल मॉड्यूलर परियोजनाओं के लिए पूर्ण समर्थन, वेबहेल्प टूल के सहज एकीकरण के साथ इसे बहुत सुलभ और उपयोग में आसान बनाता है। सक्रिय वेबसाइटों में प्रलेखन, और इसी तरह।
ClickHelp नॉलेज बेस, एफएक्यू, ट्यूटोरियल और अन्य सहायता प्रारूपों के रूप में सॉफ्टवेयर प्रलेखन के लिए काफी शक्तिशाली वेब प्लेटफॉर्म भी प्रदान करता है। Word, HTML, RTF, CHM, ODT, CHM, HTML5 वेब हेल्प, PDF, DOCX, आदि जैसे कई स्वरूपों का समर्थन करता है। ClickHelp की कुछ हस्ताक्षर विशेषताओं में पूर्ण-पाठ खोज का पेटेंट है जो विशिष्ट विषयों या लेखों को दोनों के लिए खोजना आसान बनाता है। लेखक और उपयोगकर्ता, साथ ही प्रलेखन डिजाइन के लिए कई पूर्व-निर्मित टेम्पलेट्स का विकल्प।
स्क्रीन कैप्चर टूल
अधिकांश सॉफ़्टवेयर दस्तावेज़ीकरण और सहायता सामग्री में स्क्रीनशॉट शामिल करने की आवश्यकता होती है, इसलिए वहां उपलब्ध सर्वश्रेष्ठ स्क्रीन कैप्चर टूल का संक्षिप्त अवलोकन करना समझदारी होगी।
यदि आप विंडोज को अपने ओएस के रूप में उपयोग कर रहे हैं, तो यह एक स्निपिंग टूल के साथ आता है, जो आपको पूरी स्क्रीन, अलग विंडो या स्क्रीन के एक हिस्से के स्क्रीनशॉट बनाने की अनुमति देता है, और स्क्रीनशॉट के कुछ विशिष्ट भागों को हाइलाइट करने के लिए पेन टूल का उपयोग करता है।
फायरशॉट एक लोकप्रिय ब्राउज़र प्लगइन है जो क्रोम, फ़ायरफ़ॉक्स, इंटरनेट एक्सप्लोरर और ओपेरा जैसे सभी आधुनिक ब्राउज़रों का समर्थन करता है। आपको पूरे वेब पेज या इसके कुछ विशिष्ट हिस्से को कैप्चर करने की अनुमति देता है।
SnagIt एक अधिक जटिल स्क्रीन कैप्चर टूल है। यह आपको किसी भी पृष्ठ के स्क्रॉलिंग क्षेत्रों को पकड़ने के साथ-साथ वीडियो रिकॉर्डिंग का समर्थन करने की अनुमति देता है। आप इस चित्र का उपयोग GIFs बनाने और स्क्रीन पर क्रियाओं के विशिष्ट सेट रिकॉर्ड करने के लिए भी कर सकते हैं।
वर्तनी और व्याकरण चेकर्स
यह सुनिश्चित करना भी महत्वपूर्ण है कि आपका दस्तावेज़ बिना किसी व्याकरण और विराम चिह्न की गलतियों के सही ढंग से लिखा गया है। यहां कुछ उपकरण दिए गए हैं जो आपको अपने टेक्स्ट में गलतियां ढूंढने और उन्हें ठीक करने में मदद करेंगे।
सबसे लोकप्रिय मुफ्त ऑनलाइन वर्तनी और व्याकरण चेकर्स में से एक। स्क्रिबेंस 250 से अधिक विभिन्न प्रकार की गलतियों की पहचान और सुधार कर सकते हैं, जिनमें संज्ञा, सर्वनाम, पूर्वसर्ग, क्रिया, समनाम, विराम चिह्न, टाइपोग्राफी आदि शामिल हैं।
आपके ग्रंथों में टाइपो और गलतियों को दिखाने के अतिरिक्त, Grammar.com आपको आपके लेखन में सुधार के लिए प्रासंगिक सुझावों के साथ-साथ व्याकरण के नियम और ईबुक भी प्रदान करता है (सब कुछ मुफ्त में)।
"इससे कोई फर्क नहीं पड़ता कि आपकी लाइब्रेरी कितनी शानदार है और इसका डिज़ाइन कितना बुद्धिमान है, अगर आप अकेले इसे समझते हैं, तो यह कोई अच्छा काम नहीं करता है। दस्तावेज़ीकरण का मतलब केवल ऑटोजेनरेटेड एपीआई संदर्भ नहीं है, बल्कि एनोटेट किए गए उदाहरण और गहन ट्यूटोरियल भी हैं। आपको यह सुनिश्चित करने के लिए तीनों की आवश्यकता है कि आपके पुस्तकालय को आसानी से अपनाया जा सके, ” निकोलस ज़कास, एक प्रसिद्ध फ्रंट एंड इंजीनियर और पुस्तक लेखक ने कहा । इसीलिए आज हमने सॉफ्टवेयर प्रलेखन और तकनीकी लेखन के लिए कुछ सबसे अच्छे और सबसे अधिक उपयोग किए जाने वाले उपकरणों पर एक नज़र डालने का फैसला किया।
GO TO FULL VERSION