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