हैंडबुक्स

एक हैंडबुक, जैसा कि हम इसे यहां परिभाषित कर रहे हैं, निम्नलिखित का संयोजन है:

• संकल्पना जानकारी
• निर्देश जानकारी
• संदर्भ जानकारी

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

सुनिश्चित करें कि आप देखें उदाहरण.

इस अध्याय का NotebookLM-जनित इन्फोग्राफिक

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

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

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

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

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

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

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

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

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

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

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

सूचीयुक्त फलक प्रारूप

हैंडबुक के उदाहरण

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

यह सुनिश्चित करें कि आप देखें उदाहरण.

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

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

नोट: तकनीकी दस्तावेज़ या इसके घटकों की सामग्री, प्रारूप, शैली के सभी संदर्भ यहाँ पाए जा सकते हैं। ऑनलाइन तकनीकी लेखन पाठ्यपुस्तक.

जल्द आ रहा है!

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