हमारे पास एक "वेब एप्लिकेशन" है जो पिछले 7 महीनों में विकसित किया गया है। समस्या यह है कि, यह वास्तव में दस्तावेज नहीं था। आवश्यकताओं में 7 महीने पहले प्रारंभिक बैठक से छोटी बुलेट सूची शामिल थी (यह सॉफ़्टवेयर आवश्यकताओं की तुलना में "लक्ष्यों" कथन का अधिक है)। इसने कई मौखिक या चैट चर्चाओं से जुड़ी कई विशेषताएं एकत्र की हैं।मौजूदा छोटी वेबसाइट (वेब एप्लिकेशन) को अंदर और बाहर कैसे दस्तावेज़ित करें?
डेवलपर बहुत जल्द ही जा रहा है। उन्होंने पूरी चीज खुद को लिखी और वह प्रत्येक पृष्ठ पर सभी quirks और अंतर्निहित नियमों को जानता है, लेकिन कोई भी वास्तव में इसके उपयोगकर्ता इंटरफ़ेस पक्ष से कहीं ज्यादा जानता है; निश्चित रूप से आसान हिस्सा है, क्योंकि यह उपयोगकर्ता के लिए सहज हो गया है। लेकिन अगर किसी को इसकी सुविधा या मरम्मत करने की ज़रूरत है, तो पूरी बात एक ब्लैक बॉक्स है। कोड में कुछ न्यूनतम टिप्पणियां हैं, और निश्चित रूप से वेब अनुप्रयोगों के बारे में अच्छी बात यह है कि पता बार आपको किसी समस्या को ठीक करने या किसी पृष्ठ को अपग्रेड करने की दिशा में सही दिशा में इंगित करता है।
लेकिन डेवलपर इस वेब एप्लिकेशन को दस्तावेज करने के बारे में कैसे जाना चाहिए? जहां तक शुरू करना है, वह थोड़ा सा खो गया है। डेवलपर्स के रूप में, आप अन्य डेवलपर्स, रखरखावकर्ताओं और प्रशासनिक स्तर के उपयोगकर्ताओं के लिए अपने वेब एप्लिकेशन को पूरी तरह से कैसे दस्तावेज़ित करते हैं? आप किस दृष्टिकोण का उपयोग करते हैं, आप कहां से शुरू करते हैं, आप किस सॉफ्टवेयर का उपयोग करते हैं, क्या आपके पास टेम्पलेट है?
परिमाण का एक विचार: यह PHP, MySQL और jQuery का उपयोग करता है। इसमें लगभग 20-30 मुख्य (फ्रंटएंड) फ़ाइलें हैं, जिनमें लगभग 15 शामिल फ़ाइलें और कुछ संपत्तियों के कुछ फ़ोल्डर्स हैं - इसलिए कुल मिलाकर यह एक बहुत छोटा एप्लीकेशन है। यह 7 MySQL तालिकाओं के साथ इंटरफेस करता है, प्रत्येक एक अच्छी तरह से नामित है, इसलिए मुझे लगता है कि डेटाबेस अंत बहुत आत्म-स्पष्टीकरणपूर्ण है। एक config.inc.php फ़ाइल है जिसमें MySQL उपयोगकर्ता विवरण, कुछ ईमेल से, और यूआरएल जो PHP और ईमेल और पृष्ठों (सापेक्ष और पूर्ण पथ, मूल रूप से) में डालने के लिए उपयोग करते हैं, के आधार पर परिभाषाओं की परिभाषाओं के साथ है। JQuery के माध्यम से कुछ AJAX है।
वहाँ है अगर किसी भी अन्य जानकारी है कि आप मेरी मदद कर और मैं में संपादित करने में खुशी होगी मदद मिलेगी कृपया टिप्पणी।
डेवलपर शुक्रवार को छोड़ देता है। हालांकि वह इस दस्तावेज कार्य में अपने अधिकांश 24 शेष घंटे समर्पित कर सकता है। तो, हाँ, चीजें उदास हैं लेकिन 24 घंटे काफी थोड़ा है ... सही? : - \
डेवलपर के साथ जाने से पहले आपके पास कितना समय होगा? – ddbeck
शुक्रवार उनका आखिरी दिन है। 24 शेष कार्य घंटे। – Ricket