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

• संशोधन : लिखते समय कई बार सोचकर उसे सुधारना और निखारना। या ऐसा करने की प्रक्रिया

• संशोधन की ज़रूरत क्यों होती है

• संशोधन संबंधी सुझाव

→ अपने लेख को नया-सा बनाना: ज़ोर से पढ़ना, कुछ समय बाद फिर पढ़ना, कागज़ पर प्रिंट करके पढ़ना

→ peer review

→ checklist का उपयोग

→ readability बढ़ाने के लिए वाक्य सुधारने के सुझाव

① छोटे वाक्यों में व्यवस्थित करके संशोधित करना

② अनावश्यक अभिव्यक्तियाँ हटाना

③ इसे तार्किक लेखन में बदलना

[budlebee]

मुझे Stephen King के writing principles याद आ रहे हैं। यह उपन्यास लेखन है, इसलिए technical writing से कुछ बातें अलग हो सकती हैं, लेकिन जो याद आ रहा है वह लिखता हूँ:

• छोटे और सरल वाक्यों का उपयोग करें.

• मैं पहला ड्राफ्ट लिखने के बाद उसे दराज़ में रख देता हूँ और 6 महीने बाद निकालकर फिर से पढ़ता हूँ.

• संशोधित संस्करण पहले ड्राफ्ट से 10% कम होता है.

• लिखे हुए को ज़ोर से पढ़कर सुनाने पर वाक्यों के अटपटे हिस्से पकड़े जा सकते हैं.

• लिखते समय यह स्पष्ट तय रखें कि पाठक कौन है। मेरे मामले में, वह मेरी पत्नी है.

[xguru]

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