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

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

20
क्या आपको "बस फैक्टर" बढ़ाने के लिए अच्छे दस्तावेज और स्वच्छ कोड लिखना चाहिए?
सॉफ्टवेयर विकास कंपनियों के मुख्य लक्ष्यों में से एक उनके बस कारक को बढ़ाना है। यह बात Google द्वारा आयोजित एक वार्ता में भी की गई है । इसका मतलब है कि आपको सब कुछ इस तरह से कोड और दस्तावेज़ करना चाहिए कि यदि आप कल बस से चले, …

14
उद्योग में प्रलेखन के लिए क्या है?
लगता है कि यहां तक ​​कि सबसे बुनियादी दस्तावेज लिखने का भी विरोध हो रहा है। हमारी परियोजना READMEs अपेक्षाकृत नंगे हैं। डॉक्स में निर्भरता की अद्यतन सूची भी नहीं है। क्या ऐसा कुछ है जो मैं उद्योग में अनभिज्ञ हूँ, जो प्रोग्रामर को लेखन दस्तावेज नापसंद करता है? यदि …

7
आप अपनी टीम द्वारा लिखी गई कक्षाओं और कार्यों को कैसे ट्रैक करते हैं?
कोड पर काम करते समय, मुझे कई समान चुनौतियों का सामना करना पड़ता है जो मेरे टीम के साथी करते हैं, और मैंने कुछ सहायक कार्य और कक्षाएं लिखी हैं, और इसलिए उनके पास है। अगर अच्छा संचार होता है, तो मैं किसी महान चीज़ के बारे में सुनूंगा जो …

6
"I", "हम", या न ही कोड प्रलेखन में
मैं अपने आप को (उम्मीद है कि टाइप के दस्तावेज़ीकरण) (C ++) में सहायक टिप्पणियाँ लिख रहा हूँ: The reason we are doing this is... "मैं" के बजाय "हम" का उपयोग करने का कारण यह है क्योंकि मैं बहुत सारे अकादमिक लेखन करता हूं जहां "हम" को अक्सर पसंद किया …

12
OOP में दस्तावेज़ीकरण यह निर्दिष्ट करने से बचना चाहिए कि "गेट्टर" कोई संगणना करता है या नहीं?
मेरे स्कूल का CS प्रोग्राम ऑब्जेक्ट ओरिएंटेड प्रोग्रामिंग के किसी भी उल्लेख से बचता है, इसलिए मैं इसे सप्लीमेंट करने के लिए अपने आप कुछ पढ़ रहा हूं - विशेष रूप से, बर्ट्रेंड मेयर द्वारा ऑब्जेक्ट ओरिएंटेड सॉफ्टवेयर कंस्ट्रक्शन । मेयर बार-बार यह बात कहते हैं कि वर्गों को अपने …


6
Git-friendly स्प्रेडशीट प्रारूप? [बन्द है]
हम Google दस्तावेज़ से स्व-होस्ट किए गए गिट रिपॉजिटरी के सेट में हमारी परियोजना प्रलेखन प्रक्रिया को स्थानांतरित करने का प्रयास कर रहे हैं। पाठ दस्तावेज़ पर्याप्त रूप से अनुकूल हैं, क्योंकि हमें आमतौर पर किसी भी फ़ॉरमेट स्वरूपण की आवश्यकता नहीं होती है, हम जटिल मामलों के लिए LaTeX …

9
क्या गैर-आईटी लोग विकी को संभाल सकते हैं? [बन्द है]
मेरी कंपनी अपने बाजार अनुसंधान डेटा प्रबंधन में सुधार करना चाहती है। वर्तमान डेटा प्रबंधन शैली: “अरे जिम्बो, हमारे व्हाट्सएप 2.0 की वह तस्वीर कहाँ है? "हाँ, मुझे उस आदमी से उस कंपनी के बारे में ईमेल याद है, मेरे आउटलुक को सर्च करने के लिए कुछ मिनटों के लिए" …

6
मौजूदा कोड आधार का दस्तावेजीकरण करने की पद्धति
मैं एक मौजूदा एप्लिकेशन पर एक टीम के हिस्से के रूप में काम करता हूं, जिसमें कोई इनलाइन प्रलेखन नहीं है, और न ही इसके पास तकनीकी दस्तावेज हैं। जैसा कि मैं आवेदन पर विभिन्न बग रिपोर्ट पर काम कर रहा हूं, मैंने अपने लिए एक तरह का ब्रेडक्रंब ट्रेल …

3
सादा-पाठ मार्कअप भाषाओं का उपयोग करने में विकास की प्रक्रिया में किन बाधाओं का सामना करना पड़ता है, उदाहरण के लिए, Microsoft Word? [बन्द है]
मैं वर्तमान में एक सरकारी ठेकेदार के रूप में प्रशिक्षु हूं और यह महसूस कर रहा हूं कि सॉफ्टवेयर विकास प्रक्रिया में वर्ड वास्तविक मानक है। इसका द्विआधारी प्रारूप दस्तावेज़ों पर उस तरह से सहयोग करना बहुत कठिन बना देता है जिस तरह से मैं एक कोड आधार पर सहयोग …

3
"Readme" की उत्पत्ति
लोगों ने रीडमी फाइलें लिखना कब शुरू किया? ऐसा लगता है कि इस प्रारूप की परवाह किए बिना सभी कार्यक्रमों में बहुत अधिक है। क्या इस दस्तावेज़ का कोई प्रथम उपयोग है?

2
कोड के लिए दस्तावेज़ीकरण कैसे किया जाता है और सॉफ़्टवेयर (अक्सर) खराब दस्तावेज क्यों है?
वहाँ से अच्छी तरह से प्रलेखित कोड के कुछ अच्छे उदाहरण हैं, जैसे जावा एपीआई। लेकिन, सार्वजनिक परियोजनाओं जैसे कि git और कंपनियों की आंतरिक परियोजनाओं में बहुत से कोड खराब तरीके से प्रलेखित हैं और बहुत नए लोगों के अनुकूल नहीं हैं। मेरे सभी सॉफ्टवेयर डेवलपमेंट स्टंट्स में, मुझे …

5
एजाइल के हिस्से के रूप में डिज़ाइन दस्तावेज़
मेरे कार्यस्थल पर, हमें उस "फुर्तीली" में एक चुनौती का सामना करना पड़ता है, जिसका अक्सर अर्थ होता है "अस्पष्ट आवश्यकताएं, बुरी स्वीकृति मानदंड, सौभाग्य!" हम सामान्य सुधार के प्रयास के रूप में इसका समाधान करने का प्रयास कर रहे हैं। इसलिए, इसके भाग के रूप में, मैं यह प्रस्ताव …

4
क्या BDD वास्तव में गैर-प्रोग्रामर द्वारा लिखने योग्य है?
व्यवहार-संबंधी विकास के साथ इसका प्रतीक "दिया-जब-तब" परिदृश्य वाक्य-विन्यास हाल ही में सॉफ्टवेयर कार्यक्षमता मूल्यांकन के लिए एक सीमा वस्तु के रूप में इसके संभावित उपयोग के लिए काफी सम्मोहित किया गया है । मैं निश्चित रूप से सहमत हूँ कि Gherkin , या जो भी सुविधा परिभाषा आप पसंद …

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

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