एक आईटी उत्पाद के लिए संदर्भ प्रलेखन विकसित करने का ताओ

नमस्ते!

क्या आप मदद पढ़ना पसंद करते हैं? और लिखना है? मुझे लगता है कि आप में से 99% लोग "NO" का जवाब देंगे।

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

इस लेख में, हम अपने अनुभव को साझा करना चाहते हैं और संदर्भ दस्तावेज बनाने की प्रक्रिया का वर्णन करते हैं जिसका उपयोग हम अल्कोनोस्ट में करते हैं ।

भूमिका

शुरुआत करने के लिए, आइए परियोजना में विशिष्ट भूमिकाओं को परिभाषित करें। आमतौर पर मदद बनाने में शामिल:

• डेवलपर (प्रोग्रामर या उत्पाद प्रबंधक);
• तकनीकी लेखक;
• प्रोजेक्ट मैनेजर।

यहां आप एक और संपादक, अनुवादक और डिजाइनर जोड़ सकते हैं।

आदर्श मामले में (बड़ी कंपनियों में) इन सभी भूमिकाओं को व्यक्तिगत कर्मचारियों द्वारा दर्शाया जाता है, लेकिन कठोर वास्तविकता में इन सभी टोपी को एक समय में एक व्यक्ति द्वारा पहना जा सकता है।

संदर्भ प्रलेखन पर काम के लिए (और यह न केवल निर्माण है, बल्कि आगे का समर्थन और विकास भी है) विकास प्रक्रिया को बाधित करने के लिए नहीं, डेवलपर और तकनीकी लेखक की भूमिकाओं को अलग किया जाना चाहिए।

सामी बनाम आउटसोर्सिंग

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

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

हमें सहायता उपकरणों का भी उल्लेख करना चाहिए। यह हमेशा एक डेवलपर के लिए संदर्भ प्रलेखन बनाने के लिए सॉफ्टवेयर सिस्टम खरीदने के लिए उचित नहीं है। यदि आपके पास एक छोटी सी उपयोगिता है, और केवल गेटिंग स्टार्ट की आवश्यकता है, तो महंगे सॉफ़्टवेयर की खरीद से परेशान न हों।

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

परिणाम आवश्यकताएँ

तो, बिंदु के करीब।

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

प्रक्रिया है

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

हेल्प डेस्क प्रोजेक्ट मैनेजर पूरी प्रक्रिया का "इंजन" है। उनके कार्यों में नियोजन, मध्यवर्ती परिणामों की निगरानी, ​​सभी परियोजना प्रतिभागियों के बीच संचार सुनिश्चित करना शामिल है।

1. संक्षिप्त

यहां तक ​​कि अगर आप स्वयं सहायता लिखने जा रहे हैं, तो सबसे पहले उत्पाद के बारे में कई महत्वपूर्ण सवालों के जवाब देना अच्छा होगा। और यदि आप पक्ष में प्रमाण पत्र का आदेश देते हैं, तो यह अजीब होगा यदि आपको ये प्रश्न नहीं पूछे जाते हैं।

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

2. सामग्री

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

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

सामग्री एक तकनीकी लेखक द्वारा संकलित की गई है और डेवलपर द्वारा अनुमोदित है। सामग्री अनुमोदित होने के बाद, तकनीकी लेखक विषयों का पाठ लिखने के लिए आगे बढ़ता है।

3. मदद डिजाइन

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

पाठ के लेखन की परवाह किए बिना समानांतर और सभी डिजाइन काम का संचालन करें। इससे आपका समय बचेगा और पायलट सहायता रिपोर्ट तेजी से प्राप्त होगी।

4. मध्यवर्ती संस्करण नियंत्रण

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

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

5. अंतिम संस्करण

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

पूरी मदद पढ़ें और अंतिम बदलाव करें।

6. प्रूफरीडिंग (प्रूफरीडिंग)

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

7. प्रलेखन का निर्यात

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

बुनियादी ढांचे

सहायता परियोजनाओं, दृष्टांतों और स्रोत डेटा को संग्रहीत करने के लिए, मैं मल्टी-यूज़र और संस्करण नियंत्रण क्षमताओं (ड्रॉपबॉक्स, बॉक्स डॉट कॉम) के साथ क्लाउड डेटा वेयरहाउस का उपयोग करने की सलाह देता हूं, साथ ही ऑनलाइन दस्तावेज़ (googe डॉक्स, ऑफिस 360)।

डेटा वेयरहाउस के रूप में, Box.com उपयुक्त है। पेशेवरों:

• स्थानीय फ़ाइलों के साथ सिंक्रनाइज़ेशन
• अधिसूचना प्रणाली
• टिप्पणी दर्ज करें
• संस्करण इतिहास
• अधिकारों का उपयोग

कच्छा के लिए, Google डॉक्स का उपयोग करने के लिए सुविधाजनक एक सहायता की संरचना वाली तालिकाओं। पेशेवरों:

• बहु-उपयोगकर्ता ऑनलाइन संपादन, पहुंच स्तर
• स्वचालित सहेजें, इतिहास बदलें
• स्क्रिप्ट के साथ कार्यक्षमता का विस्तार
• कार्यालय सूट खरीदने की कोई जरूरत नहीं है
• टिप्पणी प्रणाली

अन्त

मदद पूरी करने के बाद, इंटरनेट पर मदद पोस्ट करें, एक गाइड प्रिंट करें या प्रोग्राम में संदर्भ-संवेदनशील मदद को एकीकृत करें। लेकिन यह अंत से बहुत दूर है। अगला चरण एक सहायता अपडेट या अनुवाद है। इन कार्यों के बारे में यह है कि मैं निम्नलिखित पदों पर चर्चा करूंगा।

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

लेखक के बारे में

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

हम विज्ञापन और शैक्षिक वीडियो भी बनाते हैं - उन साइटों के लिए जो Google Play और ऐप स्टोर के लिए छवि, विज्ञापन, शैक्षिक, टीज़र, खोजकर्ता, ट्रेलर बेचते हैं।

और पढ़ें: https://alconost.com