हालाँकि कई कंप्यूटर उपयोगकर्ताओं द्वारा अक्सर इसे नज़रअंदाज़ किया जाता है, मदद फ़ाइलें इस बारे में महत्वपूर्ण जानकारी प्रदान करती हैं कि वे जिस सॉफ़्टवेयर एप्लिकेशन से जुड़े हैं, उसका उपयोग कैसे करें। "सहायता" पर क्लिक करके, उपयोगकर्ता प्रोग्राम की विशेषताओं का अवलोकन प्राप्त कर सकता है, स्क्रीन का विवरण जो वह देख रहा है, किसी दिए गए कार्य को करने के लिए प्रोग्राम का उपयोग कैसे करें या इसके बारे में अक्सर पूछे जाने वाले प्रश्नों की सूची पढ़ें। कार्यक्रम और उनके उत्तर। सहायता फ़ाइल लिखने के लिए सॉफ़्टवेयर अनुप्रयोगों के साथ काम करने की क्षमता और उपयोगकर्ताओं को समझने के तरीके में चीजों को समझाने की क्षमता दोनों की आवश्यकता होती है।
कदम
चरण 1. उस सॉफ़्टवेयर की एक प्रति प्राप्त करें जिसे आप दस्तावेज़ में रखना चाहते हैं।
यदि संभव हो, तो आपको प्रोग्राम के लिए लिखित विनिर्देशों की एक प्रति भी प्राप्त करनी चाहिए, हालांकि सभी सॉफ़्टवेयर डेवलपर उनके साथ काम नहीं करते हैं। कुछ मामलों में, प्रोग्रामर छोटे विकास समय के आधार पर या किसी विशेष सुविधा को कोड करने में सक्षम नहीं होने के आधार पर ऐनक से विचलित हो जाएगा।
चरण 2. एक सहायता संलेखन उपकरण प्राप्त करें।
जबकि एक रिच-टेक्स्ट-फॉर्मेट (.rtf) फ़ाइल का उपयोग करके हाथ से एक सहायता फ़ाइल बनाना संभव है, अधिकांश सहायता फ़ाइल लेखक अपनी सहायता फ़ाइलों को लिखने के लिए एक सॉफ़्टवेयर एप्लिकेशन का उपयोग करते हैं, जैसे कि रोबो हेल्प, हेल्प और मैनुअल, डॉक-टू -हेल्प, मैडकैप फ्लेयर या हेल्पलॉगिक्स। अधिकांश सहायता संलेखन टूल में टेक्स्ट एडिटर शामिल होता है या माइक्रोसॉफ्ट वर्ड जैसे वर्ड-प्रोसेसिंग प्रोग्राम के साथ काम करता है और एक यूजर इंटरफेस प्रदान करता है जो सहायता लेखक को यह देखने देता है कि सहायता फ़ाइल कैसी दिखेगी क्योंकि वह पर्दे के पीछे कंप्यूटर कोड लिखते समय इसे लिख रहा है। मदद फ़ाइल को काम करने के लिए। सहायता फ़ाइल में शामिल करने के लिए स्क्रीनशॉट बनाने के लिए कुछ सहायता संलेखन टूल में ग्राफ़िक्स संपादक भी शामिल हैं।
कई सहायता फ़ाइल स्वरूप हैं: सबसे आम HTML सहायता है, जिसका उपयोग विंडोज़ में चलने वाले अनुप्रयोगों द्वारा किया जाता है। (एक पुराना प्रारूप, विनहेल्प, अब समर्थित नहीं है।) ऐप्पल और यूनिक्स प्रत्येक के अपने प्रारूप हैं, साथ ही सन माइक्रोसिस्टम्स के जावाहेल्प के साथ भी। कई ऑपरेटिंग सिस्टम के तहत चलने के लिए डिज़ाइन किए गए सॉफ़्टवेयर एप्लिकेशन क्रॉस-प्लेटफ़ॉर्म सहायता सिस्टम का उपयोग कर सकते हैं जो उपयोगकर्ता के वेब ब्राउज़र में चलता है। आप जिस भी मदद संलेखन उपकरण का उपयोग करते हैं, उसे उस सहायता प्रारूप का समर्थन करना चाहिए जिसमें आप सहायता फ़ाइलें बनाने जा रहे हैं।
चरण 3. सहायता प्रोजेक्ट फ़ाइल बनाएँ।
आपका सहायता संलेखन उपकरण आपके द्वारा प्रदान किए गए फ़ाइल नाम और अन्य जानकारी के आधार पर आपके लिए एक सहायता प्रोजेक्ट फ़ाइल तैयार करेगा। मुख्य प्रोजेक्ट फ़ाइल में अन्य फ़ाइलों के बारे में जानकारी होती है, जिसमें एक सामग्री फ़ाइल, एक अनुक्रमणिका फ़ाइल, एक या अधिक छवि फ़ाइलें और अन्य फ़ाइलें शामिल होती हैं।
- सामग्री फ़ाइल में सहायता फ़ाइल का पाठ शामिल है जो बताता है कि जिस सॉफ़्टवेयर एप्लिकेशन का आप दस्तावेज़ीकरण कर रहे हैं वह कैसे काम करता है। टेक्स्ट को आमतौर पर उन विषयों में विभाजित किया जाता है जो एक विशिष्ट स्क्रीन, फीचर या प्रक्रिया को कवर करते हैं।
- अनुक्रमणिका फ़ाइल मदद फ़ाइल के विषयों की एक सूची है। इसका उपयोग सामग्री की एक तालिका बनाने के लिए किया जाता है जिसका उपयोग उपयोगकर्ता देखने के लिए एक विषय का चयन करने के लिए कर सकते हैं, साथ ही सहायता फ़ाइल के भीतर एक खोज योग्य अनुक्रमणिका भी बना सकते हैं।
- छवि फाइलें प्रोग्राम स्क्रीन की ग्राफिक फाइलें या उन स्क्रीन के हिस्से हैं जो हेल्प फाइल के भीतर प्रदर्शित होती हैं ताकि उपयोगकर्ताओं की यह समझने की क्षमता को बढ़ाया जा सके कि हेल्प फाइल टेक्स्ट क्या संदर्भित कर रहा है।
चरण 4. सहायता विंडो का आकार समायोजित करें।
जब तक आप उपयोगकर्ता के वेब ब्राउज़र में प्रदर्शित होने के लिए सहायता फ़ाइल नहीं लिख रहे हैं, तब तक सहायता फ़ाइल अपनी विंडो में दिखाई देगी। आपका सहायता संलेखन उपकरण आपको विंडो के क्षैतिज और लंबवत आयामों को एक आकार में समायोजित करने देगा जो अंतिम उपयोगकर्ता को एप्लिकेशन के रास्ते में आए बिना सहायता फ़ाइल को पढ़ने देगा। मुख्य सहायता विंडो अक्सर त्रि-फलक प्रारूप में होती है, जिसमें बाईं ओर सामग्री की तालिका और दाईं ओर चयनित विषय होता है।
सहायता फ़ाइलों में मुख्य विंडो के अलावा, द्वितीयक विंडो भी हो सकती हैं जो किसी विशेष सुविधा का विस्तार से वर्णन करती हैं और स्वचालित रूप से पॉप-अप विंडो को आकार देती हैं जो सुविधाओं का संक्षिप्त विवरण देती हैं। सहायता फ़ाइलों में एम्बेडेड टेक्स्ट भी शामिल हो सकता है जो केवल हाइलाइट किए गए टेक्स्ट या बटन पर क्लिक करने पर दिखाई देता है।
चरण 5. सहायता विषय लिखें।
ऐसा करने के लिए, आपको कार्यक्रम की स्क्रीन और सुविधाओं को दस्तावेज करने के लिए विषय बनाने के लिए विनिर्देशों या कार्यक्रम की समीक्षा करने की आवश्यकता होगी। जैसे ही आप प्रत्येक विषय बनाते हैं, आपका सहायता संलेखन उपकरण इसे सहायता फ़ाइल की सामग्री तालिका और अनुक्रमणिका में जोड़ देगा।
- जब आप सामग्री तालिका का निर्माण कर सकते हैं, तो इसे कैसे व्यवस्थित किया जाए, इसके लिए कुछ योजना बनाने में मदद मिलती है। आप कार्यक्रम की स्क्रीन, इसकी विशेषताओं, इसका उपयोग करने के तरीके या इसके कुछ संयोजन के आसपास सामग्री की तालिका को व्यवस्थित कर सकते हैं।
- जब आप विषय लिखते हैं, तो सहायता फ़ाइल में अन्य जानकारी पर विचार करें, जिस तक उपयोगकर्ता त्वरित पहुँच प्राप्त करना चाहेंगे। आप मदद फ़ाइल टेक्स्ट में जम्प या हाइपरलिंक बना सकते हैं जो उन विषयों से जुड़ते हैं जिनमें वह जानकारी होती है।
चरण 6. यदि आवश्यक हो तो स्क्रीनशॉट शामिल करें।
कई प्रोग्राम सुविधाओं को टेक्स्ट और ग्राफिक्स के संयोजन के साथ सबसे अच्छी तरह समझाया गया है। आप या तो उस एप्लिकेशन के साथ स्क्रीनशॉट बना सकते हैं जो आपके सहायता ऑथरिंग टूल के साथ आता है या एक अलग एप्लिकेशन, जैसे कि Microsoft पेंट, पेंट शॉप प्रो या SnagIt के साथ।
- टेक्स्ट और स्क्रीनशॉट को एक विषय में एक साथ रखा जाना चाहिए ताकि उपयोगकर्ता स्क्रीनशॉट और उसके सहायक टेक्स्ट को बिना अनुचित स्क्रॉल किए देख सकें। कई मामलों में, आपको संपूर्ण स्क्रीन के बजाय प्रोग्राम स्क्रीन का एक भाग दिखाना होगा, या स्क्रीनशॉट को मूल स्क्रीन से छोटे आकार में दिखाना होगा। आपका स्क्रीनशॉट एप्लिकेशन बिना किसी धुंधलापन या विवरण के नुकसान के स्क्रीनशॉट का आकार बदलने में सक्षम होना चाहिए।
- यदि आप परीक्षण और कार्यक्रम के अंतिम संस्करणों के बीच उपयोगकर्ता इंटरफ़ेस में परिवर्तन की आशा करते हैं, तो आप तब तक स्क्रीनशॉट बनाना बंद कर सकते हैं जब तक आपके पास काम करने के लिए कार्यक्रम का अंतिम संस्करण न हो।
चरण 7. यदि आवश्यक हो तो एक मानचित्र फ़ाइल बनाएँ।
कुछ प्रोग्रामों में "सहायता" बटन शामिल होते हैं जो उपयोगकर्ता को मदद फ़ाइल में विषय पर क्लिक करने और प्रदर्शित करने के लिए होते हैं जो विशेष रूप से वर्णन करता है कि स्क्रीन कैसे काम करती है। किसी विषय को इस तरह प्रदर्शित करना संदर्भ-संवेदनशील सहायता कहलाता है और प्रोग्रामर के लिए आपकी सहायता फ़ाइल में विशिष्ट विषय से "सहायता" बटन को लिंक करने के लिए एक मानचित्र फ़ाइल बनाने की आवश्यकता होती है। आपका सहायता संलेखन उपकरण आपके लिए एक बना सकता है, या प्रोग्रामर इसे कोड कर सकता है और आपको सहायता फ़ाइल में शामिल करने के लिए दे सकता है।
चरण 8. सहायता फ़ाइल संकलित करें।
संकलन वास्तविक सहायता फ़ाइल बनाता है जिसे प्रोग्राम के साथ शामिल किया जाएगा। अधिकांश सहायता स्वरूपों के लिए, इसमें वे सभी घटक फ़ाइलें शामिल होंगी जो आपके द्वारा सहायता फ़ाइल बनाते समय बनाई गई थीं, हालांकि कुछ असंकलित सहायता स्वरूपों को भी कार्यक्रम के साथ व्यक्तिगत सहायता विषय फ़ाइलों को शामिल करने की आवश्यकता होती है।
चरण 9. सहायता फ़ाइल का परीक्षण करें।
एक बार जब आप सहायता फ़ाइल संकलित कर लेते हैं, तो आपको यह सुनिश्चित करने के लिए इसका परीक्षण करने की आवश्यकता होती है कि सभी हाइपरलिंक उन विषयों से जुड़ते हैं जिनसे उन्हें अपेक्षित है और सभी ग्राफिक्स सही ढंग से प्रदर्शित होते हैं। यह सुनिश्चित करने के लिए सहायता फ़ाइल का भी परीक्षण करने की आवश्यकता है कि सामग्री सटीक और उपयोगकर्ताओं के लिए उपयुक्त है और एक सुसंगत प्रारूप में है। आप स्वयं सहायता फ़ाइल की समीक्षा करना चाहेंगे और आवेदन का परीक्षण करने वाले लोगों से भी इसकी समीक्षा करवाएंगे।
बड़ी सहायता फ़ाइल परियोजनाओं पर, संकलन और परीक्षण चल रही प्रक्रियाएं हैं। आप अंतिम संस्करण बनाने से पहले सहायता फ़ाइल को संकलित करना और अपने काम को कई बार जांचना चाहेंगे।
चरण 10. प्रोग्राम के साथ शामिल करने के लिए डेवलपर को सहायता फ़ाइल दें।
प्रोजेक्ट प्रकृति और सहायता फ़ाइल स्वरूप के आधार पर, यदि संदर्भ-संवेदनशील विषय हैं, तो आपको डेवलपर को कई फ़ाइलें प्रदान करनी पड़ सकती हैं, जिसमें मानचित्र फ़ाइल भी शामिल है।
