कोड प्रोजेक्ट से जुड़े प्रलेखन को संग्रहीत करने का सबसे अच्छा तरीका क्या है?


10

हमारे पास हमारे सॉफ़्टवेयर विकास से जुड़े बहुत सारे दस्तावेज़ हैं। इनमें आवश्यकताएं, डिजाइन दस्तावेज, बाहरी पीडीएफ, ग्राहक फाइलें, परीक्षण निर्देश आदि जैसी चीजें शामिल हैं। वर्तमान में, ये दस्तावेज सभी जगह बिखरे हुए हैं (विकी, "नेटवर्क पर कुछ जगह", एक स्थानीय डेवलपर्स हार्ड ड्राइव!)! और इससे भी बदतर जगह)।

उनमें से सबसे अच्छा तरीका क्या है? चूंकि हम अपने विकास के लिए दृश्य स्टूडियो (2010) का उपयोग करते हैं, और हमारे पास वास्तव में परियोजना पर कोई गैर-डेवलपर्स नहीं है, मैंने सोचा कि यह वीएस "समाधान" के भीतर उन्हें स्टोर करने का एक बड़ा विचार होगा, जो उन्हें अनुमति देगा स्रोत को नियंत्रित किया जाना, और सभी डेवलपर्स द्वारा सार्वभौमिक रूप से सुलभ होना।

