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