सॉफ्टवेयर प्रलेखन कैसे लिखें

अच्छा प्रलेखन सॉफ्टवेयर, प्रोग्रामर और परीक्षकों, आंतरिक उपयोगकर्ताओं के लिए एक तकनीकी दस्तावेज़, या सॉफ्टवेयर मैनुअल और मदद दस्तावेजों अंत उपयोगकर्ताओं के लिए के लिए एक विनिर्देश दस्तावेज़ या तो, सॉफ्टवेयर के साथ काम कर अपनी सुविधाओं को समझने के लिए व्यक्ति में मदद करता है और कार्य करता है। अच्छा उपयोगकर्ता प्रलेखन विशिष्ट, संक्षिप्त और प्रासंगिक है, और सभी महत्वपूर्ण जानकारी को उस व्यक्ति को देता है जो सॉफ्टवेयर का उपयोग करता है। नीचे तकनीकी उपयोगकर्ता और अंतिम उपयोगकर्ताओं के लिए एक सॉफ्टवेयर दस्तावेज़ लिखने के निर्देश दिए गए हैं।

चरणों

Video: Clinical Research Resume Review: Study Coordinator With A Gap

Video: Learning iOS: Create your own app with Objective-C! by Tianyu Liu

Video: Week 1

2

तय करें कि दस्तावेज़ीकरण कितना कार्यक्रम कोड के अंदर होना चाहिए और कितना अलग होना चाहिए। जितना अधिक आप प्रोग्राम के स्रोत कोड के भीतर तकनीकी प्रलेखन विकसित करेंगे, उतना आसान होगा कि वह इसे अपडेट करे और कोड के समतुल्य रहें, और मूल ऐप्लिकेशन के विभिन्न संस्करणों को भी दस्तावेज करना आसान होगा। कम से कम, स्रोत कोड के भीतर दस्तावेज़, कार्य, उप-पंक्तियों, चर और स्थिरांक के उद्देश्य को समझा जाना चाहिए।

3

उपयुक्त दस्तावेज़ उपकरण चुनें। कुछ हद तक, यह उस भाषा के द्वारा निर्धारित किया जाता है जिसके साथ कोड लिखा जाता है, चाहे सी ++, सी #, विज़ुअल बेसिक, जावा या PHP, क्योंकि इन और अन्य भाषाओं के लिए विशिष्ट उपकरण हैं अन्य मामलों में, उपयोग किए जाने वाले उपकरण को आवश्यक दस्तावेजों के प्रकार के आधार पर निर्धारित किया जाता है।

2

समझें कि आप किसके लिए दस्तावेज़ीकरण लिख रहे हैं। अधिकांश मामलों में, सॉफ्टवेयर उपयोगकर्ताओं को उन कार्यों के बाहर कंप्यूटर के बारे में कुछ पता होता है जो उन्हें उपयोग करने वाले अनुप्रयोगों को करने की अनुमति देती हैं। दस्तावेज़ीकरण के साथ अपनी आवश्यकताओं को पूरा करने के तरीके निर्धारित करने के कई तरीके हैं।

3

दस्तावेज़ीकरण के लिए उचित प्रारूप (या उपयुक्त स्वरूप) निर्धारित करें। सॉफ्टवेयर प्रलेखन को दो प्रारूपों, संदर्भ पुस्तिका और उपयोगकर्ता गाइड में संरचित किया जा सकता है। कभी-कभी, सबसे अच्छा तरीका दोनों प्रारूपों के संयोजन का उपयोग करना है

4

यह तय करें कि दस्तावेज़ (प्रपत्र) किस प्रकार लेना चाहिए। अंतिम उपयोगकर्ताओं के लिए सॉफ़्टवेयर दस्तावेज कई रूपों में से एक हो सकता है: मुद्रित मैनुअल, पीडीएफ दस्तावेज़, सहायता फ़ाइलें, या ऑनलाइन मदद रूपों में से प्रत्येक उपयोगकर्ता कैसे कार्यक्रम के प्रत्येक समारोह का उपयोग करने के दिखाने के लिए डिज़ाइन किया गया है, या तो चरण मार्गदर्शिका या मदद फ़ाइलें और ऑनलाइन मदद के मामले में tutorial- द्वारा एक कदम के रूप में, इन वीडियो प्रदर्शन शामिल कर सकते हैं पाठ और छवियों के अलावा

Video: Technology Stacks - Computer Science for Business Leaders 2016

5

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