documentation पर टैग किए गए जवाब

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

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

13
क्या आप अंग्रेजी जैसी प्राकृतिक भाषा में एक स्पष्ट विनिर्देश लिख सकते हैं?
यह मुझे लगता है कि आप संभवतः अंग्रेजी में एक सॉफ्टवेयर विनिर्देश नहीं लिख सकते हैं जो पूरी तरह से अस्पष्टताओं से मुक्त है, बस प्राकृतिक भाषा की अनौपचारिक प्रकृति के कारण - और इसलिए कि वास्तव में असंदिग्ध विनिर्देश में औपचारिक रूप से निर्दिष्ट भाषा में लिखा कोड शामिल …

5
कोड प्रलेखन: सार्वजनिक बनाम गैर-सार्वजनिक?
मैं उन डेवलपर्स में से एक हूं जिनकी मानसिकता है कि लिखा गया कोड आत्म-व्याख्यात्मक होना चाहिए और एक किताब की तरह पढ़ना चाहिए। अन्य लोगों के लिए पुस्तकालय कोड विकसित करते समय, उपयोग करने के लिए मैं हेडर फ़ाइलों में अधिक से अधिक दस्तावेज लगाने की कोशिश कर सकता …

6
अगर मैं चुस्त कार्यप्रणाली को नापसंद करता हूं तो क्या यह मुझे खराब प्रोग्रामर बनाता है? [बन्द है]
यहां क्या पूछा जा रहा है, यह बताना मुश्किल है। यह प्रश्न अस्पष्ट, अस्पष्ट, अपूर्ण, अति व्यापक या अलंकारिक है और इसका वर्तमान रूप में यथोचित उत्तर नहीं दिया जा सकता है। इस प्रश्न को स्पष्ट करने में मदद के लिए ताकि इसे फिर से खोला जा सके, सहायता केंद्र …

5
एंड यूजर डॉक्यूमेंटेशन उदाहरण के लिए अच्छे संदर्भ और सलाह [बंद]
बन्द है। यह सवाल ऑफ टॉपिक है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न अपडेट करें तो यह है -विषय पर सॉफ्टवेयर इंजीनियरिंग स्टैक एक्सचेंज के लिए। 6 साल पहले बंद हुआ । हमारे घर के सॉफ्टवेयर का उपयोग कई …

6
हाइपरलिंक, बाह्य स्रोत कोड प्रलेखन [बंद]
बंद हो गया । इस प्रश्न पर अधिक ध्यान देने की आवश्यकता है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न को अपडेट करें ताकि यह इस पोस्ट को संपादित करके केवल एक समस्या पर केंद्रित हो । 4 साल पहले …

1
क्या HTML आउटपुट के लिए doxygen सपोर्ट टेम्प्लेट करता है?
मैंने अपना कोड डॉक्यूमेंट कर दिया है doxygen, लेकिन मैं नहीं चाहता कि डिफ़ॉल्ट HTML यह दे। मुझे पता है कि मैं कस्टम सीएसएस, हेडर, फुटर, आदि प्रदान करके इसे अनुकूलित कर सकता हूं (जैसे गनोम करता है), और मैं फ़ाइलों में सामान्य PHP कोड कैसे जोड़ सकता हूं और …

1
नमूना डेटा के साथ एक एल्गोरिथ्म को ठीक से कैसे दस्तावेज़ित करें?
मैं सोच रहा हूँ कि एक एल्गोरिथ्म प्रलेखन में क्या होना चाहिए? अनुसरण करने के लिए एक उचित दिशानिर्देश का पता नहीं लगा सकते। मुझे शामिल करने का मन है एल्गोरिथ्म का सारांश एल्गोरिथ्म का वर्णन फ़्लोचार्ट छद्म कोड नमूना इनपुट डेटा सेट (एकाधिक) उत्पादित आंकड़े इकाई परीक्षण प्रयोगों ग्राहक …

5
कोड प्रोजेक्ट से जुड़े प्रलेखन को संग्रहीत करने का सबसे अच्छा तरीका क्या है?
हमारे पास हमारे सॉफ़्टवेयर विकास से जुड़े बहुत सारे दस्तावेज़ हैं। इनमें आवश्यकताएं, डिजाइन दस्तावेज, बाहरी पीडीएफ, ग्राहक फाइलें, परीक्षण निर्देश आदि जैसी चीजें शामिल हैं। वर्तमान में, ये दस्तावेज सभी जगह बिखरे हुए हैं (विकी, "नेटवर्क पर कुछ जगह", एक स्थानीय डेवलपर्स हार्ड ड्राइव!)! और इससे भी बदतर जगह)। …

1
फ्लोटिंग-पॉइंट फ़ंक्शंस की सटीक परिशुद्धता
सामान्य वितरण सीडीएफ की गणना करने के लिए एक फ़ंक्शन के किसी अन्य प्रोग्रामर के कार्यान्वयन की समीक्षा करते समय , मैंने पायथन के अंतर्निहित कार्यों के साथ या तो पूरे कार्यान्वयन को बदलने का सुझाव दिया या एक सामान्य वैज्ञानिक पुस्तकालय SciPy का उपयोग किया। एक अन्य प्रोग्रामर ने …

3
क्या डॉक्यूमेंटेशन में बाहरी लिंक जोड़ना बुरा है?
अक्सर मैं स्टैक ओवरफ्लो पर जवाब ढूंढकर खुद को कीड़े को हल करता हूं। क्या यह गलत है कि मैंने जो किया, उसका एक स्निपेट जोड़ना और फिर वेब से एक लेख या पृष्ठ पर एक लिंक जोड़ना?

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

4
क्या हमें झूठे कोड की तलाश में रहना चाहिए?
यह एक उत्तर में एक चर्चा और इस प्रश्न की टिप्पणियों का उल्लेख कर रहा है: उद्योग में प्रलेखन के लिए क्या है? । उत्तर ने दावा किया कि "कोड झूठ नहीं बोल सकता है" और इस तरह प्रलेखन के बजाय स्थान पर जाना चाहिए। कई टिप्पणियों ने बताया कि …

3
प्रलेखन में कोड के विशिष्ट क्षेत्रों को कैसे देखें?
मैं एक परियोजना छोड़ने वाला हूं, और इससे पहले कि मैं अपने बॉस को दस्तावेज़ कोड के लिए कहूं (मैंने बहुत अच्छी तरह से दस्तावेज नहीं किया है)। यह बड़ी बात नहीं है, यह परियोजना बहुत जटिल नहीं है। लेकिन मुझे अपने दस्तावेज़ में ऐसी जगह मिल रही हैं जहाँ …

3
आप कोड के बाहर जटिल व्यावसायिक नियमों का ट्रैक कैसे रखेंगे?
मुझे यह देखने में दिलचस्पी है कि दूसरे लोग ऐसा कैसे करते हैं। विशेष रूप से ऐसी स्थितियों में जहां कई अलग-अलग ग्राहक समान सॉफ्टवेयर आधार का उपयोग थोड़ा अलग व्यावसायिक नियमों के साथ कर रहे हैं। आप किस तरह की प्रथाओं का उपयोग करते हैं कि कैसे सब कुछ …

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.