परियोजना प्रलेखन, विनिर्देश को व्यवस्थित करने और बनाए रखने के लिए सॉफ्टवेयर? [बन्द है]

Question

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

आवश्यकताएँ, प्राथमिकताएँ:

• शून्य ग्राहक पक्ष (WEB आधारित) पर स्थापित करें।
• दस्तावेज़ संस्करण नियंत्रण।
• दस्तावेज़ एनोटेशन।
• दस्तावेज़ को जोड़ने।
• पूर्ण खोज (सभी प्रलेखन)।
• MS Word (* .doc) आयात \ निर्यात।
• WYSIWYG टेक्स्ट एडिटर।

अब तक खोजे और आजमाए गए सिस्टम:

• मीडियाविकि
• विकी
• संगम

Comments

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

— Doc Brown

@DocBrown, 95% टेक्स्ट, 3-5 लोग इसे लिखेंगे। सॉफ्टवेयर उत्पादों के संस्करणों के साथ सिंक में है, लेकिन स्रोत कोड संशोधन नहीं है।

— एलेक्स बर्टसेव

XWiki एक अच्छा समाधान जैसा दिखता है यह मुफ़्त है, यह एमएस ऑफिस के साथ अच्छी तरह से एकीकृत करता है।

— एलेक्स बर्टसेव

तकनीकी दस्तावेज लिखने के लिए आप किस प्रोग्राम का उपयोग करते हैं , यह डुप्लिकेट होने के बहुत करीब है ? और उत्तर के कई समान हैं, लेकिन ऐसे प्रलेखन के लिए विकी का उपयोग करने के खिलाफ बेहतर तर्क हैं।

— मार्क बोथ

PHPKB जैसे ज्ञान प्रबंधन सॉफ्टवेयर के बारे में कैसे ? यह मुफ़्त नहीं है लेकिन यह आपके उद्देश्य की बहुत अच्छी तरह से सेवा करता है।

— अनिरुद्ध श्रीवास्तव

Answer 1

स्फिंक्स जैसी चीज के बारे में कैसे ?

आप अपने दस्तावेज़ को reStructuredText (सिंटैक्स मार्कडाउन के समान है, जो स्टैक ओवरफ़्लो का उपयोग करता है) को सादे पाठ फ़ाइलों (= संस्करण नियंत्रण में आसान) में लिखता है और स्फिंक्स HTML पृष्ठों को बाहर निकालता है।

दो सबसे प्रमुख Sphinx उपयोगकर्ता (जो मुझे पता है) पायथन भाषा और TortoiseHG (स्फिंक्स उत्पन्न प्रलेखन के लिए लिंक देखें) हैं।

---

संपादित करें:

मैंने अभी-अभी पढ़ा कि आप प्रोजेक्ट-इंटरनल डॉक्यूमेंटेशन की बात कर रहे हैं, एंड-यूजर डॉक्यूमेंटेशन की नहीं।
मेरी राय में, स्फिंक्स की तरह कुछ आंतरिक प्रलेखन के लिए सबसे अच्छा तरीका है (बशर्ते कि आप अपने विश्लेषकों को reStructuredText लिखने के लिए प्राप्त कर सकते हैं):

1. आप दस्तावेज़ों को आसानी से नियंत्रित कर सकते हैं (और पाठ फ़ाइलों के अंतर बहुत अधिक ले सकते हैं, बाइनरी फ़ाइलों जैसे .doc या .pdf से बहुत कम जगह)।
2. यदि कोई डेवलपर एक अच्छा पठनीय .doc या .pdf फ़ाइल चाहता है, तो वह इसे स्रोत से स्फिंक्स के साथ बना सकता है।

यदि स्फिंक्स बहुत जटिल है, तो एक आसान तरीका भी है: आप मार्कडाउन में अपने दस्तावेज लिख सकते हैं और पंडोक का उपयोग कर सकते हैं (उदाहरण के लिए) .rtf, .doc या .pdf फाइलें (यह बहुत अधिक कर सकता है)।
मैंने पंडोक को स्फिंक्स की तुलना में आरंभ करना आसान पाया, लेकिन पंडोक स्फिंक्स (जैसे पायथन और टॉर्टोइज़एचजी प्रलेखन मैं ऊपर लिंक किया गया) की तरह अच्छा मेनू पदानुक्रम नहीं बना सकता।

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

Comments

ऐसा लगता है कि यह सिर्फ HTML उत्पन्न करता है तो मुझे इसे एक वेब सर्वर पर प्रकाशित करना होगा

— एलेक्स बर्टसेव

@AlexBurtsev: यदि आप चाहते हैं कि यह सार्वजनिक हो, तो हाँ। दूसरी ओर - अब आप Word .doc फ़ाइलों का उपयोग कर रहे हैं, इसलिए आपको इन्हें वेब सर्वर पर रखना होगा और यदि आप इन्हें सार्वजनिक करना चाहते हैं।

— क्रिश्चियन स्पैच

मैं ध्यान देता हूं कि स्फिंक्स में "पीडीएफ आउटपुट" पथ है।

— रॉबर्ट हार्वे

@ChristianSpecht, Wiki और Wordpress में Word Doc फ़ाइलों को आयात करने के लिए प्लगइन्स हैं।

— एलेक्स बर्टसेव

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

— क्रिश्चियन स्पेट

Answer 2

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

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

Comments

