उपयोगकर्ता मैनुअल लिखने के लिए आपकी टीम किस टूल का उपयोग करती है?

Question

बेसिक अनुरोध कर रहे हैं:

• मानव पठनीय/पाठ स्वरूप (आसान संस्करण नियंत्रण के लिए)
• ऑनलाइन (सहयोग के लिए)
• आसान स्वरूपण (markdown ठीक है, एचटीएमएल बहुत ज्यादा है)
• सख्त स्वरूपण (ताकि लेखकों खिताब के नए प्रकार का आविष्कार नहीं है, गोलियों आदि)
• पीडीएफ के लिए निर्यात, एचटीएमएल
• आसान बैकअप और तैनाती (ताकि हम ग "तैनात" कर सकते हैं रूप ustomers साइट केवल संस्करण)

हम विकि इंजन किसी तरह का उपयोग करने के बारे में सोच रहे हैं, लेकिन यह भंडारण के लिए फ़ाइलों का उपयोग या ग्राहक के लिए "तैनाती" के अन्य साधन है और स्थापित करने के लिए आसान करने की आवश्यकता होगी पढ़ने/Maintan। इसके अलावा, यह नि: शुल्क/सस्ता होना चाहिए था (संगम तरह से भी महंगा है)

कोई सुझाव?

संपादित करें: मैं नहीं देख रहा हूँ उपकरण कोड दस्तावेज़ के लिए के लिए, हम उस सैंडकैसल का उपयोग कर कवर किया है।

Answer 1

हालांकि यह आपके सभी अनुरोधों का उत्तर नहीं दे सकता है, DokuWiki पर ध्यान देने योग्य हो सकता है।

अन्य विकियों के साथ के रूप में, यह एक simple syntax है, और track revisions के संस्करण नियंत्रण है, table of contents उत्पन्न करता है, और एक full-text search सुविधा है जो एक मदद प्रणाली के लिए काम आ सकते हैं।

आप यह देखने के लिए feature list का मूल्यांकन करना चाहते हैं कि यह आपकी आवश्यकताओं को पूरा करेगा या नहीं।

इसके अलावा, वहाँ भी एक अच्छा collection of avaialble plugins हो रहा है। हालांकि मैंने DokuWiki या उसके प्लगइन का उपयोग नहीं किया है, लेकिन PDF export के लिए भी प्लगइन उपलब्ध हैं।

Answer 2

हम मैनुअल और मदद फ़ाइल के लिए help and manual का उपयोग करें। कोई HTML निर्यात नहीं है, लेकिन यह एचटीएमएल सहायता, winhelp, पीडीएफ और कुछ और प्रारूप प्रदान करता है।

Answer 3

Dikiwiki

Answer 4

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

Answer 5

हमारे एपीआई के लिए, हम Doxygen का उपयोग करते हैं, जो कि बहुत अच्छा है।

Answer 6

हम एक विकी का उपयोग कर रहे हैं। मेरा सुझाव है MoinMoin क्योंकि

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

हम कुछ उपयोग नहीं कर रहे है क्योंकि:

• प्रलेखन बहुत तेजी से
• सभी दस्तावेजों सर्च कर रहे हैं है rots दर्द
• सूचना बिट्स के बीच लिंक करना दर्द है
• संस्करणों के बीच कोई अंतर
• बाइनरी स्वरूप है जो किसी भी VCS से बाहर
• कोई गहरी बुकमार्क
• दस्तावेज बहुत बड़ा हो जाना और फिर वे अनाड़ी बन नरक क्रेप्स: स्प्लिट (और कोई अब और खोज) या उम्र के इंतजार लोड करने के लिए ।

Answer 7

LaTeX

Answer 8

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

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

Answer 9

आप जिस भाषा/ढांचे का उपयोग कर रहे हैं उसका उल्लेख नहीं करते हैं। वहां वास्तव में अच्छे दस्तावेज उपकरण हैं, लेकिन उनमें से कुछ आप जो विकसित कर रहे हैं उसके लिए विशिष्ट हैं। हम एक सी # दुकान हैं, इसलिए मेरा उत्तर केवल तभी लागू होगा यदि आप .NET का उपयोग कर रहे हैं।

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

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

संपादित करें: फिक्स्ड टूटा हुआ लिंक, और यह भी उल्लेख करना चाहता था कि सैंडकैसल के साथ संयोजन में अन्य टूल्स हैं, जिनका हम उपयोग करते हैं। Sandcastle Help File Builder और GhostDoc जैसी चीज़ें सामान्य उपकरण हैं। सैंडकैसल परियोजनाओं और एमएएमएल को संपादित करने वाला पहला, और कोड में टिप्पणी गुणवत्ता में सुधार करने वाला दूसरा।

Answer 10

डौमेंट कोड के लिए मैं डॉक्सिजन का उपयोग करता हूं। मैं लिनक्स संस्करण पसंद करता हूं, मुझे विंडोज संस्करण

Answer 11

