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