< उपयोगकर्ता मार्गदर्शिकाएँ
नोट:
  • यह अध्याय, तथा तकनीकी लेखन की शेष पुस्तक, तकनीकी लेखन कौशलों पर केंद्रित है। यहाँ दी गई तकनीकी सामग्री के सफल, सटीक या अद्यतन होने की कोई गारंटी नहीं है।
  • इस अध्याय का अनुवाद OpenAI ChatGPT का उपयोग करके किया गया है। कृपया भाषा संबंधी समस्याओं की सूचना admin@mcmassociates.io पर दें।
  • इस पृष्ठ पर मौजूद चित्रों में पाठ का अनुवाद यथाशीघ्र किया जाएगा।
  • वेब होस्टिंग का भुगतान करने में David McMurrey की सहायता करने के लिए यहाँ क्लिक करें: किसी भी राशि का दान करें! Online Technical Writing निःशुल्क बना रहेगा।

कृपया मदद करने के लिए यहाँ क्लिक करें। डेविड मैकमरे वेब होस्टिंग के लिए भुगतान:
कृपया जितनी भी छोटी राशि आप दे सकें, दान करें।
ऑनलाइन तकनीकी लेखन मुफ्त रहेगा।

यह पृष्ठ मरम्मत के अधीन है।

NotebookLLM-generated infographic of this chapter NotebookLLM द्वारा निर्मित इस अध्याय का इन्फोग्राफिक

प्रेषण संदेश

अंतिम पैराग्राफ। यह पाठक को किसी भी प्रश्न, टिप्पणी या चिंता के मामले में संपर्क करने के लिए प्रोत्साहित करता है। यह सद्भावना के संकेत के साथ समाप्त होता है और यह आशा व्यक्त करता है कि पाठक उपयोगकर्ता मार्गदर्शिका को संतोषजनक पाएंगे।

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

-->

सामने और पीछे के कवर

शीर्षक पृष्ठ

संसकरण सूचना, प्रतिलिपि अधिकार, व्यापार चिह्न

सामग्री सूची

प्रस्तावना

उपयोगकर्ता मार्गदर्शिका मुख्य अध्याय

परिशिष्ट

परिशिष्ट

अनुक्रमणिका

अन्य उपयोगकर्ता मार्गदर्शिका के तत्व

शीर्षक

बुलेटेड और क्रमांकित सूचियाँ

चिह्न, संख्याएँ, और संक्षिप्त रूप

ग्राफ़िक्स और आकृति शीर्षक

अंतर्संदर्भ

पृष्ठ क्रमांकन

उपयोगकर्ता मार्गदर्शिकाओं के लिए एआई प्रॉम्प्ट्स

चेकलिस्टें, जिन्हें सामान्यतः पढ़ा ही नहीं जाता, कुछ संशोधन के साथ एआई प्रॉम्प्ट्स के स्रोत के रूप में उपयोग की जा सकती हैं। निम्नलिखित को कॉपी करें, इसे Google के Gemini जैसे किसी एआई सिस्टम में पेस्ट करें, और देखें कि आपने क्या चूक कर दिया होगा।

नोट: उपयोगकर्ता गाइडों या उनके घटकों की सामग्री, प्रारूप और शैली से संबंधित सभी संदर्भ पाए जा सकते हैं। ऑनलाइन तकनीकी लेखन पाठ्यपुस्तक.

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

परिचय को अपनी पहचान के अनुरूप संशोधित करें।

