2009-02-02 5 views
11

एसओ (here और here) पर कार्यालय चर्चा के तरीके से पहले कुछ चर्चा हुई है, हालांकि मुझे लगता है कि मेरा प्रश्न अभी भी थोड़ा अलग है।संस्करण डिज़ाइन दस्तावेज़ों का सर्वोत्तम तरीका कैसे है?

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

स्वाभाविक रूप से, मैं इन फ़ाइलों को एसवीएन में भी जांचता हूं। जो मैं खोज रहा हूं वह संपूर्ण फ़ाइल स्वरूप और रणनीतियां पूरी संस्करण, diff'ing और विलय प्रक्रियाओं के साथ अच्छी तरह से खेलने के लिए है। उदाहरण के लिए, मुझे लगता है कि वर्ड प्रोसेसर फ़ाइलों को एक्सएमएल के रूप में स्टोर करना सबसे अच्छा होगा, या क्या अंतर मानव पाठकों के लिए बदसूरत और बेकार होगा?

  • यदि अंतर और पाठ दस्तावेज़ मर्ज करते हैं, हालांकि उस जाएंगे जो शायद होने के लिए (OOo, अत्यावश्यक अच्छा करने वाली है एमएस वर्ड)
  • diff (और शायद विलय: यहाँ मैं क्या करना चाहते हैं क्या है अवधारणात्मक रूप से मुश्किल) स्कीमा चित्र, जैसे यूएमएल आरेख। मैं सोच रहा था कि ये स्वतंत्र एक्सएमएल/एसवीजी फाइलें हो सकती हैं और टेक्स्ट दस्तावेजों में शामिल हो सकती हैं, लेकिन मुझे यह नहीं पता कि ये दस्तावेज़ कैसे काम करते हैं कि यह वास्तव में संभव है या नहीं।
  • स्वचालित रूप से पाठ दस्तावेज़ (शायद svn:keywords साथ)

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


संपादित करें: बस सुनिश्चित करें कि हो सकता है, कोई "गैर तकनीकी उपयोगकर्ताओं" यहाँ शामिल किया गया। यह सिर्फ प्रोग्रामर है और दस्तावेज़ केवल प्रोग्रामिंग परियोजनाओं पर उपयोग के लिए हैं। प्रकाशित होने के लिए पीडीएफ हो सकते हैं लेकिन यह सिर्फ एक और निर्माण आर्टेफैक्ट होने वाला है, कुछ भी संस्करण नहीं होना चाहिए।

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

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

+0

तो, आप इस समस्या से निपटने/मुकाबला कैसे समाप्त कर चुके हैं? –

उत्तर

0

ओओओ के साथ समस्या फ़ाइल प्रारूप वास्तव में फ़ाइलों का एक ज़िप संपीड़ित समूह है (फ़ाइल एक्सटेंशन को .zip या .7z में बदलने का प्रयास करें)। इससे भिन्नताएं करना मुश्किल हो जाता है।

मैं लाटेक्स और डॉकबुक देख रहा हूं, लेकिन उपयोग करने के लिए स्टाइल टेम्पलेट स्थापित करना काफी मुश्किल है। यह सभी ट्यूटोरियल चमकने का कठिन हिस्सा है।

तो मूल रूप से मैंने प्रलेखन से सार्थक diffs प्राप्त करने के लिए छोड़ दिया है। यह बाइनरी ब्लब्स के रूप में चेक किया जाता है।

3

जब भी संभव हो, मैं संस्करण संस्करण नियंत्रण के तहत पीडीएफ प्रस्तुत करने के अलावा सभी "कच्ची" फ़ाइलों को टेक्स्ट प्रारूप (यानी एक्सएमएल/डॉकबुक, सादा पाठ, लाटेक्स) में रखता हूं। साथ ही, मैं सबवर्सन रिपॉजिटरी संशोधन संख्या का उपयोग दस्तावेज़ के लिए संस्करण संख्या के रूप में करने का प्रयास करता हूं।

यदि आप स्वचालित संशोधन संख्या (यानी एक शब्द दस्तावेज़ में) का उपयोग नहीं कर सकते हैं, तो मैं अंतिम संशोधन की तारीख का उपयोग करने की अनुशंसा करता हूं। अंतिम संपादन की तिथि का उपयोग करना सुनिश्चित करें, न कि वर्तमान दिनांक मैक्रो, क्योंकि जब आप दस्तावेज़ मुद्रित करते हैं तो वर्तमान दिनांक मैक्रो जो भी तारीख हो, वह भर जाएगा, जो शायद आप नहीं चाहते हैं। जाने का एक और तरीका पारंपरिक वृद्धिशील संस्करण संख्या का उपयोग करना है, लेकिन मेरे अनुभव में लोगों को अक्सर एक कठिन समय पता होता है कि केवल एक संख्या देखते समय कौन सा संस्करण नवीनतम है। लोग आमतौर पर पुरानी तिथियों के बारे में अधिक जागरूक होते हैं।

