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

कृपया मदद करने के लिए यहाँ क्लिक करें। डेविड मैकमरे वेब होस्टिंग के लिए भुगतान करें:
कृपया अपनी क्षमता के अनुसार थोड़ी भी राशि दान करें!
ऑनलाइन तकनीकी लेखन निःशुल्क रहेगा।

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

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

नोट: सालों तक यह ऑनलाइन तकनीकी लेखन की पाठ्यपुस्तक रिपोर्टों को सामान्यतः उन किसी भी चीज़ के रूप में संदर्भित करती रही जिनमें तकनीकी जानकारी होती थी। लेकिन क्योंकि 'रिपोर्ट' तकनीकी दस्तावेज़ की एक विशिष्ट शैली या श्रेणी को संदर्भित करती है, इसलिए 'रिपोर्ट' के स्थान पर सामान्य शब्द 'टेकडॉक' (जो 'तकनीकी दस्तावेज़' का संक्षेप है) का प्रयोग करना पड़ा।

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

जब आप किसी तकनीकी दस्तावेज़ (techdoc) के डिज़ाइन का विश्लेषण करते हैं, तो ध्यान दें कि कुछ अनुभाग कितने दोहरावपूर्ण हैं। यह पुनरावृत्ति इस बात से जुड़ी है कि लोग तकनीकी दस्तावेज़ कैसे पढ़ते हैं। वे तकनीकी दस्तावेज़ को शुरू से अंत तक लगातार नहीं पढ़ते: वे संभवतः कार्यकारी सारांश (executive summary) से शुरुआत करते हैं, बीच-बीच में पृष्ठ छोड़ते हैं, और शायद हर पृष्ठ नहीं पढ़ते। आपकी चुनौती यह है कि तकनीकी दस्तावेज़ इस तरह डिज़ाइन करें कि ये पाठक—चाहे वे दस्तावेज़ का कितना भी हिस्सा पढ़ें या किसी भी क्रम में पढ़ें—आपके प्रमुख तथ्य और निष्कर्षों तक अवश्य पहुँचें।

ज़रूर जाकर देखें उदाहरण तकनीकी दस्तावेज़.

एक सामान्य तकनीकी रिपोर्ट के मानक घटकों पर इस अध्याय में चर्चा की गई है। निम्नलिखित अनुभाग आपको इन प्रत्येक घटकों के माध्यम से मार्गदर्शन करते हैं, और मुख्य विशेषताओं की ओर संकेत करते हैं। जब आप इन दिशानिर्देशों को पढ़ते और उपयोग करते हैं, तो याद रखें कि ये दिशानिर्देश हैं, आदेश नहीं। विभिन्न कंपनियों, व्यवसायों और संगठनों के अपने-अपने दिशानिर्देश होते हैं; techdocs— आपको अपनी प्रथाओं को उन दिशानिर्देशों के साथ-साथ यहाँ प्रस्तुत दिशानिर्देशों के अनुरूप भी अनुकूलित करना होगा।

प्रेषण संदेश

प्रेषण संदेश या तो एक कवर लेटर (या मेमो) या एक ई‑मेल होता है। भौतिक पत्र (या मेमो) या तो तकनीकी दस्तावेज़ के बाहर पेपर क्लिप से संलग्न होता है या तकनीकी दस्तावेज़ के भीतर बाँधा होता है। ई‑मेल में तकनीकी दस्तावेज़ का लिंक होता है या तकनीकी दस्तावेज़ संलग्न होता है। यह आप—तकनीकी दस्तावेज़ लेखक—से प्राप्तकर्ता को एक संचार है, उस व्यक्ति को जिसने तकनीकी दस्तावेज़ का अनुरोध किया और जो शायद आपको आपके विशेषज्ञ परामर्श के लिए भुगतान भी कर रहा हो। मूल रूप से, यह कहता है "ठीक है, यह वह तकनीकी दस्तावेज़ है जिसे हमने सहमति की थी कि मैं ऐसी‑और‑ऐसी तिथि तक पूरा कर दूँगा। संक्षेप में, इसमें यह और वह शामिल है, लेकिन यह इस या उस को कवर नहीं करता। बताइए क्या यह आपकी आवश्यकताओं को पूरा करता है।" प्रेषण संदेश संदर्भ—उन घटनाओं को समझाता है जिन्होंने तकनीकी दस्तावेज़ को जन्म दिया। इसमें तकनीकी दस्तावेज़ के बारे में ऐसी जानकारी शामिल है जो तकनीकी दस्तावेज़ के भीतर नहीं होनी चाहिए।

