एंड यूजर डॉक्यूमेंटेशन उदाहरण के लिए अच्छे संदर्भ और सलाह [बंद]


10

हमारे घर के सॉफ्टवेयर का उपयोग कई उपयोगकर्ताओं के लिए किया गया है और प्रशिक्षण विभाग ने हमें अंतिम उपयोगकर्ता प्रलेखन प्रारूप के किसी भी सुझाव के लिए कहा है।

क्या कोई जानता है कि मुझे सॉफ़्टवेयर एंड यूज़र डॉक्यूमेंटेशन के अच्छे उदाहरण कहां मिल सकते हैं जो प्रेरणा के लिए किसी प्रशिक्षण विभाग या अच्छी सलाह वाली किसी साइट का उपयोग करने के लिए है?

यह इस सवाल के समान है, हालांकि मैं गैर-तकनीकी उपयोगकर्ताओं द्वारा उपयोग किए जाने वाले उपयोग के लिए अंतिम उपयोगकर्ता दस्तावेज की तलाश कर रहा हूं।


1
"मुझे सॉफ़्टवेयर एंड यूज़र डॉक्यूमेंटेशन के अच्छे उदाहरण कहाँ मिलेंगे" चरण 1. कुछ सॉफ़्टवेयर खरीदें। चरण 2. प्रलेखन पढ़ें। आपके द्वारा पहले से उपयोग किए जा रहे मौजूदा सॉफ़्टवेयर से दस्तावेज़ लेने से आपको क्या रोक रहा है? मेरा मानना ​​है कि अधिकांश अंतिम-उपयोगकर्ता पैकेजों में ऑन-लाइन पूर्ण प्रलेखन होता है। आपको उनके Office सुइट के लिए Microsoft के दस्तावेज़ पढ़ने से क्या रोक रहा है?
S.Lott 12

मेरा मानना ​​है कि मेरे द्वारा पढ़े गए अधिकांश दस्तावेज़ इस तरह से लिखे गए हैं जो पढ़ने के लिए अपील नहीं कर रहे हैं, और मेरे पास अधिकांश किताबें आमतौर पर तकनीकी दर्शकों के लिए संबंधित प्रोग्रामिंग हैं। जरा देखें कि कोई आखिरी बार Microsoft मैनुअल कब पढ़े? इसलिए मुझे कुछ प्रेरणादायक उदाहरणों की तलाश थी।
जॉन

हम्म, दिलचस्प क्यू।
रूक

@ जॉन: "अधिकांश प्रलेखन"। ठीक है। तो, "सबसे" त्यागने के बाद, क्या बचा है? हम नहीं जानते कि आप ग्रह पर सबसे अधिक उपयोग किए जाने वाले कुछ प्रलेखन को अस्वीकार कर रहे हैं क्योंकि "पढ़ने की अपील नहीं"। आप अपनी शिकायतों की सूची को बढ़ा सकते हैं, और सॉफ्टवेयर प्रलेखन के अपने व्यक्तिगत संक्षिप्त सूची को जोड़ सकते हैं जो आपके "पढ़ने के लिए अपील नहीं" द्वारा बाहर नहीं किया गया है। हम आपको बहुत अच्छी तरह से नहीं जानते हैं, इसलिए हम अनुमान नहीं लगा सकते हैं कि आपका मतलब "पढ़ने की अपील नहीं" है।
S.Lott

2
आइए सावधान रहें कि हमें "अच्छे" के ऐसे विशिष्ट मानदंडों के साथ प्रश्नों की आवश्यकता नहीं है कि यह स्थानीयकृत हो जाता है और अधिकांश लोगों पर लागू नहीं होता है। मुझे रंग योजनाओं में कोई दिलचस्पी नहीं है।
जेफो

जवाबों:


1

आप सॉफ़्टवेयर के बारे में अपने इन-हाउस उपयोगकर्ताओं का साक्षात्कार करके शुरू कर सकते हैं, और यह जान सकते हैं कि वे किस तरह की जानकारी जानना चाहते हैं।

