कोई भी आविष्कारक, प्रोग्रामर या तर्कवादी कितना भी सरल क्यों न हो, कभी-कभी उसकी रचनाओं का उपयोग उनके इच्छित उद्देश्य के लिए नहीं किया जा सकता है। इसका कारण गलत तरीके से तैयार की गई निर्देश पुस्तिका या इसकी पूर्ण अनुपस्थिति है। लेकिन सरल आविष्कारक भी कभी-कभी ऐसे निर्देश लिखते हैं कि संकीर्ण विशेषज्ञों के अलावा कोई भी इन पत्रों को नहीं पढ़ सकता है। तो आप इस तरह के एक आवश्यक दस्तावेज को ठीक से कैसे तैयार करते हैं?
यह आवश्यक है
- - उस उपकरण या सॉफ़्टवेयर उत्पाद का शत-प्रतिशत ज्ञान जिसके लिए मैनुअल लिखा जा रहा है;
- - भाषा विज्ञान के क्षेत्र में ज्ञान;
- - लेखन कौशल।
अनुदेश
चरण 1
एक उपयोगकर्ता मैनुअल या, दूसरे शब्दों में, एक ऑपरेशन मैनुअल एक दस्तावेज है जिसे अपने उपयोगकर्ताओं को एक निश्चित प्रणाली का उपयोग करने में सहायता प्रदान करने के लिए डिज़ाइन किया गया है। एक उपयोगकर्ता पुस्तिका को संकलित करने के लिए, आपको वर्णित प्रणाली को एक सौ प्रतिशत जानने की जरूरत है, लेकिन इसे एक अज्ञानी छात्र की आंखों से देखें। मान लीजिए कि एक उपयोगकर्ता पुस्तिका एक सॉफ्टवेयर उपयोगिता के लिए लिखी गई है जिसका अभी तक कोई एनालॉग नहीं है। कल्पना कीजिए कि आप पहली बार इस कार्यक्रम का उपयोग कर रहे हैं। आप कहाँ से शुरू करते हैं? जानने वाली पहली बात क्या है? इस ज्ञान को महत्व की श्रेणियों में व्यवस्थित करें।
चरण दो
अपनी रचना से संबंधित सभी सूचनाओं को समूहों में विभाजित करके, आपने एक उपयोगकर्ता पुस्तिका लिखने की योजना तैयार की है। अपने कार्यक्रम में काम का वर्णन बिल्कुल नए सिरे से करना शुरू करें, अंतिम सबसे कठिन विवरणों को छोड़कर, जैसे कि रीप्रोग्रामिंग सुविधाएँ या महत्वपूर्ण त्रुटियों से निपटना। इस स्तर पर, आपके पास उपयोगकर्ता पुस्तिका की सामग्री तैयार होनी चाहिए - इस दस्तावेज़ के आवश्यक भागों में से एक।
चरण 3
यदि आप जो मैनुअल बना रहे हैं वह किसी बड़ी कंपनी में उपयोग के लिए है, तो आपको वहां अपनाए गए कॉर्पोरेट मानकों पर ध्यान देना चाहिए। उदाहरण के लिए, कई रूसी कंपनियों में, उपयोगकर्ता मैनुअल को बिना उदाहरण समर्थन के स्वीकार नहीं किया जाता है, दूसरे शब्दों में, चित्र जो लिखा गया है उसे समझाते हैं। सामग्री के अलावा, उपयोगकर्ता मैनुअल में अन्य अनिवार्य भाग होने चाहिए: - एनोटेशन, यानी मैनुअल और वर्णित उत्पाद के सामान्य उद्देश्यों की व्याख्या; - एक परिचय, जो उपयोगकर्ता मैनुअल से संबंधित दस्तावेजों का वर्णन करता है और कैसे मैनुअल का उपयोग करने के लिए; - इसके उपयोग के विभिन्न चरणों में उत्पाद के उपयोग की व्याख्या करने वाले खंड, उदाहरण के लिए, पहला कदम, मरम्मत या रखरखाव; - अक्सर पूछे जाने वाले प्रश्नों और उनके उत्तर का अनुभाग; - शब्दावली या विषय सूचकांक।
चरण 4
आमतौर पर, एक तकनीकी लेखक एक उपयोगकर्ता पुस्तिका के निर्माण में शामिल होता है - एक ऐसा व्यक्ति जिसके पास भाषा और वर्णित उत्पाद दोनों में सभी आवश्यक ज्ञान होते हैं। बिना प्रशिक्षण के एक तकनीकी लेखक के रूप में, कुछ नियमों को ध्यान में रखना चाहिए। सबसे पहले, आपको उन विशेष शर्तों का दुरुपयोग नहीं करना चाहिए जो एक सामान्य उपयोगकर्ता के लिए समझ में नहीं आती हैं। दूसरे, इस्तेमाल किए गए प्रत्येक शब्द को विस्तृत और समझाया जाना चाहिए। तीसरा, आपको यथासंभव स्पष्ट और संक्षिप्त रूप से लिखने की आवश्यकता है। अंत में, एक तकनीकी लेखक को अपने स्वयं के पाठ की कमियों को देखने के लिए एक सामान्य उपयोगकर्ता की आँखों से अपने स्वयं के पाठ को देखने में सक्षम होना चाहिए।
चरण 5
उपयोगकर्ता मैनुअल के तैयार पाठ को व्यवहार में किसी ऐसे व्यक्ति को पेश करके परीक्षण करना अच्छा होता है, जिसका वर्णित उत्पाद से कोई लेना-देना नहीं था। संयुक्त प्रयासों से दस्तावेज़ की सभी कमियों और कमियों को दूर करना संभव है।
