Dr.Explain में हेल्प सिस्टम या यूजर गाइड बनाना

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



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

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

डॉ। एक्सप्लेन बनाम मदद और मैनुअल

तो, Dr.Explain आपको एप्लिकेशन के साथ वितरण के लिए CHM प्रारूप में मदद फ़ाइल बनाने, उत्पाद वेबसाइट पर पोस्ट करने के लिए HTML में मदद प्रणाली, साथ ही साथ RTF में उपयोगकर्ता मैनुअल और सामग्री और लिंक के साथ पीडीएफ में अनुमति देता है। एक ही स्रोत से विभिन्न स्वरूपों में सहायता प्रणाली उत्पन्न होती है, जो आपको सॉफ़्टवेयर के नए संस्करण जारी होने पर दस्तावेज़ को जल्दी से अपडेट करने की अनुमति देती है। इस संबंध में, डॉ। एक्सप्लेन हेल्प और मैनुअल से अलग नहीं है, जिसका मैं लंबे समय से उपयोग कर रहा हूं।

इंटरफ़ेस में दो क्षेत्र होते हैं। पहला प्रोजेक्ट कंटेंट के ट्री स्ट्रक्चर के साथ एक नेविगेशन बार है। और दूसरा पेज एडिटर है।



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

के तुलना करते हैं:



चित्र 1. डॉ। एक्सप्लेन टूलबार



चित्रा 2. सहायता और मैनुअल टूलबार

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

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

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

कुछ और ...

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



कार्यक्रम में अनुप्रयोग (एफ 1) में सीधे संदर्भ-संवेदनशील मदद को एकीकृत करने की क्षमता भी है, नेविगेशन ट्री को नियंत्रित करता है, डिजाइन टेम्प्लेट का एक सेट, सीएसएस समर्थन, जल्दी से प्रलेखन को अद्यतन करने की क्षमता जब कार्यक्रम का एक नया संस्करण चित्रण की जगह जारी किया जाता है, लेकिन सार, एनोटेशन, विवरण के संरक्षण के साथ; प्रोग्रामिंग (PHP, ASP) या सर्वर-साइड डेटाबेस के बिना ऑनलाइन मदद में खोज और अनुक्रमण समारोह।

सारांश

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