शुरुआती लोगों के लिए प्रोग्रामिंग के बारे में लेख कैसे लिखें

हाल ही में Habré पर उन लेखों या प्रोग्रामिंग के अन्य पहलुओं के बारे में बहुत सारे लेख दिखाई देने लगे जो "शुरुआती" के लिए लेख के रूप में तैनात हैं। इस बीच, बस शुरुआती लोगों के लिए, ये लेख अक्सर समझ से बाहर हैं: कभी-कभी वे बहुत जटिल होते हैं, कभी-कभी वे उन सवालों के जवाब नहीं देते हैं जो उन्हें चाहिए, कभी-कभी उन्हें समझना मुश्किल होता है।

आइए यह जानने की कोशिश करें कि लेख कैसे लिखा जाना चाहिए, अगर आप चाहते हैं कि यह न केवल पसंद किया जाए, बल्कि पाठकों के लिए भी उपयोगी हो।

अपने लक्षित दर्शकों को परिभाषित करें

अपने लक्षित दर्शकों को परिभाषित करके शुरू करें। "शुरुआत" की अवधारणा बहुत अस्पष्ट है। यहां कुछ पूरी तरह से अलग-अलग श्रेणियों के लोग हैं जिन्हें "शुरुआती" कहा जा सकता है:

• एक व्यक्ति जिसने कभी भी प्रोग्रामिंग के बारे में नहीं सुना है, और सीखना चाहता है कि कोड कैसे लिखना है।
• एक व्यक्ति जो सैद्धांतिक नींवों में से कुछ जानता है (संकलक क्या करता है, संकलन व्याख्या से कैसे भिन्न होता है, कोड लिखने की प्रक्रिया कैसे होती है), लेकिन उसने कभी भी कोड खुद नहीं लिखा
• एक व्यक्ति जो प्रोग्रामिंग में लगा हुआ था, लेकिन थोड़ा अलग प्रोफ़ाइल पर स्विच करना चाहता है (उदाहरण के लिए, एक व्यक्ति साधारण वेबसाइटों को टाइप करता है और जावास्क्रिप्ट को जानता है, लेकिन सीखना चाहता है कि डेस्कटॉप एप्लिकेशन कैसे बनाए जाएं)
• अंत में, एक व्यक्ति जो प्रोग्रामिंग से काफी परिचित है, लेकिन अपने लिए एक नई भाषा या तकनीक सीखना चाहता है।

मुझे लगता है कि यह स्पष्ट है कि विभिन्न स्तरों वाले लोगों पर लक्षित लेख पूरी तरह से अलग दिखेंगे। हालांकि, "शुरुआती लोगों के लिए" चिह्नित किए गए अधिकांश लेख उन लोगों के उद्देश्य से हैं जो प्रोग्रामिंग से सतही रूप से परिचित हैं।

अपने लेख को समझने के लिए आवश्यक बुनियादी ज्ञान को पहचानें।

सहमत हूं, बहुत शुरुआत में लिखना इतना मुश्किल नहीं है जैसे:

"इस लेख को समझने के लिए, पाठक को C का प्रारंभिक ज्ञान होना चाहिए:
- आवेदन को संकलित करने और चलाने में सक्षम हो
- सिंटैक्स, मूल डेटा प्रकार और प्रबंधन संरचनाओं को जानें ”

इसमें ज्यादा समय नहीं लगता है, लेकिन यह पाठकों को बहुत मदद करता है। मेरा विश्वास करो, यदि आप इस तरह से लेख शुरू करते हैं:

निम्नलिखित कोड संकलित करें:

int main(int argc, char *argv[]) { cout<<"Hello, world!"; } 

तब पाठकों को यह समझ में नहीं आ सकता है कि उनकी क्या आवश्यकता है। मत भूलो, एक बार जब आप यह भी नहीं जानते थे कि संकलक का उपयोग कैसे करें।

लेख को जितना हो सके उतना अच्छा बनाएं

अच्छा और सक्षम डिज़ाइन सामग्री की आसान समझ की कुंजी में से एक है।

पूरा कोड लिखने की कोशिश करें

