प्रलेखन सॉफ्टवेयर विकास चक्र का एक अनिवार्य हिस्सा है। यह बताता है कि सॉफ़्टवेयर का उपयोग कैसे करना है और इसमें उपयोगकर्ता मार्गदर्शिकाएँ, API संदर्भ, स्थापना निर्देश और रिलीज़ नोट शामिल हो सकते हैं।
अपने दस्तावेज़ीकरण को स्वचालित करना नवीनतम चलन है क्योंकि यह समय बचाने, त्रुटियों को कम करने और निरंतरता सुनिश्चित करने में मदद कर सकता है। अपने दस्तावेज़ को अप-टू-डेट और सभी हितधारकों के लिए सुलभ रखने से सहयोग और निरंतर सुधार की सुविधा मिलती है।
कोड के रूप में डॉक्स दस्तावेज़ीकरण स्वचालन के लिए एक दृष्टिकोण है जो तकनीकी दस्तावेज़ीकरण को कोड के रूप में मानता है।
कोड के रूप में डॉक्स क्या है?
डॉक्स कोड के रूप में एक सॉफ्टवेयर विकास दर्शन है जो तकनीकी दस्तावेज़ीकरण को कोड के रूप में देखता है। यह सुझाव देता है कि आपको प्रलेखन को सॉफ्टवेयर कोड के समान कठोरता और प्रक्रिया के साथ व्यवहार करना चाहिए।
कोड के रूप में डॉक्स के पीछे का विचार प्रलेखन को विकास प्रक्रिया की प्रथम श्रेणी की कलाकृति के रूप में मानना है, इसे सॉफ्टवेयर जीवनचक्र के साथ एकीकृत करना है। इसका अर्थ है दस्तावेज़ीकरण को कोडबेस के अभिन्न अंग के रूप में मानना। इसका मतलब है कि इसे उसी संस्करण नियंत्रण, निरंतर एकीकरण, और परीक्षण प्रक्रियाओं को लागू करना जो आप स्वयं कोड पर करते हैं।
कोड सेटअप के रूप में एक विशिष्ट डॉक्स में, आप प्रलेखन को सादे पाठ फ़ाइलों में लिखते हैं, आमतौर पर अंदर मार्कडाउन जैसी हल्की मार्कअप भाषा, HTML, या पुनर्गठित पाठ। फिर आप इसे उसी रिपॉजिटरी में सोर्स कोड के रूप में स्टोर करते हैं। इससे सॉफ़्टवेयर और दस्तावेज़ीकरण दोनों में परिवर्तनों को प्रबंधित और ट्रैक करना आसान हो जाता है। यह यह सुनिश्चित करने में भी मदद करता है कि दस्तावेज़ीकरण कोड के नवीनतम संस्करण के साथ अद्यतित है।
आपको कोड के रूप में डॉक्स का उपयोग क्यों करना चाहिए
कोड के रूप में डॉक्स से पहले, प्रलेखन को अक्सर कोड से अलग माना जाता था, जिसे विभिन्न उपकरणों और प्रक्रियाओं के साथ बनाया गया था। यह ढीला दृष्टिकोण अक्सर पुराने दस्तावेज़ीकरण और कोड के साथ विसंगतियों का कारण बनता है। डॉक्स को कोड दृष्टिकोण के रूप में अपनाकर आप कई लाभों का उपयोग कर सकते हैं।
बेहतर सहयोग
कोड के रूप में डॉक्स विकास प्रक्रिया में डेवलपर्स, तकनीकी लेखकों और अन्य हितधारकों के बीच सहयोग को सक्षम बनाता है। चूंकि कोड रिपॉजिटरी में प्रलेखन होता है, इसलिए विभिन्न पक्षों के लिए योगदान करना और परिवर्तन करना आसान होता है। यह सुनिश्चित करने में मदद करता है कि दस्तावेज़ सटीक, अद्यतित और व्यापक है।
प्रलेखन के लिए एक सहयोगी दृष्टिकोण यह सुनिश्चित करने में मदद करता है कि इसमें सभी प्रासंगिक जानकारी शामिल है और यह सभी पक्षों द्वारा व्याख्या की गई सॉफ़्टवेयर प्रणाली को सटीक रूप से दर्शाता है।
प्रक्रिया स्वचालन और अभिगम्यता
कोड के रूप में डॉक्स का एक अन्य लाभ यह है कि यह दस्तावेज़ों को उत्पन्न करने और प्रकाशित करने के लिए स्वचालित उपकरणों को सक्षम बनाता है। एक बिल्ड सिस्टम एक वेबसाइट या एक आंतरिक दस्तावेज़ीकरण पोर्टल पर प्रकाशित करने के लिए सादे पाठ फ़ाइलों से दस्तावेज़ों के HTML या PDF संस्करणों को स्वचालित रूप से उत्पन्न कर सकता है। यह प्रलेखन को अधिक हितधारकों के लिए सुलभ बनाता है।
प्रलेखन उत्पन्न करने और प्रकाशित करने की प्रक्रिया को स्वचालित करके, कोड के रूप में डॉक्स दस्तावेज़ीकरण को बनाए रखने और प्रकाशित करने के लिए आवश्यक समय और प्रयास को कम करने में मदद करता है। यह विकास टीमों को सॉफ्टवेयर में सुधार पर ध्यान केंद्रित करने की अनुमति देता है।
संस्करण नियंत्रण
सॉफ्टवेयर के रूप में एक ही कोड रिपॉजिटरी में प्रलेखन को संग्रहीत करना दोनों में परिवर्तनों को प्रबंधित करना और ट्रैक करना आसान बनाता है।
आप उपयोग कर सकते हैं संस्करण नियंत्रण प्रणाली प्रलेखन परिवर्तनों को ट्रैक करने और यदि आवश्यक हो तो पिछले संस्करणों पर वापस जाने के लिए गिट की तरह। यह सुनिश्चित करने में मदद करता है कि दस्तावेज़ सटीक और अद्यतित हैं, और आप परिवर्तनों का पता लगा सकते हैं और ऑडिट कर सकते हैं।
कोड वर्कफ़्लो के रूप में विशिष्ट दस्तावेज़
कोड वर्कफ़्लो के रूप में विशिष्ट दस्तावेज़ों में लेखन, संस्करण नियंत्रण, भवन और होस्टिंग शामिल हैं:
लेखन प्रक्रिया
लेखन प्रक्रिया कोड कार्यप्रवाह के रूप में विशिष्ट दस्तावेज़ों का पहला चरण है। अधिकांश तकनीकी लेखक और प्रलेखन इंजीनियर सरल मार्कडाउन, एससीआईडॉक या एचटीएमएल का उपयोग करते हैं। वे GitBook और Redocly जैसे टूल का उपयोग करके दस्तावेज़ लिखते हैं जो एक सुचारू प्रक्रिया सुनिश्चित करते हैं।
प्रलेखन के लिए संस्करण नियंत्रण
कोड विकसित होते ही दस्तावेज़ीकरण विकसित होता है। आसान सहयोग और संस्करण ट्रैकिंग के लिए प्रलेखन परिवर्तनों को ट्रैक करने के लिए आपको गिट, प्लास्टिक एससीएम, या तोड़फोड़ जैसी परिष्कृत संस्करण नियंत्रण प्रणाली की आवश्यकता होगी।
प्रलेखन निर्माण प्रक्रिया
निर्माण प्रक्रिया में प्रलेखन को उसके वितरण प्रारूपों में संसाधित और संकलित करना शामिल है। ये HTML, PDF, EPUB, या अन्य हो सकते हैं। प्रलेखन प्रक्रिया को आमतौर पर ह्यूगो और जेकिल जैसे स्थिर साइट जेनरेटर का उपयोग करके आसान बना दिया जाता है।
होस्टिंग और वितरण प्रलेखन
कोडिंग प्रक्रिया के रूप में होस्टिंग या वितरण प्रक्रिया आमतौर पर डॉक्स का अंतिम चरण होता है। यह प्रक्रिया सुनिश्चित करती है कि दस्तावेज़ीकरण अंतिम उपयोगकर्ता तक पहुँचाया जाए और सभी हितधारकों के लिए उपलब्ध हो। आप अपने दस्तावेज़ को वेब पर वितरित करने के लिए GitHub या GitLab पेज या एक कस्टम पोर्टल का उपयोग कर सकते हैं।
आप GoDoc और JavaDoc का उपयोग करके Go और Java दस्तावेज़ीकरण को स्वचालित कर सकते हैं
कोड दर्शन के रूप में डॉक्स तकनीकी दस्तावेज लेखन और प्रबंधन में क्रांति ला रहा है।
गो और जावा सहित कई प्रोग्रामिंग लैंग्वेज, कोड टिप्पणियों का उपयोग करके प्रलेखन को स्वचालित करने के लिए उपकरण प्रदान करती हैं। Go Godoc टूल प्रदान करता है, और Java JavaDoc प्रदान करता है।
