सामग्री की जांच करें

एक कच्चे मसौदे की समीक्षा करने के सबसे महत्वपूर्ण तरीकों में से एक यह है कि आप सामग्री की जांच करें—कितना स्पष्ट है यह! दुनिया में सभी अच्छे संक्रमण, अच्छी संगठन और स्पष्ट वाक्य संरचना एक तकनीकी दस्तावेज़ की मदद नहीं कर सकती जो सही सामग्री नहीं रखता। एक तकनीकी दस्तावेज़ की सामग्री विभिन्न तरीकों से "गलत" हो सकती है:

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

प्रदान किए गए प्रश्नों का उपयोग करें दस्तावेज़ सामग्री अपने रफ ड्राफ्ट की समीक्षा करें कि कौन सी जानकारी जोड़ने या बदलने की आवश्यकता है।

अपने सामग्री की संरचना की जांच करें।

एक दस्तावेज़ में जानकारी के संगठन को देखने के दो तरीके हैं:

और अधिक विस्तृत विवरण यहाँ दिया गया है समन्वय और अधीनता कृपया पाठ प्रदान करें ताकि मैं उसे अनुवादित कर सकूं।

संगठन की जाँच करें

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

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

और किसी भी मामले में, आप इन दृष्टिकोणों को मिलाने से बचें—उदाहरण के लिए, कुछ डेटा को बाहर फेंकना, फिर कुछ निष्कर्ष बताना, और फिर यह सब बिना किसी क्रम में करना। सेब को संतरों से अलग रखें!

विषय वाक्यों और सारांशों को मजबूत करें।

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

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

इस विषय की विस्तृत जानकारी के लिए देखें विषय वाक्य और अवलोकन.

संगति, संक्रमण को मजबूत करें

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

देखें अध्याय पर संगति और संक्रमण विस्तृत चर्चा और उदाहरणों के लिए।

पैराग्राफ की लंबाई जांचें।

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

एक सिंगल स्पेस वाले पूरे पृष्ठ पर लिखी गई सामग्री में, कम से कम एक से चार पैराग्राफ ब्रेक देखें—उस औसत में कुछ भी जादुई नहीं है, इसलिए इसे कानून की तरह न लें। बस उन लंबे पैराग्राफ पर एक बार और नज़र डालें, और पैराग्राफ ब्रेक के संभावितता की जांच करें।

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