Business letter and email versions of transmital message
प्रेषण पत्र और प्रेषण संदेश के उदाहरण।

प्रेषण पत्र के उदाहरण में, मानक व्यावसायिक पत्र प्रारूप पर ध्यान दें। यदि आप आंतरिक तकनीकी दस्तावेज़ लिखते हैं, तो इसके बजाय ज्ञापन प्रारूप का उपयोग करें; किसी भी मामले में, सामग्री और संगठन समान होते हैं:

पहला अनुच्छेद। टेकडॉक के नाम का उल्लेख करता है और उसे इटैलिक्स में दर्शाता है। यह टेकडॉक लिखने के समझौते की तारीख का भी उल्लेख करता है।

मध्य अनुच्छेद। यह टेकडॉक के उद्देश्य पर ध्यान केंद्रित करता है और टेकडॉक की सामग्री का संक्षेप में अवलोकन प्रदान करता है।

अंतिम अनुच्छेद। यह पाठक को प्रोत्साहित करता है कि यदि कोई प्रश्न, टिप्पणी, या चिंता हो तो संपर्क करें। यह सद्भावना के इशारे के साथ समाप्त होता है, जिसमें यह आशा व्यक्त की जाती है कि पाठक को तकनीकी दस्तावेज़ संतोषजनक लगे।

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

आवरण, शीर्षक पृष्ठ और लेबल

यदि आपका तकनीकी दस्तावेज़ दस पृष्ठों से अधिक है, तो उसे किसी प्रकार से बाइंड करें और आवरण के लिए एक लेबल बनाएं।

आवरण

कवर्स टेकडॉक्स को एक ठोस, पेशेवर रूप और सुरक्षा दोनों प्रदान करते हैं। आप कई प्रकार के कवर्स में से चुन सकते हैं। इन सुझावों को ध्यान में रखें:

आम तौर पर कम पसंद किए जाते हैं अलग पन्नों वाली नोटबुक्स या रिंग-बाइंडर्स। ये छोटे तकनीकी दस्तावेज़ों के लिए बहुत अधिक स्थान घेरते हैं, और पन्नों में बने छेद अक्सर फट जाते हैं। बेशक, रिंग-बाइंडर पन्नों को बदलना आसान बनाता है; अगर आपका तकनीकी दस्तावेज़ इसी तरह उपयोग होगा, तो यह एक अच्छा विकल्प है। "हाई एंड" में आते हैं अत्यधिक सजावटी कवर जिनका लेदर जैसा रूप और सुनहरे रंग की किनारी होती है। इन्हें टालें—इसे सादा, सरल, और कार्यात्मक रखें।

शीर्षक पृष्ठ

सबसे सरल रूप में, एक तकनीकी दस्तावेज़ का शीर्षक फ्रंट कवर पर जो लिखा होता है उसकी एक प्रति है—शायद इसमें कुछ अतिरिक्त विवरण जोड़े गए हों।

शीर्षक पृष्ठ को देखें। सार और कार्यकारी सारांश.

लेबल

अपने तकनीकी दस्तावेज़ के कवर के लिए एक लेबल ज़रूर बनाएं। यह एक ऐसा कदम है जिसे कुछ तकनीकी दस्तावेज़ लेखक भूल जाते हैं। बिना लेबल के, एक तकनीकी दस्तावेज़ अनाम रहता है; इसे अनदेखा कर दिया जाता है।

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

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


प्रेषण पत्र और तकनीकी दस्तावेज़ का आवरण (आवरण लेबल के साथ)।

सार और कार्यकारी सारांश

अधिकांश तकनीकी टेकडॉक्स में कम से कम एक सार— होता है—कभी-कभी दो होते हैं, और ऐसे मामलों में सार अलग-अलग भूमिकाएँ निभाते हैं। सार किसी टेकडॉक की सामग्री का सारांश प्रस्तुत करते हैं, लेकिन विभिन्न प्रकार इसे विभिन्न तरीकों से करते हैं:

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


विषयसूची (जो पहले आती है) फिर कार्यकारी सारांश।

सामग्री सूची

आप जो भी विषय-सूची (TOC) प्रारूप उपयोग करते हैं, ये सामान्य मानक हैं: