अप्रोच

हर अभ्यास के साथ कुछ अप्रोच जुड़ी हो सकती हैं, जो बताती हैं कि उस अभ्यास को किन-किन अलग तरीकों से हल किया जा सकता है।

अप्रोच

किसी अप्रोच में यह समझाया जाना चाहिए कि किसी अभ्यास को किसी खास तरीके से कैसे हल किया जा सकता है।

• इसकी सामग्री में या तो यह शामिल होना चाहिए:
  • कोई आइडियोमैटिक अप्रोच समझाइए
  • कोई गैर-आइडियोमैटिक, लेकिन दिलचस्प अप्रोच समझाइए
• शुरुआत एक (पूरे) कोड सैंपल से कीजिए
  • बाकी दस्तावेज़ में खुलकर कोड सैंपल इस्तेमाल कीजिए
• आप बेझिझक इस विषय की गहराई में जा सकते हैं
• काम के संसाधनों (जैसे डॉक्युमेंटेशन) के लिंक दीजिए
• स्निपेट में अप्रोच का मूल दिखना चाहिए
  • इसमें ज़्यादा से ज़्यादा 8 लाइनें इस्तेमाल की जा सकती हैं

अगर आप अलग-अलग अप्रोच की तुलना करना चाहते हैं, तो कृपया एक आर्टिकल लिखिए।

अप्रोच का अवलोकन

• समस्या का संदर्भ दीजिए
  • उन ज़रूरी बातों के बारे में बताइए (जैसे आम गलतियाँ) जो सभी अप्रोच पर लागू होती हैं
• सबसे आइडियोमैटिक अप्रोच पर चर्चा कीजिए
• हर अप्रोच की शुरुआत एक स्निपेट से होनी चाहिए, जो उस अप्रोच को दिखाए
• सामग्री को काफी हद तक ऊपरी स्तर पर ही रखिए
  • बारीक जानकारी अलग से बने अप्रोच पेज में जानी चाहिए
  • ज़्यादा जानकारी के लिए उस अलग अप्रोच पेज का लिंक दीजिए
• यह भी बताइए कि अलग-अलग अप्रोच में से चुनाव कैसे करें
  • इनमें क्या फायदे और क्या नुकसान हैं?
  • क्या कुछ अप्रोच कुछ खास उपयोगों के लिए ज़्यादा उपयुक्त हैं?

सामान्य बातें

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

किन अभ्यासों के लिए अप्रोच लिखनी चाहिए?

आम तौर पर अप्रोच लिखने के लिए प्रैक्टिस अभ्यास ज़्यादा उपयुक्त होते हैं, क्योंकि इन्हें आमतौर पर कई तरीकों से हल किया जा सकता है।

कॉन्सेप्ट अभ्यास के लिए एग्ज़ेम्प्लर अप्रोच पर चर्चा करना दिलचस्प हो सकता है। जैसे, आप दिखा सकते हैं कि जो कॉन्सेप्ट सिखाया जा रहा है, उससे कुछ कोड लिखना कैसे आसान हो जाता है।

फाइलें

हर अप्रोच में नीचे दी गई दो फाइलें जोड़ना ज़रूरी है:

• .approaches/<approach-slug>/content.md: अप्रोच का विवरण (देखिए दस्तावेज़)
• .approaches/<approach-slug>/snippet.txt: अप्रोच दिखाने वाला स्निपेट (देखिए दस्तावेज़)

इसके बाद आपको यह जोड़ना या अपडेट करना होगा:

• .approaches/config.json: अप्रोच का मेटाडेटा (देखिए दस्तावेज़)

स्निपेट एक्सटेंशन कॉन्फिगर करना

आप अपनी ट्रैक की config.json फाइल में approaches.snippet_extension फील्ड सेट करके डिफॉल्ट .txt एक्सटेंशन की जगह कोई कस्टम एक्सटेंशन भी इस्तेमाल कर सकते हैं। अगर यह सेट हो, तो आपको जोड़नी वाली स्निपेट फाइल का नाम .approaches/<approach-slug>/snippet.<approaches.snippet_extension> होना चाहिए।