हालांकि, वीएस वास्तव में ऐसा करने के लिए बनाया नहीं लगता है। यदि आप किसी भी डॉक्यूमेंट फ़ाइल को एडिट करते हैं, यहां तक ​​कि बिल्ड गुण "कोई नहीं", "कॉपी न करें" के साथ सेटअप किया जाता है, तो वीएस को फिर से चलने से पहले सॉफ़्टवेयर का पुनर्निर्माण करना होगा। समाधान के भीतर "प्रलेखन परियोजना" बनाने का कोई तरीका नहीं है। (हम इसके लिए एक खाली सी # परियोजना का उपयोग करते हैं)। विजुअल स्टूडियो और वर्ड / एक्सेल फ्लैट स्रोत नियंत्रण को अच्छी तरह से नहीं करते हैं। आप चेक-इन की गई फ़ाइल को नहीं देख सकते हैं, और फिर फ़ाइल को बंद किए बिना परिवर्तन करने का निर्णय ले सकते हैं, परियोजना में जा रहे हैं, और परिवर्तन करने से पहले मैन्युअल रूप से जाँच कर सकते हैं। यह धीमी गति से और थकाऊ है।

वैसे भी यह हमारी टीम के साथ आया सबसे अच्छा है, लेकिन मैं वास्तव में चाहता हूं कि मेरे पास एक बेहतर (मुक्त) समाधान था।


आपकी टीम कितनी बड़ी है?
जेफ

अभी हमारे पास 3-4 हैं।
डेविड

आप विशेष रूप से किस संस्करण-नियंत्रण का उपयोग कर रहे हैं। मुझे उस स्रोत नियंत्रण का पता नहीं है जहाँ आप इसे प्रबंधित करने के लिए Visual Studio का उपयोग करने के लिए बंधे हैं।
अर्लज़

जहां मैं काम करता हूं, हम TFS का उपयोग कोड स्टोर करने के लिए करते हैं, और दस्तावेज़ीकरण, परीक्षण योजनाओं आदि के लिए SharePoint
नौकरी

4
मैं पीडीएफ जैसे दस्तावेजों को वीएसएस में डालने की सिफारिश नहीं करूंगा। आपका मन है, मैं वास्तव में वीएसएस में स्रोत कोड डालने की सिफारिश नहीं करूंगा।
कार्सन 63000

जवाबों:


3

मुझे यकीन नहीं है कि वहाँ एक "सबसे अच्छा तरीका" है, लेकिन आपके विवरण से, ऐसा लगता है कि हर डेवलपर अपने / अपने तरीके से स्टेक प्रलेखन कर रहा है। दस्तावेज़ों को संग्रहीत करने की एकल विधि पर सभी से खरीदें-इन करें, और इसे व्यवस्थित रखना बहुत आसान होगा।

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

मुझे किसी और से सुनने में अच्छा लगेगा यदि वे मुफ्त संस्करण नियंत्रण प्रणालियों के बारे में जानते हैं जो दस्तावेजों के साथ अच्छी तरह से काम करते हैं। केवल एक चीज जो मेरे सिर के ऊपर से निकलती है वह है शेयरपॉइंट, जो बिल्कुल मुफ्त नहीं है। मैंने अनौपचारिक संस्करण प्रणालियों को देखा है, जहां लोगों के पास "संग्रह" फ़ोल्डर है, और बस उस फ़ोल्डर में एक फ़ाइल के पिछले संशोधनों को रखा है, जिसमें नवीनतम संशोधन "फ़ोल्डर" के समान फ़ोल्डर स्तर में है।


हमारा 'विकी' समाधान या तो नेटवर्क शेयर का लिंक है (या नेटवर्क पर फ़ाइलों का सीधा लिंक है। इसका नुकसान यह है कि इसका कोई संस्करण नियंत्रण नहीं है। या आप फ़ाइल को विकी में डाउनलोड / एडिट / अपलोड करते हैं, जो कि है)। किसी भी टाइपो को ठीक करने के लिए किसी भी समय 10 कदम की प्रक्रिया को संपादित करना चाहते हैं।
डेविड

बहुत सारे मुफ्त शेयरपॉइंट विकल्प (जो बेहतर हैं!): एक सरल-से-सेटअप के लिए Nuxeo का प्रयास करें। या अधिक शक्ति के साथ किसी चीज के लिए अल्फ्रेस्को, यदि आपको इसकी आवश्यकता है।
gbjbaanb

आपकी मशीन पर स्थापित Google खोज चीजों को खोजने के लिए चमत्कार करता है।

3

मेरी कंपनी में सबसे अच्छा काम करने वाला समाधान एक विकी स्थापित करना था (हम मीडियाविकि का उपयोग करते हैं)। यह पारंपरिक विकी प्रविष्टियों से एक सरल "यह एक है ..." प्लस एक वर्ड दस्तावेज़ में कई तरह से उपयोग किया जाता है। इसे खोजना बहुत आसान है। हम धीरे-धीरे सूचना के एक बहुत उपयोगी भंडार का निर्माण कर रहे हैं।


हमने doku-wiki का उपयोग करने की कोशिश की है, लेकिन इसका उपयोग करने के लिए बहुत थकाऊ है (एक शब्द doc टाइपो को ठीक करने के लिए 10 कठिन चरण हैं), साथ ही कौन क्या संपादन कर रहा है, इस पर कोई बहु-उपयोगकर्ता सहायता नहीं। फ़ाइल आकार और फ़ाइल एक्सटेंशन के बारे में बहुत सारी चेतावनियाँ और सीमाएँ थीं जो वास्तव में मदद करने से अधिक परेशान थीं। मुझे कंपनी के अन्य लोगों से इसका उपयोग करने पर कोई खरीद-फरोख्त नहीं मिली। मुझे बड़ी संभावनाएं दिखती हैं, लेकिन दुर्भाग्य से मेरी कंपनी के लिए नहीं।
डेविड

1

वीएस 2008 में कम से कम, आप उपयोगिता के लिए सी ++ प्रोजेक्ट के कॉन्फ़िगरेशन प्रकार (परियोजना गुणों के तहत-> सामान्य-> प्रोजेक्ट डिफॉल्ट्स) सेट कर सकते हैं , जिस स्थिति में वीएस इसके साथ कुछ भी नहीं करता है।

क्या आपने अपने सी # आधारित समाधान में इस तरह की परियोजना का उपयोग करने की कोशिश की है? (शायद एक C # -प्रोजेक्ट में भी कुछ ऐसा ही है?)


0

मैं निश्चित रूप से सहमत हूं कि यहां एक भी सबसे अच्छा समाधान नहीं है। लेकिन संस्करण नियंत्रण! = समाधान में शामिल; अधिकांश सिस्टम आईडीई से परे की चीजों को संभाल सकते हैं। इसलिए अधिकांश मामलों में डॉक्स को बंद रखा जा सकता है लेकिन नोटा को।

अब, जब भी वे खोले जाते हैं तो फ़ाइलों को बदलने के लिए शब्द की पुरानी कष्टप्रद आदतें प्राप्त करना एक अलग समस्या है। । ।


0

नहीं, विजुअल स्टूडियो (अच्छी तरह से, C # और Vb.net) परियोजनाओं में समाधान एक्सप्लोरर के लिए एक मस्तिष्क-मृत दृष्टिकोण है। VC ++ एक MUCH बेहतर है क्योंकि आप वर्चुअल फ़ोल्डर्स बना सकते हैं जो डिस्क लेआउट से बंधे नहीं हैं, और सभी प्रकार के सामान भी वहां डाल सकते हैं। मूर्खतापूर्ण Microsoft ने इसे 'समझने में आसान' बनाने की कोशिश करके इसे तोड़ दिया।

आप अभी भी इसे 'सॉल्यूशन फोल्डर' में रख सकते हैं, लेकिन यह अभी भी उतना लचीला नहीं है जितना आप चाहते हैं। इसका मतलब है कि आपको एक विकल्प ढूंढना होगा और मेरे सुझाए गए वैकल्पिक विकल्प वेब उपकरण हैं। यदि आप प्रोजेक्ट पोर्टल (जैसे रेडमाइन) को आज़माना नहीं चाहते हैं, जहाँ आप दस्तावेज़ों को संग्रहीत कर सकते हैं और विकी, बग ट्रैकर, आदि आदि कर सकते हैं, तो दस्तावेज़ प्रबंधन उपकरण के लिए जाएँ। नक्सियो या उल्लू जैसा कुछ आप अच्छा करेंगे। एक बार इसका वेब होने के बाद, आपके पास एक केंद्रीय स्थान होता है, इसलिए लोग जानते हैं कि इन चीजों को कहाँ देखना है - यह शायद दस्तावेज़ प्रबंधन का सबसे महत्वपूर्ण हिस्सा है। यदि आप इसे तोड़-फोड़ जैसे संस्करण नियंत्रण प्रणाली से जोड़ते हैं (चलते हैं, तो आपको वीएसएस के बाद इसका पछतावा नहीं होगा!) तब भी आप दस्तावेज़ों को वेब उपकरण से जोड़ पाएंगे और संस्करण भी उन्हें नियंत्रित कर सकेंगे।

तोड़फोड़ में भी वेब फ़ोल्डर के रूप में रिपॉजिटरी को उजागर करने की क्षमता है - यानी एक नेटवर्क फ़ोल्डर - इसलिए youcoudl ने उन्हें एक 'नेटवर्क ड्राइव' पर डाल दिया, फिर भी अभी भी उनके पास स्वचालित रूप से नियंत्रित संस्करण है।

मैं अब भी अपनी व्यक्तिगत पसंद के रूप में Redmine के लिए जाऊँगा।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.