इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- CircuitVerse
- टेक्निकल राइटर:
- प्रगती
- प्रोजेक्ट का नाम:
- उपयोगकर्ता के लिए दस्तावेज़ और गाइड
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड अवधि (तीन महीने)
प्रोजेक्ट का विवरण
दर्शकों और उपयोगकर्ताओं के लिए उपलब्ध मौजूदा दस्तावेज़ों का बारीकी से विश्लेषण करने के बाद, मेरा सुझाव है कि दस्तावेज़ से जुड़े ये काम किए जाएं:
1) लोकप्रिय वर्कफ़्लो दिखाने और ऑनबोर्डिंग के अनुभव को बेहतर बनाने के लिए, वीडियो ट्यूटोरियल जोड़ें. वीडियो से किसी एक कॉन्सेप्ट के बारे में जानकारी मिलेगी. स्क्रीन पर यह कार्रवाई करते समय, वीडियो आपको एक निर्देश देंगे.
कॉम्बिनेशनल ऐनालिसिस टूल का इस्तेमाल करने के लिए, सैंपल वीडियो ट्यूटोरियल का लिंक यहां दिया गया है. https://www.youtube.com/watch?v=7FkeqBYcd1w पहला ध्यान दें: इस वीडियो में मौजूदा कॉन्टेंट का उदाहरण दिया गया है. इसका मकसद, वीडियो के स्टाइल को एक जैसा रखने के लिए, एनोटेशन का इस्तेमाल करने का तरीका बताना है. दूसरा नोट: CircuitVerse के लिए काम शुरू करने के बाद, मैं सॉफ़्टवेयर का लाइसेंस खरीदूंगा. साथ ही, फ़ाइनल प्रॉडक्ट में कोई वॉटरमार्क नहीं होगा.
वीडियो ट्यूटोरियल वर्कफ़्लो के लिए सुझाए गए विषय: --CrcuitVerse के साथ शुरू करना: CircuitVerse के साथ शुरू करने के लिए यह वीडियो ट्यूटोरियल देखें --कॉम्बिनेशन विश्लेषण टूल का इस्तेमाल करना: ट्रुथ टेबल डेटा का इस्तेमाल करके सर्किट बनाने का तरीका जानने के लिए, यह वीडियो ट्यूटोरियल देखें. --हाई रिज़ॉल्यूशन वाली इमेज एक्सपोर्ट करना: अपने सर्किट की हाई रिज़ॉल्यूशन वाली इमेज को कई फ़ॉर्मैट में एक्सपोर्ट करने का तरीका जानने के लिए यह वीडियो ट्यूटोरियल देखें --स्ट्रक्चर्ड डिज़ाइन के लिए सबसर्किट का इस्तेमाल करना: कॉम्प्लेक्स सर्किट की बनावट को आसान बनाने के लिए सब सर्किट बनाने का तरीका जानने के लिए यह वीडियो ट्यूटोरियल देखें --हेक्स-बिन-डेक कन्वर्टर टूल का इस्तेमाल करना: सर्किट डिज़ाइन और कन्वर्टर टूल के इस्तेमाल का तरीका जानने के लिए यह वीडियो ट्यूटोरियल देखें. --किसी दिए गए सर्किट के लिए सर्किट टाइमिंग डायग्राम को विज़ुअलाइज़ करना: किसी दिए गए सर्किट के लिए सर्किट टाइमिंग डायग्राम को विज़ुअलाइज़ करने के तरीके के बारे में जानने के लिए यह वीडियो ट्यूटोरियल देखें.
कुछ वीडियो ट्यूटोरियल, वेब पेजों और उपयोगकर्ता दस्तावेज़ों से इंटरलिंक किए जा सकते हैं.
2) ट्यूटोरियल वाला लैंडिंग पेज बनाएं. इससे, CircuitVerse प्लैटफ़ॉर्म के बारे में खास जानकारी दी जा सकती है. साथ ही, अलग-अलग वर्कफ़्लो का ग्राफ़िक व्यू भी दिया जा सकता है. उपयोगकर्ता, Circuitverse GitHub साइट पर एक ट्यूटोरियल लैंडिंग पेज ऐक्सेस करेंगे. इस पेज पर, अलग-अलग कॉन्टेंट वर्कफ़्लो के लिए दिए जाने वाले अलग-अलग ट्यूटोरियल की जानकारी दी जाएगी. इससे उपयोगकर्ता, अपनी ज़रूरत के हिसाब से अलग-अलग ट्यूटोरियल देख सकते हैं और उन्हें चुन सकते हैं. नीचे ट्यूटोरियल लैंडिंग पेज के पेज स्ट्रक्चर का मोटे तौर पर सैंपल दिया गया है.
3) सिलसिलेवार निर्देशों वाले ट्यूटोरियल बनाएं, ताकि उपयोगकर्ताओं को यह पता चल सके कि बुनियादी और जटिल सर्किट के व्यवहार को जानने और उसका विश्लेषण करने के लिए, टूल का इस्तेमाल कैसे किया जा सकता है. साथ ही, टूल का इस्तेमाल करके उसे सिखाना. CircuitVerse के चुनिंदा प्रोजेक्ट के बारे में बताते हुए, मेरा सुझाव है कि शुरुआती और इंटरमीडिएट लेवल के उपयोगकर्ताओं के लिए, कम से कम पांच ट्यूटोरियल जोड़े जाएं. इससे उन्हें ऑनबोर्डिंग का बेहतर अनुभव मिलेगा. हर ट्यूटोरियल में, ट्यूटोरियल के बारे में जानकारी दी जाएगी. इसके बाद, डिज़ाइन की प्रोसेस, कॉम्पोनेंट की सूची, सिलसिलेवार निर्देश, और प्रैक्टिस करने के लिए एक्सरसाइज़ दी जाएगी. जटिल वर्कफ़्लो के लिए, वीडियो में पूरे कॉन्सेप्ट के अलग-अलग हिस्सों को कवर किया जाएगा.
ट्यूटोरियल का सैंपल देखने के लिए, इस लिंक पर जाएं: सेवन सेगमेंट डिकोडर बनाएं: https://pragatijain.github.io/circuitverse/index.html
कुछ विषयों में ये शामिल हैं: --रोलिंग एलईडी डिसप्ले बनाना --जानें कि रिपल कैरी ऐडर कैसे काम करता है --पहला चरण: चार बिट के मैग्नीट्यूड कम्परेटर का विश्लेषण करना --पहला चरण: हेक्साडेसिमल कैलकुलेटर बनाना --फ़ाइनाइट स्टेट मशीन (एफ़एसएम) के लागू होने का विश्लेषण करना
4) साइडबार नेविगेशन के स्ट्रक्चर में बदलाव करें, ताकि उसे आसानी से पढ़ा जा सके, एक जैसा दिखे, और उसमें एकता बनी रहे.
प्रोजेक्ट के लिए टूल 1) वीडियो ट्यूटोरियल के लिए Camtasia. मैंने सैंपल वीडियो बनाने के लिए, ट्रायल वर्शन का इस्तेमाल किया है. CircuitVerse के लिए काम शुरू करने के बाद, मैं सॉफ़्टवेयर का लाइसेंस खरीदूंगा. साथ ही, फ़ाइनल प्रॉडक्ट में कोई वॉटरमार्क नहीं होगा. 2) Google Docs, जिसका इस्तेमाल करके मैं गाइड लिखता हूं. बाद में, मैं इन्हें GitHub में अपडेट करूंगा, ताकि इन्हें CircuitVerse रिपॉज़िटरी में होस्ट किया जा सके. 3) GitHub में मेरे कॉन्टेंट को मैनेज करने के लिए, Wiki मार्कअप और एचटीएमएल.
टाइमलाइन 16 अगस्त से पहले GitHub पर संगठन के लिए योगदान दें.
कम्यूनिटी बॉन्डिंग (17 अगस्त से 13 सितंबर) कम्यूनिकेशन का चैनल और समय सेट अप करना (समय के अंतर की वजह से). अपने लक्ष्यों को बेहतर बनाएं और दोनों पक्षों की उम्मीदों को सेट करें. समुदाय और प्रॉडक्ट के बारे में ज़्यादा जानें. मेंटॉर और संगठन के अन्य सदस्यों के साथ प्रस्तावित दस्तावेज़ के स्ट्रक्चर पर चर्चा करें और उसे फ़ाइनल करें.
दस्तावेज़ तैयार करने की अवधि यह प्रोजेक्ट, प्रोजेक्ट की अवधि के लिए बने स्टैंडर्ड दिशा-निर्देशों का पालन करेगा. इस प्रोजेक्ट को पूरा होने में कुल 11 हफ़्ते लगेंगे. यह अवधि 14/9/2020 से 30/11/2020 तक होगी. नीचे दिए गए लक्ष्यों को पूरा करने में, मैं हर हफ़्ते करीब 20 घंटे बिताऊंगा. इन लक्ष्यों के अलावा, ज़रूरत पड़ने पर मैं मेंटॉर की मीटिंग और बातचीत में हिस्सा लूं. हम मेंटर्स के साथ मिलकर, इसके लिए सबसे सही समय तय करेंगे. ध्यान दें: यह टाइमलाइन, संगठन की ज़रूरतों के हिसाब से बदल सकती है. बड़ी समयसीमाओं की मदद से, ज़रूरत के हिसाब से फ़ोकस को स्विच किया जा सकता है.
पहला हफ़्ता: पहचाने गए माइलस्टोन की समीक्षा करें और उन्हें बेहतर बनाएं CircuitVerse रिपॉज़िटरी को फ़ॉर्क करें और उसे अपनी मशीन पर डाउनलोड करें मेंटर के साथ वीडियो के स्टाइल के बारे में बातचीत करें. साथ ही, वीडियो की शुरुआती स्क्रीन का टेंप्लेट बनाएं, टाइटल और आखिरी स्क्रीन के लिए कोई भी फ़िलर म्यूज़िक बनाएं, और ऐसी अन्य जानकारी शामिल करें जिसे शामिल किया जाना चाहिए. वीडियो ट्यूटोरियल के विषयों की समीक्षा करें और उन्हें मंज़ूरी पाएं ट्यूटोरियल के विषयों की पहचान करें और उन्हें मंज़ूरी पाएं. साइडबार के नेविगेशन स्ट्रक्चर की समीक्षा करना और उसे मंज़ूरी पाना
दूसरा हफ़्ता: ट्यूटोरियल टेंप्लेट बनाएं और उसे मेंटर से मंज़ूरी पाएं ट्यूटोरियल होस्ट करने के लिए, ट्यूटोरियल का लैंडिंग पेज बनाएं
तीसरा, चौथा, और पांचवां हफ़्ता: सिम्युलेटर से जुड़े अलग-अलग वर्कफ़्लो की जानकारी देने के लिए वीडियो ट्यूटोरियल जोड़ना
छठा हफ़्ता, सातवां, आठवां, नौवां हफ़्ता: अलग-अलग आसान और मुश्किल सर्किट के लिए ट्यूटोरियल बनाना
दसवां हफ़्ता: उपयोगकर्ताओं के शामिल होने के अनुभव को बेहतर बनाने के लिए, साइडबार नेविगेशन को फिर से तैयार करना
11वां हफ़्ता: टाइपिंग की गड़बड़ियों और अन्य गड़बड़ियों की जांच करना.
CircuitVerse से जुड़े काम के सैंपल
*सैंपल ट्यूटोरियल देखने के लिए इस लिंक पर जाएं: सात सेगमेंट डिकोडर बनाएं. : https://pragatijain.github.io/circuitverse/index.html
*कॉम्बिनेशनल ऐनालिसिस टूल का इस्तेमाल करने के लिए, सैंपल वीडियो ट्यूटोरियल का लिंक यहां दिया गया है. https://www.youtube.com/watch?v=7FkeqBYcd1w पहला ध्यान दें: इस वीडियो में मौजूदा कॉन्टेंट का उदाहरण दिया गया है. इसका मकसद, वीडियो के स्टाइल को एक जैसा रखने के लिए, एनोटेशन का इस्तेमाल करने का तरीका बताना है. नोट 2: GDeveloper के लिए काम शुरू करने पर, मैं सॉफ़्टवेयर के लिए लाइसेंस खरीद लूंगा और अंतिम प्रॉडक्ट में वॉटरमार्क शामिल नहीं होगा.
*CircuitVerse ट्यूटोरियल लैंडिंग पेज https://docs.google.com/document/d/1sBKS2cq76zRHDGgA2Lbf7isSisRK_ELLSPsg-7atCAI/edit#
*पूरा प्रस्ताव Google दस्तावेज़ के तौर पर देखें: https://docs.google.com/document/d/1vzYyDnX6mFXXByrcwVsrxCgpIWKpcj8U8DSa3gVB7RA/edit#
ट्यूटोरियल टेंप्लेट का सैंपल: सात सेगमेंट वाला डिकोडर सात सेगमेंट वाला डिकोडर
खास जानकारी:
इस ट्यूटोरियल में, CircuitVerse का इस्तेमाल करके सात सेगमेंट वाला डिकोडर बनाने के अलग-अलग चरणों के बारे में बताया गया है. डिकोडर एक कॉम्बिनेशनल सर्किट है, जो बाइनरी नंबर को उससे जुड़ी दशमलव संख्या में बदलता है. यह इनपुट के चार बिट में लेता है और इसके सात आउटपुट होते हैं.
डिज़ाइन का तरीका
CircuitVerse में सात सेगमेंट वाला डिसप्ले सर्किट जनरेट करने के लिए, हम यह तरीका अपनाएंगे: ट्रूथ टेबल बनाने के लिए, CircuitVerse सिम्युलेटर में मौजूद कॉम्बिनेशनल ऐनालिसिस टूल का इस्तेमाल करें. इस ट्रुथ टेबल का इस्तेमाल करके, हम सिम्युलेटर में ही सर्किट जनरेट करेंगे. इस सर्किट से, आउटपुट को सात सेगमेंट वाले एलईडी डिसप्ले पर भेजा जाएगा. हमारे सर्किट को काम करते हुए देखने के लिए, कॉम्बिनेशनल सर्किट के लेबल को सात सेगमेंट वाले एलईडी डिसप्ले के आउटपुट से कनेक्ट करें. सेवन-सेगमेंट डिसप्ले, एक इलेक्ट्रॉनिक डिसप्ले डिवाइस है. इसका इस्तेमाल, 0 से 9 तक के दशमलव अंक दिखाने के लिए किया जाता है. देखें कि सर्किट कैसे काम करता है. इसके लिए, सच्चाई की टेबल के डेटा का इस्तेमाल करें. ट्रुथ टेबल यहां दी गई टेबल 1 में, सात सेगमेंट वाले डिकोडर के इनपुट के अलग-अलग कॉम्बिनेशन के लिए अलग-अलग आउटपुट की सूची दी गई है.
CircuitVerse के एलिमेंट की सूची
टेबल 2 में, सर्किट को लागू करने के लिए ज़रूरी अलग-अलग कॉम्पोनेंट की सूची दी गई है.
सच की टेबल बनाना
CircuitVerse सिम्युलेटर में ट्रुथ टेबल बनाने के लिए, यह तरीका अपनाएं:
सर्किट पूरा करें
सर्किट को पूरा करने के लिए, कॉम्बिनेशनल सर्किट के लेबल के इनपुट वायर को सेवन सेगमेंट डिसप्ले के आउटपुट से कनेक्ट करने के लिए, 10वां फ़ोटो देखें. इस वीडियो में, CircuitVerse सिम्युलेटर में बने सात सेगमेंट डीकोडर को सिम्युलेटेड सर्किट के बारे में बताया गया है. वीडियो का लिंक: https://www.youtube.com/embed/tGTy4P-RxP0
सर्किट का विश्लेषण करें
लागू किए गए सात सेगमेंट वाले डिकोडर सर्किट की पुष्टि करने के लिए, अलग-अलग इनपुट वैल्यू (S3, S2, S1, S0) को टॉगल करें और टेबल 1 देखें.
सात सेगमेंट डिसप्ले कॉम्पोनेंट में आठ एलईडी सेगमेंट होते हैं और इनके पिन के एक छोर को मॉड्यूल से निकाला जाता है, जैसा कि इमेज 8 में दिखाया गया है. किसी खास सेगमेंट के एलईडी को चमकाने के लिए, 0 से 9 तक की संख्याओं को दिखाने के लिए, काम के सेगमेंट (जिन्हें फ़िगर 10 में a, b, c, d, e, f, g के तौर पर लेबल किया गया है) को चालू करना ज़रूरी है. उदाहरण के लिए, नंबर 1 दिखाने के लिए, एलईडी b और c चालू होने चाहिए.
अगर एलईडी सही दशमलव संख्या नहीं दिखा पा रही है, तो टेबल 3 और इमेज 10 देखें और वायरिंग कनेक्शन की समस्या ठीक करें. टेबल 3 में सात सेगमेंट डिसप्ले पिन कॉन्फ़िगरेशन की सूची दी गई है.