"मैनुअल", डॉकबुक के लिए कुछ विशेषताओं में समस्याएं थीं। यह तकनीकी दस्तावेज के लिए डिज़ाइन की गई एक एसजीएमएल बोली है। http://www.docbook.org/। यह आपके "आसान मार्कअप" मानदंड को पूरा नहीं कर सकता है, लेकिन यह निश्चित रूप से लाटेक्स (जिसे पीडीएफ में परिवर्तित किया जा सकता है) में अच्छा आउटपुट उत्पन्न करता है और यदि आप इसके लिए अपनी सीएसएस स्टाइलशीट पकाते हैं तो अच्छा HTML आउटपुट। संस्करण नियंत्रण में रखी पाठ फ़ाइलें।सभी प्रोग्राम एक लाइब्रेरी का भी उपयोग करते हैं जो प्रारूपों (सामान्य, मैन पेज और डॉकबुक) की पसंद में "--help" आउटपुट के साथ कमांड लाइन तर्क पार्सिंग को जोड़ता है। एपीआई संदर्भ के लिए, पाठ्यक्रम का डॉक्सिजन।

Answer 12

मेरे वर्तमान काम पर हम एकल उपयोग सॉफ्टवेयर निकाल देते हैं, इसलिए दस्तावेज़ अक्सर साइडलाइन पर डाल दिया जाता है और वर्ड में किया जाता है।

मेरी आखिरी नौकरी में, हालांकि, प्रलेखन टीम लगातार rant और mad cap software's product "Flare" के बारे में सोच रही थी। यह आपको एक प्रारूप में लिखने और कई माध्यमों को प्रकाशित करने की अनुमति देता है ताकि आपका मैनुअल आपकी ऑनलाइन सहायता या वेबसाइट आदि हो सके ...

Answer 13

मेरी कंपनी अधिकांश दस्तावेज़ीकरण के लिए मीडियाविकि और टिकीविकि का उपयोग करती है। हमारे पास एक ऐसा व्यक्ति भी है जो ग्राहकों को प्रिंट/भेजने के लिए एमएस वर्ड और पीडीएफ प्रारूपों में सामान संकलित करता है। मैं आपको प्लेगविकि को प्लेग की तरह टालने की सलाह दूंगा। MediaWiki बहुत बढ़िया है, क्योंकि यह उपयोग करना वास्तव में आसान है और क्योंकि हर कोई जानता है कि इसका उपयोग कैसे किया जाए - यह वास्तव में मानक विकी है, और योग्यता से, IMHO।

Answer 14

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

इसके अलावा, हम मीडियाविकि को समुदाय-आधारित सहायता के रूप में रख रहे हैं।

Answer 15

मैं Asciidoc के बारे में पर्याप्त अच्छी बातें नहीं कह सकता। इसमें एक बहुत ही सरल मार्कअप सिंटैक्स है, पीडीएफ से लेकर रफ, सब कुछ लागू करने के लिए पोर्टेबल और कुछ मामूली परिवर्तनों के साथ किसी भी विकी में आसानी से डाला जा सकता है।

यहां तक ​​कि इसके मार्कअप राज्य में, इसे पढ़ने के लिए बहुत आसान है। इसका उपयोग करते समय मुझे केवल एक चीज खराब करना है, लेकिन यह बहुत मुश्किल नहीं है।

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

कोड ड्यूमेंटेशन के लिए, मैं Doxygen का उपयोग करता हूं।

Answer 16

Pandoc विभिन्न मार्कअप प्रारूपों के बीच कनवर्ट करने के लिए एक शानदार उपकरण है। हम मार्कडाउन में दस्तावेज़ लिखते हैं और अन्य प्रारूपों में कनवर्ट करने के लिए पांडोक का उपयोग करते हैं।

pandoc साइट से:

आप दूसरे में एक मार्कअप प्रारूप से फाइल कन्वर्ट करने के लिए की जरूरत है, pandoc अपने स्विस सेना चाकू है। Pandoc markdown और (के सबसेट) reStructuredText, कपड़ा, एचटीएमएल, और LaTeX पढ़ सकते हैं, और यह लिख सकते हैं सादा पाठ, markdown, reStructuredText, एचटीएमएल, LaTeX, संदर्भ, पीडीएफ, rtf, DocBook एक्सएमएल, OpenDocument एक्सएमएल , ओडीटी, जीएनयू टेक्सिनोफो, मीडियाविकि मार्कअप, कपड़ा, ग्रॉफ मैन पेज, एमाक्स ऑर्ग-मोड, ईपीबीबी ईबुक, और एस 5 और स्लीडी एचटीएमएल स्लाइड शो। पीडीएफ आउटपुट (लाटेक्स के माध्यम से) भी शामिल मार्कडाउन 2 पीडीएफ रैपर स्क्रिप्ट के साथ समर्थित है।

Pandoc खुला स्रोत और hotness हास्केल है कि में लिखा जा रहा है के लिए अतिरिक्त अंक हो जाता है;)

Answer 17

Sphinx की कोशिश करो। सभी पायथन दस्तावेज इस उपकरण का उपयोग करके http://docs.python.org/