विषयसूची:
वीडियो: सोर्स कोड डॉक्यूमेंटेशन क्या है?
2024 लेखक: Lynn Donovan | [email protected]. अंतिम बार संशोधित: 2023-12-15 23:47
सॉफ्टवेयर प्रलेखन लिखित पाठ या चित्रण है जो कंप्यूटर सॉफ़्टवेयर के साथ आता है या उसमें अंतर्निहित है सोर्स कोड . NS प्रलेखन या तो बताता है कि सॉफ्टवेयर कैसे संचालित होता है या इसका उपयोग कैसे करना है, और अलग-अलग भूमिकाओं में लोगों के लिए अलग-अलग चीजें हो सकती हैं। आर्किटेक्चर/डिजाइन - सॉफ्टवेयर का अवलोकन।
इसे ध्यान में रखते हुए, आप दस्तावेज़ों को कैसे कोडित करते हैं?
प्रलेखन लिखने के लिए सर्वोत्तम अभ्यास:
- एक README फ़ाइल शामिल करें जिसमें शामिल है।
- दूसरों के लिए इश्यू ट्रैकर की अनुमति दें।
- एक एपीआई दस्तावेज लिखें।
- अपने कोड का दस्तावेजीकरण करें।
- कोडिंग कन्वेंशन लागू करें, जैसे फ़ाइल संगठन, टिप्पणियाँ, नामकरण परंपराएँ, प्रोग्रामिंग प्रथाएँ, आदि।
- योगदानकर्ताओं के लिए जानकारी शामिल करें।
कोई यह भी पूछ सकता है कि उपयोगकर्ता दस्तावेज क्या है? उपयोगकर्ता दस्तावेज यह आपकी जानकारी के लिए है प्रलेखन अंतिम उपयोगकर्ताओं को प्रदान किए गए उत्पाद या सेवा के लिए। NS उपयोगकर्ता दस्तावेज उत्पाद या सेवा का उपयोग करने के लिए अंतिम उपयोगकर्ताओं की सहायता करने के लिए डिज़ाइन किया गया है। इसे अक्सर के रूप में संदर्भित किया जाता है उपयोगकर्ता सहायता। NS उपयोगकर्ता दस्तावेज ग्राहक को दिए गए समग्र उत्पाद का एक हिस्सा है।
इसे ध्यान में रखते हुए, दस्तावेज़ीकरण के प्रकार क्या हैं?
प्रकार प्रणाली का प्रलेखन एक आवश्यकता शामिल करें डाक्यूमेंट , सोर्स कोड डाक्यूमेंट , गुणवत्ता आश्वासन प्रलेखन , सॉफ़्टवेयर वास्तुशिल्प प्रलेखन , समाधान निर्देश और उन्नत उपयोगकर्ताओं के लिए सहायता मार्गदर्शिका। प्रकार उपयोगकर्ता का प्रलेखन प्रशिक्षण मैनुअल, उपयोगकर्ता मैनुअल, रिलीज नोट्स और इंस्टॉलेशन गाइड शामिल हैं।
सॉफ्टवेयर प्रलेखन में क्या शामिल होना चाहिए?
अपने दस्तावेज़ीकरण में क्या शामिल करें
- आपका सॉफ़्टवेयर क्या करता है और यह किस समस्या का समाधान करता है, इसकी व्याख्या।
- उन परिस्थितियों को दर्शाने वाला एक उदाहरण जिसमें आपके कोड का सामान्य रूप से उपयोग किया जाएगा।
- कोड और बग ट्रैकर के लिंक।
- अक्सर पूछे जाने वाले प्रश्न और समर्थन मांगने के तरीके।
- अपने सॉफ़्टवेयर को कैसे स्थापित करें, इस पर निर्देश।
सिफारिश की:
क्या ओपन सोर्स कोड फ्री है?
लगभग सभी ओपन सोर्स सॉफ्टवेयर फ्रीसॉफ्टवेयर हैं, लेकिन इसके कुछ अपवाद भी हैं। सबसे पहले, कुछ ओपनसोर्स लाइसेंस बहुत अधिक प्रतिबंधात्मक हैं, इसलिए वे मुक्त लाइसेंस के रूप में योग्य नहीं हैं। उदाहरण के लिए, "ओपन वाटकॉम" गैर-मुक्त है क्योंकि इसका लाइसेंस संशोधित संस्करण बनाने और इसे निजी तौर पर उपयोग करने की अनुमति नहीं देता है
क्या हम सोर्स कोड में कनवर्ट कर सकते हैं?
प्रक्रिया को उलट देना और किसी EXE फ़ाइल को उसकी मूल भाषा में वापस स्रोत कोड में परिवर्तित करना एक प्रक्रिया है जिसे 'डीकंपलिंग' कहा जाता है। डिकंपेलर डेवलपर्स के लिए एक शक्तिशाली उपकरण हो सकता है, जिन्हें उन अनुप्रयोगों को संशोधित करने की आवश्यकता होती है जिनका मूल स्रोत कोड लंबे समय से खो गया है
भारत में किसी संगठन के व्यक्ति से या किसी अन्य माध्यम से कंप्यूटर दस्तावेजों की संपत्ति या किसी सॉफ्टवेयर के सोर्स कोड को चुराने के लिए क्या सजा है?
व्याख्या: भारत में किसी भी संगठन, व्यक्ति या किसी अन्य माध्यम से कंप्यूटर दस्तावेज़, संपत्ति या किसी सॉफ़्टवेयर के स्रोत कोड की चोरी करने की सजा 3 साल की कैद और रुपये का जुर्माना है। 500,000
आप वीएस कोड के साथ कोड की तुलना कैसे करते हैं?
आप इस सुविधा का लाभ फाइल एक्सप्लोरर साइड बार से या "फाइलें: तुलना की गई फाइल के साथ तुलना करें" कमांड का उपयोग करके कर सकते हैं। वीएस कोड तुलना टूल अन्य तुलना टूल की तरह ही काम करता है और आप कोड तुलना विंडो के भीतर "इन लाइन मोड" या "मर्ज मोड" में परिवर्तन देखने के लिए सेटिंग बदल सकते हैं।
आप क्रोम में सोर्स कोड कैसे बदलते हैं?
स्रोत फ़ाइलों को सीधे क्रोम में कैसे संपादित करें चरण 1: डेवलपर टूल लॉन्च करें। क्रोम खोलें, अपने स्थानीय फाइल सिस्टम/सर्वर से एक पेज लोड करें और टूल्स मेनू से डेवलपर टूल्स खोलें या Ctrl+Shift+I/Cmd+Shift+I दबाएं। चरण 2: अपना कोड संपादित करें। अब आप सीधे कूद सकते हैं और अपना कोड संपादित कर सकते हैं। चरण 3: फ़ाइल को सहेजें। चरण 4: अपनी गलतियों को पूर्ववत करें