हमारे पास पहले से ही SharePoint सर्वर है, लेकिन डेवलपर्स इसे पसंद नहीं करते हैं, और इसका उपयोग नहीं करना चाहते हैं (मैं खुद डेवलपर हूं)। हम ऐसा कुछ चाहते हैं जहाँ हम आसानी से अपनी जरूरत की जानकारी पा सकें। जानकारी जो वर्गीकृत और जुड़ी हुई है।

— एलेक्स बर्टसेव

@AlexBurtsev: मैंने कभी भी Sharepoint सर्वर का उपयोग नहीं किया है, लेकिन मैं इस धारणा के तहत था कि Sharepoint उन सभी सुविधाओं को प्रदान कर रहा है जो आप वर्णन कर रहे थे। लेकिन अगर आप एक विकी को पसंद करते हैं, तो आपके लिए Mediawiki ठीक रहेगा। हालांकि, आप इसे स्थापित करने के लिए कुछ प्रारंभिक प्रयास करेंगे, कुछ संरचना रूपरेखा को परिभाषित करेंगे, और कुछ सम्मेलनों को परिभाषित भी करेंगे कि इसका उपयोग कैसे करें / उपयोग न करें।

— डॉक्टर ब्राउन

मैं वर्तमान में अपने एमएस ऑफिस एकीकरण के लिए XWiki की कोशिश कर रहा हूं

— एलेक्स बर्टसेव

@DocBrown - SharePoint भयानक है। यह unintuitive है, टैब और उप-टैब का एक पूर्ण चक्रव्यूह, और कोई उचित संस्करण नियंत्रण नहीं रखता है। इसका उपयोग करने वाला कोई भी व्यक्ति अपने सभी डॉक्स को आंतरिक सर्वर पर एक साझा निर्देशिका में डंप करने से बेहतर होगा। एक विकी आमतौर पर इस तरह की चीज के लिए जाने का तरीका है।

— बहुपत्नी

Answer 3

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

1. Trac - बग-ट्रैकिंग सिस्टम और नॉलेज इंजन का उपयोग करना आसान है। पाइथन और एक्स्टेंसिबल में लिखा गया है, आप कुछ ही मिनटों में उठेंगे और चलेंगे
2. मोइनमॉइन - पूर्ण रूप से विकी इंजन। फिर ढेर सारे फीचर्स के साथ पाइथन

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

Answer 4

हमने हाल ही में अल्फ्रेस्को डीएमएस का उपयोग करना शुरू किया है जिसमें बहुत सारे रोचक गुण हैं:

• बहुत सरल स्थापित करें
• दस्तावेजों के ढेर के माध्यम से त्वरित खोज के लिए एक अंतर्निहित अनुक्रमणिका है
• कार्य-प्रवाह, समूहों और यदि आवश्यक हो, ग्राहकों द्वारा दस्तावेजों तक विशिष्ट पहुंच की अनुमति देता है
• खुला स्त्रोत
• सक्रिय समुदाय
• LDAP / AD / SSO एकीकरण
• कई अलग-अलग दस्तावेज़ों को संभालता है

इसके कुछ नुकसान भी हैं:

• उपयोगकर्ता इंटरफ़ेस हमेशा सहज नहीं है
• यह वास्तव में विकी नहीं है, इसलिए एक दस्तावेज़ पर एक साथ सहयोगात्मक कार्य थोड़ा नाजुक हो सकता है

यदि आप इसे स्विंग देने का निर्णय लेते हैं, तो कृपया अपनी राय के साथ मुझसे संपर्क करें।

Answer 5

एक और संभावना का उपयोग हो सकता है LaTeX या कुछ अन्य पाठ formater (शायद texinfo या यहाँ तक कि गंवार ) प्रलेखन के लिए। इसके कुछ हिस्सों को मशीन जनरेट किया जा सकता है। HTML रूपांतरण के लिए कुछ उपकरण हैं, जैसे कि LaTeX को HTML में परिवर्तित करने के लिए HeVeA । आप अपने स्रोत कोड के अंदर संरचित टिप्पणियों से प्रलेखन उत्पन्न करने के लिए doxygen का उपयोग कर सकते हैं । और प्रलेखन के हाथ से लिखे गए भागों को स्रोत कोड (जैसे कि संस्करण नियंत्रण और निर्माण) के रूप में प्रबंधित किया जा सकता है (और होना चाहिए)।

Comments

मैं सॉफ्टवेयर उत्पाद प्रलेखन (सहायता, मैनुअल) के बारे में बात नहीं कर रहा हूँ। मैं सॉफ्टवेयर विनिर्देश, व्यावसायिक आवश्यकताओं के बारे में बात कर रहा हूँ।

— एलेक्स बर्टसेव

आप LaTeX में सॉफ़्टवेयर विनिर्देश या कोई भी तकनीकी दस्तावेज़ लिख सकते हैं, और कुछ हलकों में यह आम बात है।

— बेसिल स्टारीनेविच

LaText किसी तरह मुझे * NIX की याद दिलाता है, और हमारे विश्लेषक ऐसे OS का झुंड कभी नहीं -), वे विंडोज दुनिया में रहते हैं, और उस चीज़ पर सहमत नहीं होंगे जो पाठ इनपुट के लिए वर्ड से कठिन है।

— एलेक्स बर्टसेव

Answer 6

मैं आपके दस्तावेजों के अलावा, एक यूएमएल और ईआरडी उपकरण का उपयोग करने का सुझाव दूंगा। इसके अलावा, आप इन दस्तावेजों को ZOHO पर ZOHO-Docs पर संग्रहीत कर सकते हैं , जो मुफ़्त नहीं है, लेकिन यह बेहद सस्ता है और दस्तावेज़ खोज सुविधाओं की अनुमति देता है।

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