तिथि और/या प्रत्येक पृष्ठ के लिए शीर्ष लेख/पाद लेख के एक भाग के रूप में संशोधन संख्या होने पर भी एक बड़ा प्लस, इस तरह आप अपने डेस्क पर चारों ओर झूठ बोल रही विभिन्न संस्करणों अप मिश्रण लोगों से बचने के है ...

4

WYSIWYG संपादकों (वर्ड, ओपनऑफिस) आम तौर पर किसी कारण को नहीं देखते हैं कि किसी और को उनकी फाइलों के साथ गड़बड़ क्यों करनी चाहिए, इसलिए एक गैर-तकनीकी उपयोगकर्ता और का उपयोग कर सकता है जो एक संस्करण नियंत्रण प्रणाली के अनुकूल है असंभव है। अपवाद: गिट में filter which can look into OpenOffice files है। मुझे यकीन नहीं है कि आप कीवर्ड विस्तार का उपयोग कर सकते हैं, हालांकि।

मैं सुझाव देता हूं कि आपके उपयोगकर्ताओं के लिए इसका उपयोग कैसे करें विकी और सप्ताह का प्रशिक्षण। यह आपकी सभी समस्याओं को हल करता है (कुछ विकीज़ को संस्करण नियंत्रण प्रणाली में भी चेक किया जा सकता है)। जैसा कि मैंने different post में कहा था, एकमात्र बाधा यह है कि उपयोगकर्ताओं को विचार के आदी होने में कुछ दिन लगेंगे। उसके बाद, वे इसे प्यार करेंगे।

0

हमने अपनी कुछ परियोजनाओं पर दस्तावेज़ीकरण के लिए विकी का उपयोग किया है। इसमें प्रति प्रविष्टि का शानदार संस्करण ट्रैकिंग है लेकिन दस्तावेज़ स्तर पर नहीं, इसलिए हमने दस्तावेज़ों का निर्यात किया और बेसलाइन के लिए भी जांच की।

2

जैसा कि आर्न डिगुल्ला ने नोट किया, विकी एक अच्छा विचार है। आपको यह महसूस करना होगा कि आप जो भी चाहते हैं उसे प्राप्त करने का एकमात्र तरीका आपकी संपूर्ण दस्तावेज़ रणनीति पर पुनर्विचार करना है।

कोई सॉफ्टवेयर असंगत फ़ाइल स्वरूपों के मुद्दे को ठीक करने जा रहा है और विभिन्न संस्करणों की तुलना करने में सक्षम नहीं है। अब आप जिन टूल्स का उपयोग कर रहे हैं वे नौकरी के लिए गलत उपकरण हैं। यह आपके टूलसेट और सोचने के तरीके को बदलने के लिए कठिन, असहज और संभावित रूप से महंगा होगा, लेकिन यह आपके द्वारा प्राप्त की जाने वाली चीज़ों को प्राप्त करने में सक्षम होने की लागत है, जो खुद को 10 गुना भुगतान करने के लिए समाप्त हो जाएगा।

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

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

2

एक विकी यहां एक अच्छा विचार जैसा प्रतीत होता है, लेकिन यदि यह एक अच्छा फिट नहीं है, तो आप के साथ Sphinx (या इसी तरह) का उपयोग करने पर विचार करना चाहेंगे।

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

2

एसवीएन के लिए टोर्टोइज एसवीएन क्लाइंट (विंडोज) ओपन ऑफिस के बारे में पर्याप्त जानता है कि जब आप इसे अलग करने के लिए कहते हैं, तो इसे आवश्यक संस्करणों को पकड़ने के बाद, यह दोनों दस्तावेजों के साथ कार्यालय खोलता है, अंतर दिखाता है। मैं इसका बहुत उपयोग करता हूं। मुझे कल्पना है कि वहाँ भी प्रशंसक समाधान हैं, और मैक/लिनक्स/ओएस/360 या जो भी हो, के लिए समान चीजें हैं, लेकिन इस बहुत तकनीकी उपयोगकर्ता के लिए जो अक्सर बहुत ही अनैतिक महसूस करता है क्योंकि वह अपना दोपहर का भोजन चाहता है, टोर्टोइज एसवीएन (http://tortoisesvn.tigris.org/) बचाता है।

संबंधित मुद्दे