मार्गदर्शिकाएँ

एक मार्गदर्शिका, जैसा कि हम इसे यहाँ पर परिभाषित कर रहे हैं, निम्नलिखित का संयोजन है:

• अवधारणा सूचना
• निर्देश सूचना
• संदर्भ जानकारी

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

ज़रूर देखें उदाहरण.

इस अध्याय का NotebookLM द्वारा निर्मित इन्फोग्राफिक

हैंडबुक की बुनियादी बातें

अवधारणाएँ. वैचारिक जानकारी यह बताती है कि चीज़ें कैसे काम करती हैं, और चीज़ें कैसे एक साथ जुड़ी होती हैं। अधिक जटिल निर्देशों के लिए, उन निर्देशों को पूरा करने के लिए आपको कुछ अवधारणाएँ, सिद्धांत, पृष्ठभूमि और मूल सिद्धांत जानने पड़ते हैं। उस सॉफ़्टवेयर फ़ंक्शन के उदाहरण पर विचार करें जो आपको अपना रंग संशोधित करने या नया रंग बनाने में सक्षम बनाता है। Photoshop, Illustration, CorelDraw या Paint Shop Pro जैसे किसी सॉफ़्टवेयर का उपयोग करके इसे करना—वास्तविक बटन और स्लाइडर्स— आसान है। लेकिन यह समझना कि रंग-टोन, तीव्रता, चमक, संतृप्ति, घनत्व, कंट्रास्ट, आरजीबी— कठिन है। आपको वह रंग बनाने के लिए कंप्यूटर रंग सिद्धांत जानना पड़ता है जिसकी आपको आवश्यकता है।

एक और उदाहरण पर विचार करें: सरल लिनक्स फ़ाइल सिस्टम कमांड्स—ls, cd, cp, mv, pwd। इन कमांडों का उपयोग करने के लिए, आपको यह समझना होगा कि फ़ाइलें और निर्देशिकाएँ क्या हैं, और संभवतः एक ऑपरेटिंग सिस्टम क्या होता है, साथ ही वाइल्डकार्ड्स भी। आप वास्तव में यह नहीं समझ पाएँगे कि इन कमांडों का उपयोग कैसे किया जाता है—उनका उपयोग करके निर्देशों का पालन करना—जब तक आप इन बुनियादी अवधारणाओं को नहीं समझते।

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

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

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

हैंडबुक प्रारूप और शैली

इस पुस्तक का उपयोग करने वाले तकनीकी लेखन पाठ्यक्रम में, आपसे शीर्षकों, सूचियों, सूचनाओं, ग्राफिक्स, तालिकाओं, दस्तावेज़ीकरण और परिचयों के उपयोग के लिए विशिष्ट दिशानिर्देशों का पालन करने की उम्मीद की जा सकती है:

हैंडबुक प्रोटोटाइप। नीचे दिए गए लिंक से आप हैंडबुक का नमूना संस्करण प्राप्त कर सकते हैं। इसमें सभी आवश्यक पृष्ठ अच्छे प्रारूप में शामिल हैं। इस वर्ड दस्तावेज़ में अनुच्छेद और अक्षर शैलियाँ शामिल हैं जो आपका काम आसान बनाएँगी और आपके कौशल-संग्रह में कुछ पेशेवर क्षमताएँ जोड़ेंगी।

हैंडबुक प्रोटोटाइप

सामग्री का प्रोटोटाइप। विषय-सूची के लिए यह प्रोटोटाइप विशेष रूप से उपयोगी है: यह आपको पेशेवर दिखने वाली विषय-सूची बनाने के लिए वर्ड शैलियाँ प्रदान करता है। बाएँ और दाएँ संरेखण तथा लीडर डॉट्स को सही ढंग से सेट करना कठिन होता है:

अनुक्रमणिका प्रोटोटाइप

मार्गदर्शिका के उदाहरण

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

अवश्य देखें उदाहरण.

हैंडबुक्स के लिए एआई प्रॉम्प्ट्स

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

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

जल्द ही आ रहा है!

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