इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- AboutCode
- तकनीकी लेखक:
- अयानसिन्हा
- प्रोजेक्ट का नाम:
- स्कैनकोड टूलकिट में कमांड लाइन के विकल्पों के बारे में बताया गया है. साथ ही,aboutcode.readthedocs.io पर इसके बारे में जानकारी देने वाले दस्तावेज़ के स्ट्रक्चर को फिर से व्यवस्थित किया जा सकता है
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
[ 1. स्कैनकोड-टूलकिट आदेश पंक्ति विकल्प ]
स्कैनकोड-टूलकिट में, कमांड लाइन के कई विकल्प मौजूद होते हैं. इनकी मदद से, स्कैन करने के तरीके, आउटपुट फ़ॉर्मैट, और पोस्ट-स्कैन प्लगिन जैसे कई विकल्पों को कस्टमाइज़ किया जा सकता है. फ़िलहाल, इन विकल्पों में जानकारी देने के लिए ज़रूरी दस्तावेज़ नहीं हैं. ये विकल्प सिर्फ़ “--help” या “-h” फ़्लैग के ज़रिए उपलब्ध हैं. इस प्रोजेक्ट का पूरा दस्तावेज़ बनाना है, जो यह जानकारी देता हो:
[ 1. आदेश पंक्ति के माध्यम से उपलब्ध सभी विकल्प ]
- लक्ष्य: कमांड लाइन के ज़रिए सभी संभावित विकल्पों की पूरी सूची.
- बुनियादी जानकारी: सबसे पहले, स्कैन के डिफ़ॉल्ट विकल्पों के बारे में बताया गया है. साथ ही, आउटपुट के उदाहरण के बारे में बताया गया है. स्कैन की प्रोसेस के बारे में कम शब्दों में दिया गया ग्राफ़िक/ब्यौरा.
इसके बाद, यह डिफ़ॉल्ट तरीका इस बात के रेफ़रंस के तौर पर काम करता है कि अन्य विकल्प, स्कैन और आउटपुट में कैसे बदलाव करते हैं.
इन पर विस्तार से चर्चा की जाएगी. इसमें नीचे दी गई जानकारी होगी, जैसा कि अगले सेक्शन में बताया गया है.
[ 2. वर्शनिंग स्ट्रक्चर शुरू करें ]
- लक्ष्य: क्रॉस-रिलीज़ विकल्पों/एपीआई और दस्तावेज़ में हुए बदलावों को ठीक से बनाए रखने के लिए, वर्शनिंग सिस्टम शुरू करें.
- समस्या: वर्तमान में विकी और ReadTheDocs के दस्तावेज़ पुरानी रिलीज़ के लिए हैं और उन्हें बड़े पैमाने पर फिर से बनाने की ज़रूरत है.
- बुनियादी खास जानकारी: स्कैनकोड-टूलकिट के जिन हिस्सों को वर्शन में अपडेट किया गया है/अपडेट किया जा सकता है वे हैं
- आदेश पंक्ति विकल्प
- API
- दस्तावेज़ (शुरू किया जाना है) कमांड लाइन विकल्प और एपीआई, वर्शन और रिलीज़ में बदल दिए जाते हैं. इसके अलावा, दस्तावेज़ को भी फ़ॉलो करना होगा या इससे उपयोगकर्ताओं के लिए बड़ी उलझन पैदा होगी. कमांड लाइन यूटिलिटी [ --help ] को पहले से ही, विकल्पों में किसी भी बदलाव के लिए अपडेट किया गया है और इसका इस्तेमाल दस्तावेज़ में दिए गए वर्शन को कॉपी करने के लिए किया जा सकता है.
[ 3. अलग-अलग मामलों में इन विकल्पों का इस्तेमाल कैसे किया जा सकता है ]
- लक्ष्य: यह सेक्शन इस बारे में बुनियादी जानकारी देगा कि स्कैनकोड-टूलकिट के स्कैन नतीजों को अलग-अलग वजहों में कैसे इस्तेमाल किया जा सकता है. साथ ही, इसमें ऐसे फ़ंक्शन उपलब्ध कराने वाले स्कैनकोड-टूलकिट विकल्प भी बताए जाएंगे.
- बुनियादी जानकारी: इस सेक्शन में, इस्तेमाल के अलग-अलग उदाहरण की जानकारी दी गई है. साथ ही, यह भी बताया गया है कि ऐसी स्थितियों में कौनसे विकल्प इस्तेमाल करने का सुझाव दिया जाता है.
- ध्यान दें: इस चरण को पूरा करने के लिए, स्कैनकोड-टूलकिट के इस्तेमाल के अलग-अलग उदाहरणों के बारे में इनपुट और पॉइंटर के तौर पर, मेंटॉर की मदद की ज़रूरत होती है.
[ 4. स्कैन और आउटपुट में ये विकल्प क्या बदलते हैं ]
- लक्ष्य: यह सेक्शन इस बारे में बुनियादी जानकारी देगा कि स्कैनकोड-टूलकिट के स्कैन नतीजों का अलग-अलग वजहों में इस्तेमाल कैसे किया जा सकता है. साथ ही, इसमें आपको इस तरह की सुविधा देने वाले 'इसके बारे में जानकारी' टूल के बारे में भी जानकारी मिलेगी.
- बुनियादी खास जानकारी: ये विकल्प स्कैन करने के तरीके को बदलते हैं. शुरुआती सेक्शन में एक बेसिक डिफ़ॉल्ट केस दिखाया जाएगा [ 1. आदेश पंक्ति ] के माध्यम से उपलब्ध सभी विकल्प और यह अनुभाग इस डिफ़ॉल्ट स्थिति में सभी विकल्पों की वजह से होने वाले बदलावों की तुलना करेगा.
[ 5. आउटपुट फ़ॉर्मैट और उनके उदाहरण ]
- लक्ष्य: यह सेक्शन इस बारे में बुनियादी जानकारी देगा कि स्कैनकोड-टूलकिट के स्कैन नतीजों का अलग-अलग वजहों में इस्तेमाल कैसे किया जा सकता है. साथ ही, इसमें आपको इस तरह की सुविधा देने वाले 'इसके बारे में जानकारी' टूल के बारे में भी जानकारी मिलेगी.
- बुनियादी जानकारी: स्कैन कोड टूल में, स्कैन के नतीजे जनरेट करने के लिए अलग-अलग आउटपुट फ़ॉर्मैट तय करने के लिए फ़्लैग होते हैं. ये हैं -
इस हिस्से में - आउटपुट फ़ॉर्मैट की पूरी जानकारी देते हैं,
- आउटपुट फ़ॉर्मैट के उदाहरण दो
- आउटपुट फ़ॉर्मैट और उसके इस्तेमाल से जुड़े अन्य लिंक दें
- आउटपुट फ़ाइलों में स्कैन के नतीजे कैसे सेव होते हैं. यह इस बारे में भी बताता है कि ये अलग-अलग फ़ॉर्मैट कैसे जनरेट किए जाते हैं, इस बारे में [ 2. कोड स्कैनिंग के बारे में चर्चा ].
[ 6. कारोबार के लिए स्कैनकोड आउटपुट फ़ॉर्मैट का इस्तेमाल ]
- लक्ष्य: स्कैनकोड आउटपुट फ़ॉर्मैट के कारोबारी इस्तेमाल के मामलों की जानकारी दें जीएसओडी आइडिया की सूची में, स्कैनकोड आउटपुट फ़ॉर्मैट का रेफ़रंस आइडिया के तौर पर दिया गया है. यह सेक्शन भी यही लागू करता है.
- ध्यान दें: इस हिस्से के लिए, स्कैनकोड-टूलकिट के कारोबार के अलग-अलग इस्तेमाल के उदाहरणों के बारे में इनपुट और पॉइंटर के तौर पर, मेंटॉर की मदद की ज़रूरत होती है.
[ 7. ज़्यादा विश्लेषण के लिए, अन्य इसके बारे में कोड प्रोजेक्ट में इन आउटपुट का इस्तेमाल कैसे किया जाता है ]
- लक्ष्य: यह सेक्शन इस बारे में बुनियादी जानकारी देगा कि स्कैनकोड-टूलकिट के स्कैन नतीजों का अलग-अलग वजहों में इस्तेमाल कैसे किया जा सकता है. साथ ही, इसमें आपको इस तरह की सुविधा देने वाले 'इसके बारे में जानकारी' टूल के बारे में भी जानकारी मिलेगी.
- बुनियादी खास जानकारी:
- स्कैनकोड-वर्कबेंच यह हिस्सा, डेस्कटॉप ऐप्लिकेशन और पॉइंटर से नतीजों को विज़ुअलाइज़ करने के बारे में बताता है, ताकि कोड-वर्कबेंच दस्तावेज़ को स्कैन करके उसी चीज़ के लिए ज़्यादा सहायता मिल सके. अगर ज़रूरी हो, तो स्कैनकोड-वर्कबेंच के लिए ज़रूरी दस्तावेज़ जोड़ दिया जाएगा.
- Deltacode दो कोडबेस के बीच फ़ाइल लेवल का अंतर तय करने के लिए, Deltacode से स्कैनकोड नतीजे कैसे लिए जाते हैं.
[ 2. इसके बारे में जानकारी देने वाले कोड से जुड़े दस्तावेज़ के स्ट्रक्चर को फिर से व्यवस्थित करें ]
इस हिस्से में, 'इसके बारे में जानकारी' कोड वाले दस्तावेज़ में हुए कई बदलाव शामिल हैं
[ 1. वर्शनिंग सिस्टम ]
[ 1. स्कैनकोड-टूलकिट कमांड लाइन विकल्प -> 2. वर्शनिंग स्ट्रक्चर शुरू करें] कमांड लाइन के विकल्पों को वर्शन देने की समस्या के बारे में बताया गया है. दस्तावेज़ के अन्य हिस्सों के लिए भी यह ज़रूरी है, जिनमें वर्शन के हिसाब से खास निर्देश/जानकारी भी शामिल है. इससे भ्रम की स्थिति पैदा हो सकती है.
[ 2. दस्तावेज़ के लिए मानक और जांच सेट करना ]
दस्तावेज़ में पहले से ही Spinx-build (सभी पेजों को बनाता है और पूरे दिन स्फ़िंक्स सिंटैक्स गड़बड़ियों की जांच करता है) के लिए परीक्षण मौजूद हैं. Travis-CI के ज़रिए ऑनलाइन इंटिग्रेशन के साथ (दस्तावेज़ में दिए गए दूसरे वेबपेजों के सभी लिंक की जांच करता है) लिंक की जांच करता है. (मैंने इस पुल अनुरोध #17 में जो जानकारी जोड़ी है ) अब इसे रीस्ट्रक्चर्ड टेक्स्ट और दूसरे स्टैंडर्ड में खास लिंटिंग की ज़्यादा जांच करने की ज़रूरत है. यह काम, रीस्ट्रक्चर्ड टेक्स्ट-लिंट की मदद से किया जा सकता है. हालांकि, अभी इस पर और रिसर्च की ज़रूरत है. इसे हमारे GSoD प्रोजेक्ट के हिस्से के तौर पर पूरा किया जाएगा.
[ 3. “शुरू करना” सेक्शन को जोड़ना ]
यह नए उपयोगकर्ताओं के लिए शुरुआती सेक्शन के तौर पर काम करेगा. इसमें 'इसके बारे में जानकारी' प्रोजेक्ट का इस्तेमाल शुरू करने के लिए, सबसे बुनियादी और ज़रूरी दस्तावेज़ों का एक कंपाइलेशन होगा. हर इसके बारे में कोड प्रोजेक्ट में यह सेक्शन होगा, जैसे कि स्कैनकोड टूलकिट, स्कैनकोड-वर्कबेंच, डेल्टाकोड वगैरह.
[ 4. दस्तावेज़ के चार फ़ंक्शन के हिसाब से फिर से स्ट्रक्चर करना ]
मौजूदा दस्तावेज़ को इन चार फ़ंक्शन में साफ़ तौर पर नहीं लिखा गया है - ट्यूटोरियल, कैसे करें, रेफ़रंस, और एक्सप्लेनेशंस. इसलिए, हमारा सुझाव है कि ज़रूरत पड़ने पर, हम ऐसे नियमों को ध्यान में रखते हुए ज़्यादा जानकारी/एक्सप्लेनेशन/पॉइंटर जोड़ें. यह जानकारी सभी परिचय कोड प्रोजेक्ट और उनके दस्तावेज़ों पर लागू होती है. नीचे स्कैनकोड-टूलकिट दस्तावेज़ को फिर से बनाने के दो उदाहरण दिए गए हैं, जिनका मैं सुझाव देता/देती हूं और जिन्हें इस प्रोजेक्ट में जारी रखना है. बाकी दस्तावेज़ों में इसी तरह के बदलाव किए जाएंगे.
[ 5. डेवलपमेंट पेज की रीस्ट्रक्चरिंग (स्कैनकोड-टूलकिट) ]
कोड/एपीआई के बारे में ज़्यादा जानकारी, डेवलपर के लिए आसानी से उपलब्ध कराई जा सकती है. ऐसे कई लिंक दिए जा सकते हैं जो [ 2. ऊपर दिए गए कोड स्कैनिंग ] सेक्शन के बारे में बातचीत. इसमें यह जानकारी दी गई है कि स्कैन करने के लिए इस्तेमाल होने वाले कोड से स्कैन कैसे काम करता है. जैसे कि इन फ़ोल्डर में स्कैनकोड-टूलकिट के अलग-अलग हिस्से मौजूद होते हैं, उनके हर इस्तेमाल को एपीआई की मदद से समझा जा सकता है. साथ ही, स्कैनकोड के काम करने के तरीके पर चर्चा भी की जा सकती है.
- [ क्लूकोड : लाइसेंस, कॉपीराइट, यूआरएल, ईमेल स्कैन करने के लिए प्लगिन ]
- [ कॉमनकोड : हेल्पर क्लास और फ़ंक्शन]
- [्स्ट्रैक्टकोड : अलग-अलग संग्रह फ़ॉर्मैट एक्सट्रैक्ट करता है ]
- [फ़ॉर्मैट कोड : अलग-अलग आउटपुट फ़ाइल फ़ॉर्मैट के लिए आउटपुट फ़ॉर्मैटिंग ]
- [लाइसेंस वाला कोड : लाइसेंस की पहचान करने वाला कोड ]
- [ Packagedcode : विभिन्न पैकेज प्रारूप पार्स करना ]
- [ प्लगिनकोड : प्लगिन आर्किटेक्चर के लिए क्लास ]
- [ समरीकोड : पता लगाए गए लाइसेंस पर स्कैन की खास जानकारी देता है ]
- [ टेक्स्टकोड : टेक्स्ट पार्सिंग को हैंडल करता है ]
- [ टाइपकोड : फ़ाइल टाइप के निर्धारण मैनेज करता है ]
- [ स्कैनकोड : स्कैनकोड के लिए सीएलआई और एपीआई, मुख्य हिस्सा ]
इस सब-सेक्शन में, स्कैनकोड-टूलकिट के इन हिस्सों के बारे में ज़्यादा जानकारी/एपीआई मौजूद होंगे. डेवलपमेंट से जुड़े दिशा-निर्देश, दूसरे पेज या अन्य सेक्शन में मौजूद होंगे. इसमें छोटे-छोटे सब-सेक्शन होंगे.
[ 6. अक्सर पूछे जाने वाले सवालों के पेज को फिर से बनाना (Scancode-Toolkit) ]
फ़िलहाल, अक्सर पूछे जाने वाले सवालों के पेज में ऐसे सवाल हैं जिनका बेहतर जवाब दिया जा सकता है. इसलिए, इन्हें 'कैसे करें' सेक्शन, ट्यूटोरियल, और पहचान फ़ाइलों के लिए अलग-अलग दस्तावेज़ों के तौर पर अलग-अलग रखा जाना चाहिए.
- स्कैनकोड कैसे काम करता है? इस समस्या का रेफ़रंस [ 2. कोड स्कैनिंग ] के बारे में होने वाली चर्चाएं और ज़्यादा जानकारी के लिए पूरी तरह से एक अलग सेक्शन होगी.
- बेहतर तरीके से पहचान करने के लिए, लाइसेंस के नए नियम कैसे जोड़ें? मौजूदा 'कैसे करें' निर्देशों को बेहतर बनाने के लिए, इस समस्या पर पहले ही चर्चा की जा चुकी है. इन्हें वहां ले जाया जाएगा.
- लाइसेंस की पहचान करने का नया नियम कैसे जोड़ें? इसे अलग से, “कैसे करें” पोस्ट में लिखा जा सकता है और इसके बारे में विस्तार से बताया जा सकता है.
- डेवलपमेंट शुरू कैसे करें? इस पर पहले से ही एक अलग डेवलपमेंट पेज है और जानकारी ओवरलैप हो रही है. डेवलपमेंट पेज को फिर से बनाने के बारे में ऊपर पहले ही चर्चा की जा चुकी है.
- किसी नई रिलीज़ को कट करने का तरीका इसे “नई रिलीज़ को कैसे कट करें” में बदला जा सकता है.
- अक्सर पूछे जाने वाले ऐसे सवालों को ढूंढें जो प्रोजेक्ट से जुड़े सामान्य सवालों के जवाब देते हैं. ये सवाल “कैसे करें”/”ट्यूटोरियल” कैटगरी में नहीं आते हैं.