मैंने उन लेखों और पुस्तकों को देखा जिनमें कोड अलग-अलग टुकड़ों में दिए गए थे। यह इस तथ्य की ओर जाता है कि पाठक के लिए कोड को समझना मुश्किल है, इस तथ्य का उल्लेख नहीं करना कि वह केवल इस कोड को कॉपी और चला नहीं सकता है। बेशक, आप कर सकते हैं, उदाहरण के लिए, अलग-अलग लिस्टिंग में अलग-अलग फ़ंक्शन लिखें। यह और भी अच्छा है, क्योंकि इससे समझने में आसानी होती है। लेकिन कोड के एक तार्किक सजातीय टुकड़े को फाड़ मत करो।

इस तरह न लिखें:

एक उदाहरण कार्यक्रम जो "हैलो, वर्ल्ड" प्रदर्शित करता है:

 //   int main(int argc, char *argv[]) { cout<<"Hello, world!"; 

कुछ (संभवतः काफी उपयोगी)
लेखक की बहु-पंक्ति टिप्पणी

 // return 0; } 

इस तरह लिखें:

एक उदाहरण कार्यक्रम जो "हैलो, वर्ल्ड" प्रदर्शित करता है:

 #include <iostream> using namespace std; int main(int argc, char *argv[]) { cout<<"Hello, world!"; return 0; } 

यहाँ आप एक लंबी और विस्तृत टिप्पणी लिख सकते हैं, और उस पंक्ति को फिर से लिख सकते हैं

 cout<<"Hello, world!"; 

जिसे वह संदर्भित करता है।

यदि आपको कोड को कई लिस्टिंग में तोड़ने की आवश्यकता है, तो लेख के अंत में एक बार फिर से सभी कोड को एक सूची में सूचीबद्ध करना अच्छा होगा, या यहां तक ​​कि एक लिंक भी दें जिससे यह कोड डाउनलोड किया जा सके।

हमेशा लेख में डालने से पहले कोड की जाँच करें।

पाठक कम से कम बैठना चाहता है और यह समझने की कोशिश करना चाहता है कि लेख से उदाहरण काम नहीं करता है।
इसी कारण से, यदि आपका कोड किसी तरह पर्यावरण या संकलक पर निर्भर करता है, तो इसे अलग से निर्दिष्ट करें।

हमेशा कमेंट कोड

मैंने एक लाख बार देखा है कि एक एकल टिप्पणी के बिना एक पुस्तक में 3-पृष्ठ की लिस्टिंग कैसे पाई जाती है, और फिर पूर्ण पाठ में यह वर्णन होता है कि यह कोड क्या करता है। ऐसी चीजों को पढ़ना बहुत मुश्किल होता है। कोड में ही छोटी टिप्पणियाँ लिखने का प्रयास करें:

 #include <iostream> //   cout using namespace std; //cout     std int main(int argc, char *argv[]) { cout<<"Hello, world!"; //  "hello, world" return 0; } 

यह मत भूलो कि यदि एक स्ट्रिंग का मूल्य आपके लिए स्पष्ट है, तो इसका मतलब यह नहीं है कि यह सभी के लिए स्पष्ट है। यदि आप कोड पर विस्तार से टिप्पणी करना चाहते हैं, तो लाइन नंबर डालना एक अच्छा विचार है। एक पंक्ति में सभी पंक्तियों को संख्या करने की आवश्यकता नहीं है, बस यह करें:

 1 #include <iostream> using namespace std; 4 int main(int argc, char *argv[]) { 6 cout<<"Hello, world!"; return 0; } 

पंक्ति 1 में, हम एक हेडर फ़ाइल शामिल करते हैं जिसमें C ++ में स्ट्रीमिंग I / O के साथ काम करने के लिए आवश्यक कक्षाएं, फ़ंक्शंस और चर शामिल हैं। हम इस फ़ाइल को cout ऑब्जेक्ट का उपयोग करने के लिए शामिल करते हैं, जो एक मानक आउटपुट स्ट्रीम है।

पंक्ति 4 में , मुख्य कार्य शुरू होता है - यह इस बिंदु से है कि हमारे कार्यक्रम का काम शुरू होगा।

अंत में, लाइन 6 पर, हम मानक कॉउट आउटपुट स्ट्रीम में "हैलो, वर्ल्ड" वाक्यांश का उत्पादन करते हैं। << ऑपरेटर का उपयोग करते हुए एक काफी सरल वाक्यविन्यास का उपयोग किया जाता है। ऑपरेटर के बाईं ओर स्ट्रीम ऑब्जेक्ट (हमारे मामले में, कटआउट) लिखा जाता है, दाईं ओर वह अभिव्यक्ति है जिसे इस स्ट्रीम में आउटपुट किया जाना चाहिए।

यदि आप चाहते हैं कि पाठक कोड को कॉपी और चलाने में सक्षम हो, तो आप टिप्पणियों में लाइन नंबर निर्दिष्ट कर सकते हैं, हालांकि यह कम स्पष्ट है:

 #include <iostream> //(1)    cout using namespace std; //(2) cout     std int main(int argc, char *argv[]) { cout<<"Hello, world!"; //(6)   "hello, world" return 0; } 

अपने आप को पाठक के स्थान पर रखें

कल्पना करें कि आपके उदाहरणों में कौन से स्थान बहुत स्पष्ट नहीं हो सकते हैं, और उन्हें और अधिक विस्तार से समझा सकते हैं। यदि आप कुछ चीजों का वर्णन करने के लिए बहुत आलसी हैं, जो इंटरनेट या पुस्तकों पर ढूंढना आसान है, तो बस एक संसाधन का लिंक दें जहां आप इसके बारे में पढ़ सकें।

कोड को बहुत अधिक जटिल न करने और पूर्णतावाद से बचने का प्रयास करें

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

 template<class T> T compare(T a, T b) { return a>b?a:b; } 

एक सरल और स्पष्ट कोड लिखें:

 int compare(int a, int b) { if(a>b) { return a; } else { return b; } } 

इसे दस बार बेहतर बनाने दें - यह महत्वपूर्ण नहीं है कि क्या आपका कार्य विधि का सार दिखाना है, न कि इसका विशिष्ट कार्यान्वयन।

पूरे लेख में एक ही स्तर पर रहने की कोशिश करें।

यदि आप एक बुनियादी स्तर पर एक लेख लिखना शुरू करते हैं और सरल चीजों के बारे में विस्तार से बात करते हैं, तो लेख के बहुत अंत तक ऐसा करें। यदि एक लेख के बीच में आप अचानक कुछ चीजों को समझाना बंद कर देते हैं, तो पाठक पूरी तरह से लेख के धागे को खो सकता है और भ्रमित हो सकता है।

पूरे लेख में एक ही शैली से चिपके रहें

इससे कोई फर्क नहीं पड़ता कि आप "अकादमिक" शैली में लिखते हैं, या "अब, आदमी, हम अपनी रचना को संकलित करेंगे।" यह महत्वपूर्ण है कि आप सुसंगत हैं और औपचारिक से अनौपचारिक कथा तक वापस नहीं जाते हैं और प्रति लेख दस बार वापस आते हैं।

अपने विचारों को संरचना करने की कोशिश करें

आप प्रोग्रामिंग के बारे में बात कर रहे हैं - जिसका अर्थ है कि आपकी कहानी को मुख्य भागों में विभाजित करना सबसे आसान है। हमेशा ऐसा करने की कोशिश करें क्योंकि एक संरचित लेख पढ़ने और समझने में बहुत आसान है। पाठ की एक ठोस दीवार को पकड़ना बेहद मुश्किल है, भले ही पाठ स्वयं काफी सरल चीजों के बारे में बात करे।

पाठक की मदद करने की कोशिश करें।

टिप्पणियों में विनम्र रहें। यदि आपको कुछ और विस्तार से बताने, या लेख में कुछ जोड़ने के लिए कहा जाता है, तो इसे करने का प्रयास करें (बेशक, यदि आपके पास ऐसा करने के लिए समय और ऊर्जा है)।

निष्कर्ष

मुझे उम्मीद है कि मेरा लेख लेखकों को अपने लेखों को अधिक समझने और अधिक लोकप्रिय बनाने में मदद करेगा। कृपया टिप्पणियों में लिखें यदि आप किसी भी बिंदु से सहमत नहीं हैं, या अपने खुद के कुछ जोड़ना चाहते हैं।