प्रोजेक्ट प्रलेखन

Question

कैसे लिखना है मैंने अभी अपेक्षाकृत छोटी परियोजना (कई मॉड्यूल में कोड की 3000 लाइनें) समाप्त की हैं और मुझे परियोजना के लिए एक दस्तावेज़ तैयार करने के लिए कहा गया है। मुझे नहीं पता कि इस बारे में कैसे जाना है क्योंकि मैंने पहले अन्य प्रोग्रामर के लिए कोड लिखा है। क्या मैं प्रत्येक मॉड्यूल का वर्णन करता हूं, प्रत्येक ऑब्जेक्ट के लिए यूएमएल आरेख करता हूं, बस मेरी टिप्पणियों पर विस्तार करता हूं? क्या कोई टेम्पलेट है जिसके लिए मैं इसका उपयोग कर सकता हूं? अगर किसी को मानक दस्तावेज करना पड़ता है तो मैं आपकी मदद/पॉइंटर्स की सराहना करता हूं।

Answer 1

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

Answer 2

कम से कम आप

• कैसे सॉफ्टवेयर का निर्माण करने के
• यह
• एक फ़ाइलें और उपकरणों की "प्रकट" आवश्यक
• रिलीज नोट्स स्थापित करने के लिए कैसे दस्तावेज़ चाहिए: क्या से बदल पिछला जारी संस्करण
• लाइसेंस और कॉपीराइट जानकारी

फिर, कैसे सॉफ्टवेयर प्रयोग किया जाता है पर निर्भर करता है, आप चाहते हो सकता है

• उपयोगकर्ता पुस्तिका
• API दस्तावेज़

Answer 3

आप DOD-STD-2178A डाटा मद विवरण की समीक्षा करने की तुलना में बहुत बदतर कर सकता है सॉफ्टवेयर डिजाइन दस्तावेज़ और संस्करण विवरण दस्तावेज़ के लिए।

एसडीडी सॉफ्टवेयर के डिजाइन का वर्णन करता है। वीडीडी पैकेजिंग का वर्णन करता है, जिसमें इसे इंस्टॉल करना (अनपैक, संकलन, लोड, सेटअप) शामिल है।