संशोधन की कला - डेवलपर्स के लिए तकनीकी दस्तावेज़ लिखने का तरीका

<p>- संशोधन : लिखते समय कई बार सोचकर उसे सुधारना और निखारना। या ऐसा करने की प्रक्रिया<br /> - संशोधन की ज़रूरत क्यों होती है<br /> - संशोधन संबंधी सुझाव<br /> → अपने लेख को नया-सा बनाना: ज़ोर से पढ़ना, कुछ समय बाद फिर पढ़ना, कागज़ पर प्रिंट करके पढ़ना<br /> → peer review <br /> → checklist का उपयोग <br /> → readability बढ़ाने के लिए वाक्य सुधारने के सुझाव <br /> ① छोटे वाक्यों में व्यवस्थित करके संशोधित करना<br /> ② अनावश्यक अभिव्यक्तियाँ हटाना<br /> ③ इसे तार्किक लेखन में बदलना</p>

[budlebee]

<p>मुझे Stephen King के writing principles याद आ रहे हैं। यह उपन्यास लेखन है, इसलिए technical writing से कुछ बातें अलग हो सकती हैं, लेकिन जो याद आ रहा है वह लिखता हूँ:<br /> <br /> - छोटे और सरल वाक्यों का उपयोग करें.<br /> - मैं पहला ड्राफ्ट लिखने के बाद उसे दराज़ में रख देता हूँ और 6 महीने बाद निकालकर फिर से पढ़ता हूँ.<br /> - संशोधित संस्करण पहले ड्राफ्ट से 10% कम होता है.<br /> - लिखे हुए को ज़ोर से पढ़कर सुनाने पर वाक्यों के अटपटे हिस्से पकड़े जा सकते हैं.<br /> - लिखते समय यह स्पष्ट तय रखें कि पाठक कौन है। मेरे मामले में, वह मेरी पत्नी है. </p>

[xguru]

<p>आजकल Kakao Enterprise के technical writing करने वाले लोग बहुत अच्छे लेख लिख रहे हैं। ब्लॉग subscribe करने की सलाह है!</p>