-
लिखना इंजीनियरों की अनिवार्य क्षमता है
- commit message से लेकर documentation तक, technical writing हर स्तर के engineer के लिए ज़रूरी है।
- अच्छा लिखने और खराब लिखने का फर्क काम की दक्षता और संगठनात्मक communication पर बड़ा असर डालता है.
-
जितना हो सके संक्षिप्त, छोटा
- पाठक किसी लेख पर बहुत समय नहीं लगाते।
- अगर आप किसी विचार को एक वाक्य में बता सकते हैं, तो वैसे ही बताइए।
- कुछ विवरणों को जानबूझकर छोड़ देना भी उल्टा एक फ़ायदा हो सकता है।
- महत्वपूर्ण बातों को लेख की शुरुआत, पहली पंक्ति या शीर्षक में रखिए।
-
अपेक्षाएँ वास्तविक रूप से तय करें
- यह उम्मीद मत कीजिए कि लोग technical लेखों को बारीकी से पढ़ेंगे और पूरी तरह समझेंगे।
- engineering organization में भ्रम और समझ के स्तर में अंतर सामान्य है, और writing के ज़रिए सबको एक जैसा नहीं बनाया जा सकता।
- अपेक्षाएँ कम रखने से communication उल्टा अधिक प्रभावी होता है।
-
लेखन का उद्देश्य है मुख्य बात को स्पष्ट रूप से पहुँचाना
- “configuration जोड़ना जटिल है” जैसी बहुत सरल बात को एक बड़े team तक पहुँचाना सबसे प्राथमिक लक्ष्य है।
- technical रूप से पूरी समझ दिलाने से अधिक महत्वपूर्ण है, न्यूनतम context देकर भरोसा बनाना।
-
वास्तव में क्या प्रभाव अपेक्षित है
- लेख के प्राप्तकर्ताओं के पास आम तौर पर लेखक की तुलना में कम background knowledge होती है।
- व्यापक audience के लिए सरल संदेश देना, और बहुत कम लोगों के लिए जटिल बातों को स्पष्ट रूप से बताना संभव है।
- केवल मुख्य बिंदु बता देना भी बड़े संगठन में बड़ा फर्क पैदा करता है।
-
स्पष्ट सोच, स्पष्ट लेखन बनाती है
- जिस विषय की समझ अधूरी हो, उसे संक्षिप्त करना कठिन होता है।
- अनिश्चितता को स्वीकार कीजिए, और उन हिस्सों पर ध्यान दीजिए जिन्हें आप स्पष्ट रूप से समझा सकते हैं।
-
गलतियाँ और सुझाई गई बातें
- बहुत अधिक विवरण देने की जिद मत कीजिए।
- जो बताना है उसे एक वाक्य, एक अनुच्छेद और एक पेज के स्तर पर क्रमशः संक्षिप्त करते हुए पहले मुख्य बात पहुँचाइए।
- जिन लोगों के पास technical background लगभग नहीं है, उन्हें भी बड़ा context पहुँचा पाना अपने आप में मूल्यवान है।
2 टिप्पणियां
समझाने के लिए अतिरिक्त व्याख्या कैसे शामिल की जाए, यही सबसे बड़ी चिंता होती है
या फिर निर्णय लेने वाला व्यक्ति उस क्षेत्र का विशेषज्ञ न हो...
यह बात सिर्फ़ तकनीकी दस्तावेज़ों पर ही नहीं, बल्कि ज़्यादातर दस्तावेज़ों पर भी लागू होती है।