एआई प्रॉम्प्ट उपयोगकर्ता मार्गदर्शिकाएँ

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

  • क्या उपयोगकर्ता मार्गदर्शिका में निम्नलिखित (उचित रूप से स्वरूपित) इस क्रम में शामिल हैं: प्रेषण संदेश, सामने और पीछे के आवरण, शीर्षक पृष्ठ; संस्करण सूचना, विषय-सूची; प्रस्तावना; अध्याय, परिशिष्ट (जहाँ आवश्यक हो); सूचकांक, पिछला आवरण?
  • हालाँकि यह चतुर और चंचल हो सकता है, क्या उपयोगकर्ता मार्गदर्शिका का शीर्षक उसके विषय का पर्याप्त रूप से संकेत देता है? विवरण के लिए देखें उपयोगकर्ता मार्गदर्शिका शीर्षक.
  • यदि सामग्री-सूची और चित्रों की सूची (और तालिका) लीडर डॉट्स का उपयोग करती हैं, तो क्या पृष्ठ संख्याएँ दाईं ओर संरेखित होती हैं. यदि सामग्री-सूची और चित्रों की सूची (और तालिका) पृष्ठ के दाएँ किनारे पर पृष्ठ संख्याएँ शामिल करती हैं, तो क्या लीडर डॉट्स का उपयोग किया जाता है? विवरण के लिए देखें विषय-सूचियाँ और चित्रों (तालिकाओं) की सूची.
  • क्या परिचय उपयोगकर्ता गाइड के विषय, उद्देश्य, और लक्षित दर्शकों को पर्याप्त रूप से इंगित करता है? क्या यह शामिल किए जाने वाले उपविषयों की सूची और दायरे का संकेत देता है (क्या शामिल नहीं है)? विवरण के लिए देखें परिचय.
  • क्या यह उपयोगकर्ता मार्गदर्शिका दावों और सामान्यताओं की व्याख्या करने के लिए पर्याप्त विवरण, विशिष्टताएँ, उदाहरण—जो कुछ भी आवश्यक हो, शामिल करती है?
  • विषय, उद्देश्य और दर्शकों को ध्यान में रखते हुए, क्या इस उपयोगकर्ता मार्गदर्शिका में कोई महत्वपूर्ण सामग्री गायब है? क्या कोई सामग्री अनावश्यक है? क्या इस उपयोगकर्ता मार्गदर्शिका की कोई जानकारी तकनीकी रूप से गलत है? क्या कोई महत्वपूर्ण तकनीकी जानकारी गायब है?
  • क्या इस उपयोगकर्ता मार्गदर्शिका में कोई स्पष्ट रूप से उधृत जानकारी है जो किसी भी तरह से प्रलेखित नहीं है?
  • क्या उद्धरण (सूचना-स्रोत सूची में आइटमों के संदर्भ) उपयोगकर्ता गाइड के मुख्य भाग में APA, MLA, या संशोधित IEEE शैली के अनुसार दिए गए हैं? क्या सूचना-स्रोत सूची में आइटम APA, MLA, या संशोधित IEEE शैली के अनुसार स्वरूपित हैं? विवरण के लिए देखें दस्तावेज़ीकरण: उपयोग की गई सूचनाओं के स्रोत.
  • क्या सभी तालिकाओं और गैर-सजावटी आकृतियों में एक वर्णनात्मक शीर्षक (कैप्शन) और स्रोत (यदि आवश्यक हो) शामिल हैं? विवरण के लिए, देखें तालिका के शीर्षक.
  • क्या सभी तालिकाएँ और गैर-सजावटी आकृतियाँ अपने संबंधित पाठ के जितना संभव हो पास स्थित हैं?
  • क्या संक्षेप में व्याख्यात्मक क्रॉस-संदर्भ तालिकाओं और गैर-सजावटी चित्रों से पहले होते हैं? विवरण के लिए देखें व्याख्यात्मक क्रॉस-संदर्भ.
  • क्या उपयोगकर्ता मार्गदर्शिका के मुख्य भाग में शीर्षकों और उपशीर्षकों के लिए एक मानक प्रारूप उपयोग किया जाता है? विवरण के लिए देखें शीर्षक.
  • क्या उपयोगकर्ता मार्गदर्शिका के मुख्य अनुभाग (अध्याय) प्रिंट संस्करणों में नए पृष्ठ पर शुरू होते हैं?
  • क्या क्रमांकित लंबवत सूचियाँ उन सूची आइटमों के लिए उपयोग की जाती हैं जिनका कोई आवश्यक क्रम होता है? क्या बुलेट वाली लंबवत सूचियाँ उन सूची आइटमों के लिए उपयोग की जाती हैं जिनमें कोई आवश्यक क्रम नहीं होता? क्या सभी सूचियों से पहले लीड-इन्स का उपयोग किया जाता है? विस्तृत जानकारी के लिए देखें ऊर्ध्वाधार सूचियाँ.
  • क्या प्रत्यक्ष उद्धरणों को स्रोत दिखाया गया है, और क्या स्रोत-उल्लेख सही विराम-चिह्नों के साथ हैं? क्या सभी प्रत्यक्ष उद्धरण, सारांश और पैराफ्रेज़ APA, MLA, या संशोधित IEEE शैली के अनुसार उचित रूप से उद्धृत किए गए हैं? विस्तार के लिए देखें: उद्धरण और श्रेय.
  • क्या उपयोगकर्ता मार्गदर्शिका के पाठ में व्याकरण, शब्द प्रयोग और विराम चिन्हों की त्रुटियाँ नहीं हैं? विस्तृत जानकारी के लिए देखें सामान्य व्याकरण, प्रयोग और वर्तनी की समस्याएँ.
  • क्या उपयोगकर्ता मार्गदर्शिका का पाठ अनावश्यक शब्दों और अन्य वाक्य शैली की त्रुटियों से मुक्त है? विवरण के लिए देखें अतिशयोक्ति, अन्य वाक्य-शैली संबंधी समस्याएँ.
  • क्या यह उपयोगकर्ता मार्गदर्शिका अपने लक्षित दर्शकों द्वारा समझी जा सकती है (जैसा कि प्रेषण संदेश और परिचय में संकेत किया गया है)? विवरण के लिए देखें दर्शक विश्लेषण, और देखें तकनीकी का अनुवाद.
  • एटी, मेरे उपयोगकर्ता गाइड के आपके मूल्यांकन को पूरा करने के लिए 100 से 55 तक एक संख्यात्मक ग्रेड असाइन करें).
  • संबंधित जानकारी

    शुरुआती लोगों के लिए उपयोगकर्ता-अनुकूल सहायता विषय कैसे लिखें. क्लिकहेल्प.कॉम

    उपयोगकर्ता प्रलेखन कैसे लिखें. टेकस्क्राइब

    उपयोगकर्ता मार्गदर्शिकाएँ. टेकस्क्राइब

    मैं इस अध्याय के बारे में आपके विचारों, प्रतिक्रियाओं और आलोचनाओं की सराहना करूँगा: आपका उत्तरडेविड मैकमरे.