लक्ष्य इन प्रमुख आवश्यकताओं के साथ एक ऑनलाइन प्रलेखन प्रणाली है:
- मुख्य रूप से हमारे सभी एप्लिकेशन के अंतिम तकनीकी डॉक्स के लिए एक मध्यवर्ती चरण के रूप में उपयोग किया जाएगा (जो शायद कभी पूरा नहीं होगा हालांकि:])। यह आमतौर पर इस तरह के रूप में इस्तेमाल किया जाएगा: किसी को कोई समस्या है, मैं इसे ठीक करता हूं, और ठीक से immedeately लिखता हूं। अब जो होता है वह असहनीय हो रहा है: किसी को कोई समस्या है, मैं इसे ठीक करता हूं, मैं और कोई दोनों खुश हैं लेकिन 2 महीने बाद किसी और को भी यही समस्या है और किसी को भी याद नहीं है कि फिक्स क्या था।
- हर जगह से सुलभ, हमारे अपाचे सर्वर के पीछे चल रहा है
- उपयोगकर्ता / समूह प्रबंधन, केवल पढ़ने / पढ़ने-लिखने / व्यवस्थापक पहुँच की अनुमति देता है
- प्रारूप बहुत महत्वपूर्ण नहीं है: सादे पाठ करेंगे, विकी-शैली हालांकि अच्छे होंगे
- सस्ता या मुफ्त
मेरे कुछ विचार:
- बस एक फ़ाइल शेयर पर या ssh के माध्यम से फ़ाइलों की सेवा करें (विपक्ष: विंडोज़, पेशेवरों के साथ बहुत मैत्रीपूर्ण नहीं है: सरल, कोई भी फ़ाइल प्रकार हो सकता है)
- इसे SCM में रखें (svn / git, idem ऊपर जैसा लेकिन एक्सेस और नियंत्रण के लिए आसान)
- संगम: हम पहले से ही जीरा का उपयोग करते हैं, क्या कंफ्यूजन इसके लायक है? यह जीरा के साथ कैसे एकीकृत करता है?
- कुछ और?
कृपया इन पर टिप्पणी करने में संकोच न करें या अन्य प्रणालियों के साथ अपना अनुभव साझा करें।
क्या दस्तावेज को कोड से उत्पन्न किया जा रहा है (जैसे कि Javadocs) या क्या यह स्क्रैच से लिखा जा रहा है, उपयोगकर्ता गाइड या दोनों के कुछ संयोजन के रूप में?
—
FrustratedWithFormsDesigner
यह मुख्य रूप से एक उपयोगकर्ता मार्गदर्शिका के अधिक है, न कि कोड प्रलेखन (ठीक है, हमारे पास है कि साथ ही, डॉक्सीजन द्वारा उत्पन्न, हम इसे शामिल कर सकते हैं, लेकिन यह ब्याज का पहला बिंदु नहीं है)
—
16
मैं कुछ नकदी Spolsky को सौंप दूंगा।
—
जॉब