आप अपने विनिर्देशों को लिखने के लिए किस उपकरण/प्रारूप का उपयोग करते हैं?

Question

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

वर्तमान में हम एक एक्सएमएल प्रारूप में अपना विनिर्देश लिखते हैं। टीएक्स भी एक विकल्प होगा, लेकिन उन लोगों के लिए मुश्किल है जो कभी इसके साथ काम नहीं कर रहे हैं।

तो मुझे बताएं कि विनिर्देशों के लिए आप किस प्रकार के औजारों या प्रारूपों का उपयोग करते हैं।

Answer 1

डॉकबुक XXE के साथ संपादित किया गया, जिसे क्लाइंट को भेजे जाने की आवश्यकता होने पर xslt के साथ पीडीएफ में अनुवाद किया गया।

सबसे अच्छा परिवर्तन, लिखना इतना आसान है, विलय करना इतना आसान है, और जब इसे परिवर्तित किया जाता है तो यह MSWord के रूप में इतनी गर्वपूर्ण रूप से गैर-व्यावसायिक नहीं दिखता है।

प्लस संरचित दस्तावेज़ शैली पहले से मौजूद है, खूनी शब्द के विपरीत जो आपको काम करने के लिए लड़ना है।

Answer 2

मैं ऐसी सभी चीजों के लिए Docbook का उपयोग करने आया हूं। यह आसान है, लचीला है, और एचटीएमएल, tex (और इस प्रकार पीडीएफ), आदि उत्पन्न होगा

Answer 3

हम टेक्स (MiKTeX) का इस्तेमाल किया और यह सही था क्योंकि:

• शिकायत पाठ - विम/नोटपैड में संपादित करें - बस हर जगह
• सशक्त प्रारूपण पूर्व-निर्धारित मैक्रो हम में से एक पीडीएफ के लिए
• onclick पीढ़ी किया

केवल समस्या में (ArgoUML से) चित्र मिल गया था का उपयोग कर।

+०१२३५१६४१०६१

एक और प्रोजेक्ट में मैंने वर्ड टेम्पलेट्स का उपयोग करके देखा - ऊपर से निर्देशित भयानक सामान।

मैं इंट्रानेट पर विकी/फोरम जैसे कुछ का उपयोग करने पर विचार करता हूं। GoogleDocs का उपयोग करके कल्पना करें - संस्करण है, यह ऑनलाइन है .. लेकिन व्यावसायिक विकास के लिए लागू नहीं है।

Answer 4

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

Answer 5

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

मैं अभी भी एक स्पेस रखता हूं जो कि मेरी दीवार पर एक अनुस्मारक के रूप में कुछ नोटबुक पेपर पर लिखा गया था।

Answer 6

काम पर हम विकी का उपयोग करते हैं क्योंकि वे सहयोग के लिए बहुत अच्छे हैं, लेकिन माइक्रोसॉफ्ट वर्ड काम करेगा।

आप वर्ड डॉक्यूमेंट के दो अलग-अलग संस्करणों को वास्तव में वर्ड का उपयोग करके अलग कर सकते हैं - यह अंतर दिखाने के लिए "ट्रैक चेंज" सुविधा का उपयोग करता है। (यदि आप मुझ पर विश्वास नहीं करते हैं, तो TortoiseSVN का उपयोग करके वर्ड दस्तावेज़ के दो संस्करणों को अलग करने का प्रयास करें।)

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