हाँ सबसे निश्चित रूप से लेकिन
- लिंक रोट एक मुद्दा होने जा रहा है, आदर्श रूप से लिंक को एक ज्ञात लक्ष्य दस्तावेज़ से गतिशील रूप से उत्पन्न करते हैं, लेकिन कॉन्फ़िगरेशन के कुछ रूप से उपसर्ग प्राप्त करते हैं। क्या सर्वर बदलना चाहिए तो आप इस कॉन्फिग तत्व को अपडेट करके पुराने कोड को वैध रख सकते हैं। आप इस उपसर्ग विन्यास को बदलकर भी स्थानीय रूप से डॉक्टर को उपलब्ध करा सकते हैं।
- संस्करण : एक ही आत्मा में, यदि आप कुछ क्षमता में कड़ी में वर्ज़निंग शामिल कर सकते हैं जिससे वे सभी हमेशा प्रलेखन के सही संस्करण अंक।
- डॉक्स संपादन योग्य बनाएं कुछ अपने दस्तावेज़ के लिए विकी प्रकार साइट की तरह जहां आप गतिशील रूप से गलतियों को सही कर सकते हैं, आदर्श रूप से उपयोगकर्ताओं को सीधे पृष्ठ पर टिप्पणी करने की भी अनुमति देते हैं। इससे आपके उपयोगकर्ताओं को भाग लेने और उन्हें खोजने में बहुत आसान हो जाएगा कि उन्हें क्या चाहिए और आपको अपने डॉक्टर को अच्छी कार्यशील स्थिति में रखने के लिए सुनहरी जानकारी मिलेगी लेकिन सुनिश्चित करें कि आप इसकी नियमित रूप से निगरानी करते हैं और अधिकतर सभी सक्रिय रूप से भाग लेते हैं।
- जनरेट किए गए टेम्प्लेट में आपका बिल्ड सिस्टम सीधे कोड में एनोटेशन से प्रलेखन के लिए मूल टेम्पलेट उत्पन्न करता है। हालांकि इसे सरल रखें, लेकिन यह सुनिश्चित करेगा कि हर लिंक हमेशा एक वैध दस्तावेज को इंगित करे। यदि आप विकी का उपयोग करते हैं तो सुनिश्चित करें कि आप इन टेम्प्लेट को आसानी से धक्का दे सकते हैं, और सुनिश्चित करें कि आप उसी तरह से प्रलेखन साइट को बढ़ावा दे सकते हैं जो आप अपने कोड के लिए करते हैं (एक देव साइट है जो ठिकाने की साइट से अलग है और कोड को बढ़ावा देने के लिए विल है। स्वचालित रूप से ठेस साइट में आवेषण प्रदर्शन)।
यदि आप जावा या .NET के साथ विकसित होते हैं, तो डॉक्टर को एक जार फ़ाइल या DLL फ़ाइल में शामिल किया जा सकता है और उपसर्ग को बदलकर आपका कोड इसके बजाय स्थानीय रूप से प्राप्त कर सकता है।
यदि आप विकी दृष्टिकोण का चयन करते हैं, तो मैं इसे सरलता के लिए DokuWiki की गर्मजोशी से अनुशंसा करता हूं और इस तथ्य के लिए कि यह फ्लैट टेक्स्ट फ़ाइलों पर आधारित है, जो बिल्ड सिस्टम से स्वचालित इंजेक्शन के लिए बहुत अनुकूल होगा। उस ने कहा, मैं आपके पर्यावरण या ग्राहकों के बारे में वास्तव में यह जानने के लिए पर्याप्त नहीं हूं कि क्या यह एक अच्छा फिट वाईएमएमवी होगा।
मेरे द्वारा बनाए गए कुछ सबसे सफल टूल ने एक समान दृष्टिकोण लिया है जहां त्रुटि संदेश वास्तविक उपयोगकर्ता को लक्षित किया गया था जो कि संभवतः कार्य को निष्पादित करेगा। इसका मतलब यह था कि मुझे अपवाद का एक बहुत कुछ करना था और यह सुनिश्चित करने के लिए लपेटना था कि त्रुटि अमूर्त के उपयुक्त स्तर पर है। मैंने यह भी सुनिश्चित किया कि प्रत्येक त्रुटि संदेश में संभावित समाधानों में त्रुटियों और बिंदुओं के सबसे संभावित स्रोतों को शामिल किया जाएगा "क्या आप कॉन्फिडेंस कॉन्फिडेंस वैल्यू सेट करना भूल गए?", "सुनिश्चित करें कि xxx और yy उन्हें अलग-अलग नाम देकर संघर्ष न करें" आदि। जहां XXX और whatnot उस संदर्भ से उत्पन्न होगा जहां त्रुटि हुई।
यह दृष्टिकोण कुछ हद तक सरल था लेकिन अधिक सीमित था। यह हालांकि पक्ष था कि प्रलेखन हमेशा मौजूद होगा जब कोई लिंक संभव सड़ांध की आवश्यकता होती है।
आपका दृष्टिकोण अगला विकास है। बहुत अधिक जटिल है, लेकिन अधिक संभावित रिटर्न भी है। यह महंगा होगा, लेकिन अगर सही किया जाता है तो आसानी से खुद के लिए भुगतान करना होगा।