सॉफ्टवेयर के बारे में मैंने जो भी दस्तावेज लिखे हैं उनमें से एक या कई दर्शकों को ध्यान में रखा गया है। आपका प्रशिक्षण विभाग संभवतः विषयों के एक कंकाल (टीओसी की तरह) से लाभान्वित होगा। तो फिर आप चर्चा कर सकते हैं कि कौन से विषय प्रासंगिक हैं और उनके प्रशिक्षण उद्देश्यों के लिए क्या अप्रासंगिक हैं।

कुछ विषय कवर कर सकते हैं:

  1. लक्षित श्रोता)
  2. तकनीकी आवश्यकताएँ
  3. कैसे स्थापित करें (यदि लागू हो)
  4. प्रक्रिया (यानी कौन सा व्यावसायिक कार्य सॉफ्टवेयर करता है?)
  5. Featureset (सॉफ्टवेयर क्या विशेषताएं है?)
    • आपके पास इसके लिए एक कार्य आधारित दृष्टिकोण हो सकता है, जैसे कि एक उपयोगकर्ता जोड़ें या एक दस्तावेज़ जोड़ें
    • आपके पास ऑब्जेक्ट-आधारित दृष्टिकोण हो सकता है, जैसे उपयोगकर्ता, रोल्स
    • आप एक मेनू आधारित दृष्टिकोण, उदाहरण के लिए फ़ाइल मेनू, मेनू देख सकते हैं
  6. अंत में, संभवतः एक आगामी सुविधाओं और FAQ अनुभाग आपके उत्पाद के बढ़ते ज्ञान भंडार के रूप में कार्य कर सकता है।

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

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

उम्मीद है की यह मदद करेगा


2

मैंने कई "एंड यूज़र गाइड" पढ़े हैं, और एक को लिखा है, और मुझे लगता है कि कई तत्व हैं जो उनकी प्रभावशीलता में सुधार करते हैं:

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

मुझे उम्मीद है कि यह आपके लिए उपयोगी हो सकता है।


1

आप उल्लेख करते हैं कि इसका उपयोग प्रशिक्षण के लिए किया जाएगा।

यदि आप एक संदर्भ दस्तावेज़ के बजाय एक प्रशिक्षण दस्तावेज़ की तलाश कर रहे हैं, तो मेरी पसंदीदा ऐसी साइट यहाँ मर्क्यूरियल पर जोएल स्पोल्स्की का ट्यूटोरियल है

  1. सरल, स्वच्छ प्रस्तुति। यह देखकर अच्छा लगा।
  2. आधिकारिक, लेकिन स्वर में व्यक्तिगत। ऐसा लगता है कि आप एक महान कॉलेज व्याख्यान में हैं।
  3. साधारण चित्र, वास्तविक स्क्रीन शॉट्स की प्रचुर मात्रा में नहीं। क्यों यह काम करता है के लिए नैपकिन के पीछे पढ़ें ।

यदि आप प्रशिक्षण दस्तावेज़ को 1/2 जोएल के मर्क्यूरियल ट्यूटोरियल के रूप में शांत थे, तो मैं इसे पढ़ूंगा। लेकिन आपको किसी के साथ) लेखन के लिए एक जुनून और ख) ज्ञान की एक अविश्वसनीय गहराई चाहिए, ताकि आप इसे 3 अंक ऊपर कॉपी कर सकें। मुझे भरोसा है ये काम करेगा।


0

मैं अगर यह संभवतः अपनी आवश्यकताओं फिट बैठता है पता नहीं है, लेकिन वहाँ बाहर सिस्टम तकनीकी दस्तावेज के लिए इस्तेमाल कर रहे हैं स्फिंक्स एक है कि मन है कि एक ऑनलाइन प्रलेखन बनाने की सुविधा के लिए आता जा रहा है। क्या आपकी रुचि के लिए कुछ ऐसा इस्तेमाल किया जा सकता है?

मैं भी ReadTheDocs भर में भागा जो एक ही काम करता है लेकिन एक होस्टेड समाधान है।


0

की जाँच करें तकनीकी संचार के लिए सोसायटी (एसटीसी) । उनके पुरस्कार विजेताओं में से कई ने उत्पादन लिखा जो आम तौर पर उपलब्ध है। उनके पास नमूने भी उपलब्ध हो सकते हैं। एक सदस्य बनने से सूचना के एक बड़े निकाय तक पहुंच भी होगी।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.