अच्छे सॉफ़्टवेयर दस्तावेज़ीकरण, चाहे वह प्रोग्रामर और परीक्षकों के लिए विनिर्देश दस्तावेज़ हों, आंतरिक उपयोगकर्ताओं के लिए तकनीकी दस्तावेज़ हों, या अंतिम उपयोगकर्ताओं के लिए मैनुअल और सहायता फ़ाइलें हों, उपयोगकर्ताओं को सॉफ़्टवेयर की विशेषताओं और कार्यों को समझने में मदद करेंगे। अच्छा दस्तावेज़ीकरण वह दस्तावेज़ होता है जो विशिष्ट, स्पष्ट और प्रासंगिक होता है, जिसमें उपयोगकर्ता को आवश्यक सभी जानकारी होती है। यह लेख तकनीकी उपयोगकर्ताओं और अंतिम उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज़ लिखने के लिए आपका मार्गदर्शन करेगा।
कदम
विधि 1: 2 में से: तकनीकी उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज़ीकरण लिखना
चरण 1. जानें कि कौन सी जानकारी शामिल करनी है।
विनिर्देश दस्तावेज़ का उपयोग इंटरफ़ेस डिजाइनरों, कोड लिखने वाले प्रोग्रामर और सॉफ़्टवेयर प्रदर्शन को सत्यापित करने वाले परीक्षकों के लिए एक संदर्भ मैनुअल के रूप में किया जाता है। जो जानकारी शामिल करने की आवश्यकता है वह बनाए जा रहे कार्यक्रम पर निर्भर करेगा, लेकिन इसमें निम्नलिखित शामिल हो सकते हैं:
- एप्लिकेशन में महत्वपूर्ण फाइलें, जैसे कि विकास टीम द्वारा बनाई गई फाइलें, प्रोग्राम के चलने के दौरान एक्सेस किए गए डेटाबेस और तीसरे पक्ष के एप्लिकेशन।
- फ़ंक्शन और सबरूटीन, फ़ंक्शन/सबरूटीन, इनपुट और आउटपुट मानों के उपयोग की व्याख्या सहित।
- प्रोग्राम चर और स्थिरांक, और उनका उपयोग कैसे किया जाता है।
- समग्र कार्यक्रम संरचना। ड्राइव-आधारित प्रोग्राम के लिए, आपको प्रत्येक मॉड्यूल और लाइब्रेरी का वर्णन करने की आवश्यकता हो सकती है। या, यदि आप किसी वेब-आधारित प्रोग्राम के लिए एक मैनुअल लिख रहे हैं, तो आपको यह समझाने की आवश्यकता हो सकती है कि प्रत्येक पृष्ठ किन फ़ाइलों का उपयोग करता है।
चरण 2. तय करें कि किस स्तर का दस्तावेज मौजूद होना चाहिए और प्रोग्राम कोड से अलग किया जा सकता है।
प्रोग्राम कोड में जितने अधिक तकनीकी दस्तावेज शामिल हैं, इसे अपडेट करना और बनाए रखना उतना ही आसान होगा, साथ ही प्रोग्राम के विभिन्न संस्करणों की व्याख्या करना भी आसान होगा। कम से कम, प्रोग्राम कोड में प्रलेखन में फ़ंक्शंस, सबरूटीन्स, चर और स्थिरांक का उपयोग शामिल होना चाहिए।
- यदि आपका स्रोत कोड लंबा है, तो आप एक सहायता फ़ाइल में दस्तावेज़ीकरण लिख सकते हैं, जिसे बाद में कुछ कीवर्ड के साथ अनुक्रमित या खोजा जा सकता है। यदि प्रोग्राम तर्क कई पृष्ठों में विभाजित है और इसमें वेब एप्लिकेशन जैसी समर्थन फ़ाइलें शामिल हैं, तो अलग दस्तावेज़ीकरण फ़ाइलें उपयोगी होती हैं।
- कुछ प्रोग्रामिंग भाषाओं (जैसे Java, Visual Basic. NET, या C#) के अपने कोड प्रलेखन मानक होते हैं। ऐसे मामलों में, मानक दस्तावेज़ीकरण का पालन करें जिसे स्रोत कोड में शामिल किया जाना चाहिए।
चरण 3. उपयुक्त दस्तावेज़ीकरण उपकरण का चयन करें।
कुछ मामलों में, प्रलेखन उपकरण उपयोग की जाने वाली प्रोग्रामिंग भाषा द्वारा निर्धारित किया जाता है। C++, C#, Visual Basic, Java, PHP, और अन्य भाषाओं के अपने स्वयं के प्रलेखन उपकरण हैं। हालाँकि, यदि नहीं, तो उपयोग किए गए उपकरण आवश्यक दस्तावेज़ीकरण पर निर्भर करेंगे।
- एक वर्ड प्रोसेसर जैसे माइक्रोसॉफ्ट वर्ड दस्तावेज़ टेक्स्ट फाइल बनाने के लिए उपयुक्त है, जब तक कि दस्तावेज़ीकरण संक्षिप्त और सरल हो। जटिल पाठ के साथ लंबे दस्तावेज़ बनाने के लिए, अधिकांश तकनीकी लेखक एक विशेष दस्तावेज़ीकरण उपकरण चुनते हैं, जैसे Adobe FrameMaker।
- स्रोत कोड के दस्तावेज़ीकरण के लिए सहायता फ़ाइलें एक समर्थन फ़ाइल जनरेटर प्रोग्राम के साथ बनाई जा सकती हैं, जैसे रोबोहेल्प, हेल्प एंड मैनुअल, डॉक-टू-हेल्प, मैडकैप फ्लेयर, या हेल्पलॉगिक्स।
विधि 2 में से 2: अंतिम उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज़ीकरण लिखना
चरण 1. मैनुअल के निर्माण के अंतर्निहित व्यावसायिक कारणों को जानें।
जबकि सॉफ़्टवेयर दस्तावेज़ीकरण का मुख्य कारण उपयोगकर्ताओं को यह समझने में मदद करना है कि एप्लिकेशन का उपयोग कैसे किया जाए, ऐसे कई अन्य कारण हैं जो दस्तावेज़ीकरण के निर्माण में अंतर्निहित हो सकते हैं, जैसे कि मार्केटिंग विभाग को एप्लिकेशन बेचने में मदद करना, कंपनी की छवि में सुधार करना और तकनीकी सहायता को कम करना। लागत। कुछ मामलों में, विनियमों या अन्य कानूनी आवश्यकताओं का पालन करने के लिए दस्तावेज़ीकरण की आवश्यकता होती है।
हालाँकि, दस्तावेज़ीकरण एक इंटरफ़ेस के लिए एक अच्छा विकल्प नहीं है। यदि किसी एप्लिकेशन को संचालित करने के लिए बहुत सारे दस्तावेज़ीकरण की आवश्यकता होती है, तो इसे अधिक सहज होने के लिए डिज़ाइन किया जाना चाहिए।
चरण 2. दस्तावेज़ीकरण के लक्षित दर्शकों को जानें।
आम तौर पर, सॉफ्टवेयर उपयोगकर्ताओं के पास उनके द्वारा उपयोग किए जाने वाले अनुप्रयोगों से परे सीमित कंप्यूटर ज्ञान होता है। उनकी दस्तावेज़ीकरण आवश्यकताओं को पूरा करने के कई तरीके हैं:
- सॉफ़्टवेयर उपयोगकर्ता के शीर्षक पर ध्यान दें। उदाहरण के लिए, सिस्टम प्रशासक आम तौर पर विभिन्न कंप्यूटर अनुप्रयोगों को समझता है, जबकि सचिव केवल उन अनुप्रयोगों को जानता है जिनका उपयोग वह डेटा दर्ज करने के लिए करता है।
- सॉफ्टवेयर यूजर्स पर ध्यान दें। यद्यपि उनकी स्थिति आम तौर पर किए गए कार्यों के अनुकूल होती है, इन पदों पर व्यवसाय के स्थान के आधार पर अलग-अलग कार्यभार हो सकते हैं। संभावित उपयोगकर्ताओं का साक्षात्कार करके, आप यह पता लगा सकते हैं कि उनकी नौकरी के शीर्षक का आपका आकलन सही है या नहीं।
- मौजूदा दस्तावेज़ीकरण पर ध्यान दें। सॉफ़्टवेयर कार्यक्षमता दस्तावेज़ीकरण और विनिर्देश दिखा सकते हैं कि उपयोगकर्ताओं को उनका उपयोग करने के लिए क्या जानने की आवश्यकता है। हालांकि, ध्यान रखें कि हो सकता है कि उपयोगकर्ताओं को कार्यक्रम के "अंतर्निहित" को जानने में दिलचस्पी न हो।
- जानें कि किसी कार्य को पूरा करने में क्या लगता है, और इसे पूरा करने से पहले आपको क्या लगता है।
चरण 3. दस्तावेज़ीकरण के लिए उपयुक्त प्रारूप निर्धारित करें।
सॉफ्टवेयर प्रलेखन को 1 या 2 प्रारूपों में व्यवस्थित किया जा सकता है, अर्थात् संदर्भ पुस्तकें और मैनुअल। कभी-कभी, दो प्रारूपों का संयोजन एक अच्छा समाधान होता है।
- संदर्भ स्वरूपों का उपयोग सभी सॉफ़्टवेयर सुविधाओं, जैसे बटन, टैब, फ़ील्ड और डायलॉग बॉक्स और वे कैसे काम करते हैं, का वर्णन करने के लिए किया जाता है। कुछ मदद फ़ाइलें इस प्रारूप में लिखी जाती हैं, विशेष रूप से वे जो संदर्भ संवेदनशील होती हैं। जब उपयोगकर्ता किसी निश्चित स्क्रीन में सहायता पर क्लिक करता है, तो उपयोगकर्ता को प्रासंगिक विषय प्राप्त होगा।
- सॉफ्टवेयर के साथ कुछ कैसे करना है, यह समझाने के लिए मैनुअल प्रारूप का उपयोग किया जाता है। मैनुअल आम तौर पर प्रिंट या पीडीएफ प्रारूप में होते हैं, हालांकि कुछ सहायता पृष्ठों में कुछ चीजें कैसे करें, इस पर निर्देश भी शामिल हैं। (आम तौर पर, मैनुअल प्रारूप संदर्भ संवेदनशील नहीं होते हैं, लेकिन संदर्भ संवेदनशील विषयों से जुड़े हो सकते हैं)। हैंडबुक आम तौर पर एक गाइड के रूप में होती है, जिसमें विवरण में किए जाने वाले कार्यों का सारांश और चरणों में प्रारूपित एक गाइड होता है।
चरण 4. दस्तावेज़ीकरण के प्रकार पर निर्णय लें।
उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज़ीकरण निम्न में से एक या अधिक प्रारूपों में पैक किया जा सकता है: मुद्रित मैनुअल, पीडीएफ फाइलें, सहायता फाइलें, या ऑनलाइन सहायता। प्रत्येक प्रकार के दस्तावेज़ीकरण आपको यह दिखाने के लिए डिज़ाइन किया गया है कि सॉफ़्टवेयर के कार्यों का उपयोग कैसे करें, चाहे वह गाइड हो या ट्यूटोरियल। ऑनलाइन दस्तावेज़ीकरण और सहायता पृष्ठों में प्रदर्शन वीडियो, टेक्स्ट और स्थिर चित्र भी शामिल हो सकते हैं।
ऑनलाइन सहायता और समर्थन फाइलों को खोजशब्दों का उपयोग करके अनुक्रमित और खोजने योग्य होना चाहिए ताकि उपयोगकर्ता अपनी जरूरत की जानकारी जल्दी से पा सकें। हालांकि एक हेल्प फ़ाइल जेनरेटर एप्लिकेशन स्वचालित रूप से एक इंडेक्स बना सकता है, फिर भी यह अनुशंसा की जाती है कि आप आमतौर पर खोजे गए कीवर्ड का उपयोग करके मैन्युअल रूप से एक इंडेक्स बनाएं।
चरण 5. उपयुक्त दस्तावेज़ीकरण उपकरण का चयन करें।
फ़ाइल की लंबाई और जटिलता के आधार पर मुद्रित मैनुअल या पीडीएफ को वर्ड प्रोसेसिंग प्रोग्राम जैसे वर्ड या फ्रेममेकर जैसे उन्नत टेक्स्ट एडिटर के साथ बनाया जा सकता है। हेल्प फाइल्स को हेल्प फाइल क्रिएशन प्रोग्राम के साथ लिखा जा सकता है, जैसे कि रोबोहेल्प, हेल्प एंड मैनुअल, डॉक-टू-हेल्प, फ्लेयर, हेल्पलॉगिक्स या हेल्पसर्वर।
टिप्स
- कार्यक्रम प्रलेखन का पाठ इस तरह से संरचित किया जाना चाहिए कि इसे पढ़ना आसान हो। छवि को यथासंभव उपयुक्त पाठ के करीब रखें। तार्किक रूप से अनुभागों और विषयों द्वारा प्रलेखन को तोड़ें। प्रत्येक अनुभाग या विषय को एक विशिष्ट समस्या का वर्णन करना चाहिए, दोनों कार्य और कार्यक्रम की विशेषताएं। संबंधित मुद्दों को लिंक या संदर्भ सूचियों के साथ समझाया जा सकता है।
- इस आलेख में वर्णित प्रत्येक दस्तावेज़ीकरण उपकरण को स्क्रीनशॉट निर्माता प्रोग्राम द्वारा पूरक किया जा सकता है, जैसे SnagIt यदि आपके दस्तावेज़ के लिए एकाधिक स्क्रीनशॉट की आवश्यकता है। किसी भी अन्य दस्तावेज़ की तरह, आपको यह समझाने में मदद करने के लिए स्क्रीनशॉट भी शामिल करना चाहिए कि ऐप कैसे काम करता है, न कि उपयोगकर्ता को "लुभाने" के लिए।
- शैली पर ध्यान देना बहुत महत्वपूर्ण है, खासकर यदि आप अंतिम उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज़ लिख रहे हैं। उपयोगकर्ताओं को "उपयोगकर्ता" के बजाय "आप" सर्वनाम के साथ संबोधित करें।
