8
अंतिम उपयोगकर्ताओं के लिए क्रॉस-प्लेटफ़ॉर्म सहायता फ़ाइलों को बनाने के लिए कुछ अच्छे संलेखन टूल क्या हैं? (हमारा आवेदन क्यूटी फ्रेमवर्क का उपयोग कर रहा है, अगर इससे कोई फर्क पड़ता है।)क्रॉस-प्लेटफार्म एंड-यूजर-हेल्प ऑथरिंग टूल्स
नोट: मुझे आंतरिक एपीआई दस्तावेज़ों में कोई दिलचस्पी नहीं है - हम इसके लिए doxygen का उपयोग कर रहे हैं।
आदर्श रूप में, एक समाधान होगा:
- हमें एक ही स्थान में सभी मदद सामग्री (पाठ, सामग्री, छवियों, आदि की तालिका) का प्रबंधन करने की अनुमति दें।
- देशी सहायता प्रारूपों के लिए आउटपुट। (विंडोज़ के लिए सीएचएम - या कम से कम कुछ हम सीधे एचटीएमएल हेल्प एपीआई में फ़ीड कर सकते हैं; सुनिश्चित नहीं हैं कि अन्य प्लेटफ़ॉर्म 'मानक "सहायता प्रारूप क्या हैं।)
- डीसेंट WYSIWYG समर्थन: सामान्य टेक्स्ट प्रविष्टि, छवियों, क्रॉस- संदर्भ, इत्यादि आसानी से, लेकिन जब हमें आवश्यकता हो तो हम HTML को संपादित कर सकते हैं।
- सहायता प्रोजेक्ट (एक्सएमएल, इत्यादि) के लिए टेक्स्ट-आधारित फ़ाइल-प्रारूप ताकि इसे सबवर्जन में संस्करणित किया जा सके।
- कोई भी हुक जो इसे वास्तविक कोड बेस के साथ समन्वयित रखने में मदद करता है, वह बहुत अच्छा होगा। (शायद किसी भी तरह से एक मदद विषय कोड फ़ाइल से जुड़ा हुआ है, और यह देखने के लिए सबवर्सन जांच सकता है कि क्या कोई बदलाव किया गया है और "संभवतः पुरानी तारीख" के रूप में एक विषय को ध्वजांकित करें ... क्या मैं सपना देख रहा हूं?)
- सहायता सामग्री स्थानीयकृत किया जाना चाहिए।
- व्यावसायिक उत्पाद का विरोध नहीं है, लेकिन एक नि: शुल्क विकल्प अच्छा होगा।
मैं आगे बढ़ूंगा और इसे विकी बनाउंगा और कुछ उदाहरणों से शुरू करूंगा। यदि आप उनके साथ अनुभव करते हैं, तो कुछ ऊपर छोड़ दें और कुछ टिप्पणियां छोड़ दें। अतिरिक्त उपकरण भी जोड़ें।
मुझे सहायता और मैनुअल के साथ बहुत अच्छे अनुभव हुए हैं –