उपयोगकर्ता मैनुअल कैसे बनाएं

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

सामग्री

चरणों

भाग 1उपयुक्त उपयोगकर्ता दस्तावेज बनाना
भाग 2उपयोगकर्ता मैनुअल के घटकों
भाग 3एक पठनीय पुस्तिका तैयार करना

युक्तियाँ
आवश्यक सामग्री
सूत्रों और कोटेशन

चरणों

भाग 1
उपयुक्त उपयोगकर्ता दस्तावेज बनाना

एक उपयोगकर्ता मैनुअल चरण 1 बनाएँ शीर्षक वाला चित्र

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

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

एक उपयोगकर्ता मैनुअल चरण 2 बनाएं शीर्षक वाला चित्र

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

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

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 3

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

यदि समस्या जटिल है, तो उसे छोटे भागों में विभाजित करें। अनुक्रम में सूची निर्देश और समाधान सूचीबद्ध करें इस तरह से सूचनाओं को विभाजित करना एक विधि है जिसे "विखंडन" कहा जाता है।

भाग 2
उपयोगकर्ता मैनुअल के घटकों

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाना चरण 4

कवर कला और शीर्षक पृष्ठ शामिल करें आपको एक साधारण संदर्भ कार्ड के अलावा किसी भी मैनुअल के लिए एक आवरण की आवश्यकता होगी और किसी भी मैनुअल के लिए एक शीर्षक पृष्ठ है जो कागज के एक से अधिक शीट पत्रक है।

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

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 5

प्रस्तावना में संबंधित दस्तावेजों के संदर्भ डालें यदि दस्तावेज़ केवल मैन्युअल नहीं है, तो उन दस्तावेज़ों का संदर्भ लें जिनमें वर्तमान संस्करण मौजूद हैं आप प्रस्तावना में एक है, अगर "इस गाइड का उपयोग कैसे करें" अनुभाग भी दर्ज करेंगे

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 6

एक सूचकांक शामिल करें यदि मैनुअल में 10 से अधिक पृष्ठ हैं

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 7

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

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

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 8

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

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

भाग 3
एक पठनीय पुस्तिका तैयार करना

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 9

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

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

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 10

पृष्ठ के लेआउट के बारे में सोचो फोंट चुनने के बाद, आपको पेज पर चलने वाली हर चीज़ का लेआउट चुनना होगा।

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

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 11

बाइंडिंग के प्रकार पर विचार करें। यदि मैनुअल में चार से अधिक पृष्ठ हैं, तो उन्हें किसी तरह से सुरक्षित होना चाहिए। पृष्ठों के ऊपरी बाएं कोने में आंतरिक दस्तावेजों का स्टेपल किया जा सकता है, लेकिन उत्पादों के साथ भेजे जाने वाले मैनुअल आमतौर पर नीचे दिए गए तीन तरीकों में से एक हैं:

साइड स्टैपल 21 x 27.5 सेमी, 21 x 35 सेमी, या 27.5 x 42.5 सेमी शीट से बना मैनुअल के लिए उपयुक्त है। 48 पृष्ठों या उससे कम के सबसे सस्ता सामग्री इतने स्टैपल हैं।
नॉन-ऑटोमोटिव उत्पादों के साथ भेजे जाने वाले मैनुअल के मुकाबले तीसरे पक्ष के संदर्भ गाइडों के लिए टक्कर स्टैपल अधिक आम है, भले ही अब तक मैनुअल इस तरह से बाध्य होते हैं। (पेंट शॉप प्रो को स्पाइन-स्टैप्ड गाइड के साथ बेचा गया था जब इसे जेएएससी सॉफ्टवेयर द्वारा बनाया गया था।)
सर्पिल उन मार्गदर्शकों के लिए उपयुक्त है, जिनका उपयोग सड़क पर किया जाना चाहिए, जहां अन्य बाइंडिंग बहुत कमजोर हो सकती है। इनमें से कुछ मैनुअल पानी या पृथ्वी के नुकसान को रोकने के लिए पृष्ठों टुकड़े टुकड़े में है।

चित्र शीर्षक एक उपयोगकर्ता मैनुअल बनाएँ चरण 12

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

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

युक्तियाँ

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