अच्छा डिज़ाइन डॉक्यूमेंट कैसे लिखें

• डिज़ाइन डॉक्यूमेंट सिस्टम की implementation strategy, constraints, और trade-offs को व्यवस्थित करने वाली एक तकनीकी रिपोर्ट है
• डिज़ाइन डॉक्यूमेंट का काम पाठक को यह भरोसा दिलाना है कि यह डिज़ाइन दिए गए संदर्भ के लिए उपयुक्त है
• दस्तावेज़ की संरचना महत्वपूर्ण है, और तार्किक प्रवाह के माध्यम से यह सुनिश्चित होना चाहिए कि पाठक सामग्री से चौंके नहीं
• संपादन के जरिए अनावश्यक शब्दों को कम करना और पाठक के ध्यान जैसे सीमित संसाधन को बचाना ज़रूरी है
• छोटे पैराग्राफ और appendix का उपयोग, तथा अभ्यास के माध्यम से दस्तावेज़ लेखन क्षमता में सुधार महत्वपूर्ण है

---

परिभाषा

• डिज़ाइन डॉक्यूमेंट, trade-offs और constraints के संदर्भ में सिस्टम implementation strategy को व्यवस्थित करने वाली एक तकनीकी रिपोर्ट है

लक्ष्य

• जैसे गणित में proof किसी theorem को स्वीकार्य बनाता है, वैसे ही डिज़ाइन डॉक्यूमेंट का उद्देश्य पाठक को यह विश्वास दिलाना है कि संबंधित डिज़ाइन सर्वोत्तम है
• डिज़ाइन प्रक्रिया में लिखने का कार्य स्वयं सोच की कठोरता बढ़ाता है
• डिज़ाइन डॉक्यूमेंट लिखते समय धुंधले विचारों को ठोस सोच में बदला जा सकता है

संगठन

• अच्छे डिज़ाइन डॉक्यूमेंट की संरचना उतनी ही महत्वपूर्ण है जितनी code organization
• जैसे शुरुआती लोग कोड लिखते हैं, वैसे ही बहुत से लोग 'spaghetti design document' लिखने की प्रवृत्ति रखते हैं
• यदि वाक्यों को तार्किक क्रम के बिना रखा जाए, तो पाठक के लिए संदर्भ का पीछा करना कठिन हो जाता है और भ्रम पैदा होता है
• एक उत्कृष्ट दस्तावेज़ में पाठक चौंकना नहीं चाहिए; प्रवाह स्वाभाविक होना चाहिए, और हर वाक्य पिछले बिंदु के आधार पर स्वाभाविक रूप से आगे बढ़ना चाहिए
• लक्ष्य यह है कि पाठक की वर्तमान सोच की स्थिति को समझकर उसे चरणबद्ध तरीके से नई स्थिति तक ले जाया जाए
• संभावित आपत्तियों को पहले से दूर करना चाहिए, और पाठक के प्रतिवाद करने से पहले ही स्पष्टीकरण देना चाहिए

संपादन

• सामग्री को अच्छी तरह व्यवस्थित करने के बाद अनावश्यक शब्द हटाने (editing) का चरण महत्वपूर्ण है
• पाठक का ध्यान एक सीमित संसाधन है, इसलिए अनावश्यक जानकारी को साहसपूर्वक हटाना चाहिए
• एक draft से लगभग 30% निरर्थक अभिव्यक्तियाँ कम की जा सकती हैं
• दूसरों के दस्तावेज़ संपादित करते हुए आलोचनात्मक दृष्टि विकसित की जाए, तो अपनी लिखाई को भी अधिक प्रभावी ढंग से निखारा जा सकता है
• छोटे tweets (280-character limit) के साथ अभ्यास करना भी सोच को सरल बनाने और संक्षेपण क्षमता बढ़ाने में मदद करता है

अनुभव और अभ्यास

• दोहराया गया अभ्यास जितना कौशल बढ़ाता है, उतना तेज़ कोई और रास्ता नहीं है
• Amazon में document-first culture का अनुभव, दस्तावेज़ लेखन क्षमता सुधारने में बहुत सहायक रहा
• महत्वपूर्ण मीटिंग्स में 1–6 पन्नों के डिज़ाइन डॉक्यूमेंट बाँटने के बाद, सभी लोग चुपचाप पढ़ते हैं और मार्जिन में अपने विचार लिखते हैं
• feedback लेते हुए लेखन कौशल को वास्तव में बेहतर बनाया जा सकता है

ठोस सुझाव

छोटे पैराग्राफ का उपयोग

• डिज़ाइन डॉक्यूमेंट को लगातार संक्षिप्त bullet points के माध्यम से प्रवाह बनाना चाहिए
• हर bullet point (observation, idea, problem, improvement आदि) एक अवधारणा पर केंद्रित छोटे पैराग्राफ से बना होना चाहिए
• हर पैराग्राफ इतना स्पष्ट होना चाहिए कि उसे एक वाक्य में सारांशित किया जा सके; इससे पाठक की short-term memory पर भार कम होता है

appendix का उपयोग

• जटिल calculations या simulation results को दस्तावेज़ के मुख्य भाग में नहीं, बल्कि appendix में विस्तार से रखना चाहिए, और मुख्य भाग में उनका केवल संक्षिप्त footnote जैसा उल्लेख होना चाहिए
• मुख्य निष्कर्ष समझने के लिए appendix आवश्यक नहीं होना चाहिए; इसे उन पाठकों के लिए दिया जाना चाहिए जो अधिक गहराई में देखना चाहते हैं

संपादन उदाहरण

• (संपादन से पहले, लंबा पैराग्राफ):

  हर bullet point दस्तावेज़ में एक अलग पैराग्राफ होना चाहिए। हर पैराग्राफ को एक वाक्य में सारांशित किया जा सकना चाहिए। वास्तव में उसका एक ही वाक्य होना ज़रूरी नहीं है; अवधारणा समझाने के लिए अतिरिक्त व्याख्या हो सकती है। लेकिन पढ़ने के बाद पाठक उसे एक वाक्य में समेट सके, यह ज़रूरी है।

• (संपादन के बाद, संक्षिप्त पैराग्राफ):

  हर bullet point एक पैराग्राफ होना चाहिए और उसे एक वाक्य में सारांशित किया जा सकना चाहिए। उसका वास्तव में एक ही वाक्य होना ज़रूरी नहीं है, और ज़रूरत पड़ने पर अतिरिक्त व्याख्या जोड़ी जा सकती है। लेकिन पढ़ने के बाद उसे एक वाक्य में संक्षेपित किया जा सकना चाहिए।

समापन

• डिज़ाइन डॉक्यूमेंट सोच की कठोरता, तार्किक प्रवाह, पाठक-केंद्रित संपादन, और दोहराए गए अभ्यास के माध्यम से क्षमता विकसित करने की एक महत्वपूर्ण प्रक्रिया है