इस पेज पर, तकनीकी लेखन वाले उस प्रोजेक्ट की जानकारी दी गई है जिसे Google Season of Docs के लिए स्वीकार किया गया है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- ARK नेटवर्क
- टेक्निकल राइटर:
- yslcrypto
- प्रोजेक्ट का नाम:
- प्रोजेक्ट 1 - Core ब्लॉकचेन डेवलपमेंट गाइड का इस्तेमाल शुरू करना
- प्रोजेक्ट की अवधि:
- स्टैंडर्ड लंबाई (तीन महीने)
प्रोजेक्ट का विवरण
'शुरू करना' सेक्शन को पढ़ने के बाद, यहां कुछ सुझाव दिए गए हैं:
अपना डेवलपर एनवायरमेंट कैसे सेट अप करें
इंस्टॉलेशन: मैं यहां डेवलपमेंट टूल इंस्टॉल करने के तरीके के बारे में ज़्यादा जानकारी दूंगा. हम आपको सामान्य गड़बड़ियों और उन्हें ठीक करने के तरीकों के साथ-साथ कोड के सैंपल देंगे. हम समस्या को हल करने वाले पेज का लिंक यहां दे सकते हैं.
अपना पहला टेस्टनेट शुरू करना: पहला इंप्रेशन: फ़िलहाल, यह उन लोगों के लिए काफ़ी भ्रमित करने वाला है जो सिर्फ़ स्किम कर रहे हैं और तुरंत सेटअप करना चाहते हैं. मुझे इन चीज़ों में बदलाव करना है:
मैं टेस्टनेट जैसे बुनियादी कॉन्सेप्ट के बारे में भी बताऊंगा.
मैं कम शब्दों वाले ज़्यादा कोड सैंपल दूंगा: mkdir, cd वगैरह. साथ ही, उन्हें एक साथ ग्रुप भी करूंगा, ताकि पाठक उन्हें आसानी से कॉपी और चिपकाएं. कुछ भी आसान नहीं है और हर कोई कॉपी करना और चिपकाना पसंद करता है.
पहली बार पढ़ने पर, मुझे यह समझ नहीं आया कि नेटवर्क बूट सेक्शन के पहले और दूसरे चरण से क्या हासिल होता है. लिंक पर क्लिक करके उन्हें पढ़ने में बहुत समय लगता है. मुझे लगता है कि बहुत ज़्यादा दूर तक फैलाए बिना, हम इसे साफ़ तौर पर समझ सकते हैं.
मैं कम से कम पांचवें चरण में कोर-कंटेनर की खास जानकारी बताऊंगा. (जो मुझे लगता है कि चौथा चरण है?), ताकि पाठक को यह समझ आ जाए कि वे लिंक पर जाकर क्या कर रहे हैं.
तीसरे और पांचवें चरण (वास्तव में चौथे) के लिए, मैं लंबे कोड सैंपल के बारे में बताऊंगा.
आखिरी चरण में, मुझे इंस्टॉल किए गए प्लगिन और फ़ाइल का लिंक देना होगा, ताकि पाठक को आसानी से पढ़ा जा सके.
आखिर में, कॉन्टेंट में इस तरह से बदलाव करना जिससे यह पक्का हो जाए कि एक पैराग्राफ़ में एक से ज़्यादा आइडिया नहीं हैं. इससे वीडियो को आसानी से समझने में मदद मिलती है. मैं टोन को ज़्यादा मज़ेदार / दोस्ताना भी बनाऊंगी और कुछ इमोजी जोड़ूंगी.
ब्लॉकचेन को मॉनिटर करने का तरीका
हम पहले पैराग्राफ़ को आसान बना देंगे. मैं आपको बताऊंगा कि प्लग इन क्या है, डेलिगेट क्या करता है (या कम से कम, बुनियादी बातों की जानकारी देने वाले लिंक पर ले जाऊंगा), ब्लॉक को फ़ोर्ज करने का क्या मतलब है, और नेटवर्क इवेंट का उदाहरण दूंगा.
समस्या के बारे में बताएं: मैं पाठक को यह बताऊंगा कि फ़ुल नोड क्या है. साथ ही, ज़्यादा जानकारी के लिए लिंक भी दूंगा. इसके अलावा, फ़ुल नोड और बाहरी ऐप्लिकेशन के बीच के फ़ायदे और नुकसान के बारे में भी बेहतर तरीके से बताऊंगा. आखिर में, मैं इस सब-सेक्शन के आखिर में, 'शुरू करें' पेज के पिछले पेज का लिंक दूंगा. इसमें काम करने वाला टेस्टनेट सेट अप करने और डेवलपमेंट एनवायरमेंट को सेट अप करने का तरीका दिया गया है (अगर पाठक ने कभी इस पेज पर विज़िट नहीं किया है).
इवेंट एपीआई: उपलब्ध इवेंट की सूची से यह साफ़ तौर पर नहीं पता चलता कि हमें अपनी ज़रूरत के मुताबिक इवेंट बनाने के लिए, 'block.applied' का इस्तेमाल करना चाहिए. नीचे दी गई सलाह से यह बात साफ़ तौर पर समझ आती है. हालांकि, हम आपको पहले ही इस बारे में बताना चाहते हैं.
मुझे नहीं पता कि ‘block.applied’ क्या दिखाता है. मुझे लगता है कि इस बारे में साफ़ तौर पर बताना ज़रूरी है.
मुझे लगता है कि आखिर में दिए गए कोड के उदाहरण से यह साफ़ तौर पर पता चलेगा कि 'block.generatorPublicKey', पिछले स्यूडोकोड के उदाहरण में मौजूद 'block.forger' की जगह लेता है. साथ ही, 'delegateKey', 'delegateWeAreMonitoring' की जगह लेता है. आखिर में, यह पक्का करने के लिए कि कोड और स्यूडोकोड के सैंपल एक जैसे हों, मैं if स्टेटमेंट में 'delegateKey' और 'generatorKey' को भी बदल दूंगा.
प्लग इन बनाना: मैं आपको बताऊंगा कि इस संदर्भ में स्कैफ़ोल्डिंग का क्या मतलब है. जैसे: किसी निर्माण स्थल पर मचान की तरह, इस संदर्भ में मचान का मतलब आपके प्लग इन के लिए पहले से तैयार किया गया एक आसान स्ट्रक्चर है. इस स्ट्रक्चर के ऊपर, असल मचान बनाया जा सकता है.
मैं डायरेक्ट्री और प्लग इन का नाम बदलने के लिए कोड सैंपल जोड़ूंगा. साथ ही, package.json का उदाहरण दिखाऊंगा और plugin.js में 'ज़रूरी कॉन्फ़िगरेशन जोड़ने' का मतलब क्या है, इस बारे में बताऊंगा.
एक साथ सही जानकारी: मुझे यह समझ आ जाएगा कि बदलाव क्या हैं. आखिर में, बधाई देने के साथ-साथ कुछ और इमोजी इस्तेमाल करें :)
ARK SDK टूल का इस्तेमाल करके, अपना पहला लेन-देन करने का तरीका
शुरू करना: मैं कोड का एक सैंपल जोड़ूंगा, ताकि उपयोगकर्ता कॉपी-पेस्ट करके नई डायरेक्ट्री बना सके.
Testnet से कनेक्ट करना: अगर पाठक को REST API के बारे में जानकारी नहीं है, तो मैं इसके बारे में बताऊंगा (या कम से कम, इसकी जानकारी देने वाले लिंक को जोड़ूंगा). मैं JSON व्यूअर का एक उदाहरण दूंगा और उसे लिंक करूंगा. हम दूसरे सुझाव में, पाठक से अनुरोध कर रहे हैं. इसलिए, हम थोड़ा दोस्ताना लहज़े का इस्तेमाल करेंगे.
कॉन्फ़िगरेशन मैनेजर बदलना: मैं नेटवर्क से जुड़ी गड़बड़ियों के सामान्य उदाहरणों के बारे में बताऊंगा. साथ ही, समस्या हल करने वाले सेक्शन को लिंक करने पर भी विचार करूंगा.
भेजने और पाने वाले खाते सेट अप करें: मैंने एक कोड सैंपल जोड़ा है, ताकि लोग कॉपी चिपकाकर कॉन्फ़िगरेशन डायरेक्ट्री में जा सकें. मैं delegates.json का कॉन्टेंट दिखाने वाला कोड सैंपल जोड़ूंगा.
ARK Core Tester CLI का इस्तेमाल करके लेन-देन भेजने का तरीका
ज़रूरी शर्तें: मैं एक कोड सैंपल जोड़ूंगा, जिसमें ARK Core के GitHub रिपॉज़िटरी की काम करने वाली कॉपी पाने का तरीका बताया गया है. साथ ही, एक और सैंपल जोड़ूंगा, जिसमें पाठक को सही डायरेक्ट्री में ले जाने का तरीका बताया गया है.
बुनियादी बातें: मैं पाथ एनवायरमेंट वैरिएबल के बारे में जानकारी न रखने वाले लोगों के लिए, पहले पैराग्राफ़ को ज़्यादा साफ़ तौर पर लिखूंगा.
निष्कर्ष
आखिर में, ये सिर्फ़ कुछ छोटे नोट हैं जिन्हें मैंने दस्तावेज़ पढ़ते समय लिया था. जब हम प्रोजेक्ट पर एक साथ काम करना शुरू करेंगे, तो मैं खुद इस प्रोसेस को पूरा करके देखना चाहूंगा कि मुझे कहां समस्या आ रही है. इस जानकारी का इस्तेमाल करके, दस्तावेज़ों को और आसान बनाएं.
आखिर में, मैंने यहां सिर्फ़ एक प्रोजेक्ट को देखा है. मुझे लगता है कि इसमें कुछ हफ़्तों से ज़्यादा समय नहीं लगेगा. जैसा कि हमारे ईमेल में बताया गया था, मुझे लगता है कि साथ मिलकर कई प्रोजेक्ट पर काम करना मुमकिन होगा.