इस पेज पर Google Docs के सीज़न के लिए स्वीकार किए गए एक तकनीकी लेखन प्रोजेक्ट की जानकारी है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- नैशनल रिसॉर्स फ़ॉर नेटवर्क बायोलॉजी (एनआरएनबी)
- तकनीकी लेखक:
- Prubhtej_9
- प्रोजेक्ट का नाम:
- SynBioHub के लिए उपयोगकर्ता दस्तावेज़ बनाएं और इस्तेमाल के खास उदाहरणों के लिए ट्यूटोरियल बनाएं
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
खास जानकारी
उपयोगकर्ता दस्तावेज़, असली उपयोगकर्ताओं को किसी प्रॉडक्ट या सेवा का इस्तेमाल करने में मदद करने के लिए बनाए गए हैं. अच्छा उपयोगकर्ता दस्तावेज़ बेहद अहम होता है, क्योंकि इससे उपयोगकर्ताओं को सॉफ़्टवेयर इस्तेमाल करने के तरीके, इसकी सुविधाओं, सुझाव, और तरकीबों के बारे में जानकारी मिलती है. साथ ही, सॉफ़्टवेयर इस्तेमाल करते समय आने वाली आम समस्याओं को हल किया जा सकता है. इससे सहायता पर होने वाला खर्च भी कम होता है और यह प्रॉडक्ट की कॉर्पोरेट पहचान का हिस्सा है. इसका मतलब है कि एक अच्छा उपयोगकर्ता दस्तावेज़, अच्छे प्रॉडक्ट और डेवलपर टीम की तरफ़ से एक संकेत होता है. अच्छे उपयोगकर्ता दस्तावेज़ के बिना, हो सकता है कि उपयोगकर्ता को ऊपर बताए गए कामों को असरदार और असरदार तरीके से करने का तरीका न पता हो. उपयोगकर्ता के दस्तावेज़, किसी प्रॉडक्ट की सफलता को पक्का करने में अहम भूमिका निभा सकते हैं. ऐसा इसलिए, क्योंकि एक बेहतरीन कम्यूनिकेशन हमेशा किसी भी कारोबार या प्रॉडक्ट का अहम हिस्सा होता है. एक बेहतरीन दस्तावेज़ के ज़रिए, आसानी से बातचीत की जा सकती है और उसे आसानी से मैनेज किया जा सकता है. ऐसा करने से, सभी लोग सफलता हासिल कर सकते हैं. SinBioHub, संश्लेषित जीव विज्ञान के लिए डिज़ाइन किया गया एक स्टोर है. यह सार्वजनिक वेबसाइट और ओपन सोर्स सॉफ़्टवेयर, दोनों के तौर पर उपलब्ध है. SinBioHub, सिंथेटिक बायोलॉजी ओपन लैंग्वेज (SBOL) का इस्तेमाल करता है, जो जेनेटिक डिज़ाइन दिखाने के लिए एक ओपन सोर्स स्टैंडर्ड है. साथ ही, यह GenBank और FASTA फ़ाइलों के डिज़ाइन के पार्ट को भी शेयर करने की अनुमति देता है. SinBioHub का इस्तेमाल एक सेवा के रूप में सिंथेटिक पार्ट और डिज़ाइन की लाइब्रेरी प्रकाशित करने, सहयोगियों के साथ डिज़ाइन शेयर करने, और जैविक प्रणालियों के डिज़ाइन स्थानीय रूप से स्टोर करने के लिए किया जा सकता है. SinBioHub में मौजूद डेटा को एचटीटीपी एपीआई, Java API या Python API की मदद से ऐक्सेस किया जा सकता है. इसके बाद, इसे जेनेटिक डिज़ाइन बनाने के लिए सीएडी टूल में इंटिग्रेट किया जा सकता है. SinBioHub में एक ऐसा इंटरफ़ेस है जो डेटाबेस में नया बायोलॉजिकल डेटा अपलोड करता है, डीएनए के हिस्सों को विज़ुअलाइज़ करता है, मनचाहे हिस्सों को ऐक्सेस करने के लिए क्वेरी करता है, और SBOL, GenBank, FASTA वगैरह डाउनलोड करता है. इंटरनेट पर कई रिसर्च पेपर और कुछ ट्यूटोरियल भी उपलब्ध हैं.
दस्तावेज़ की मौजूदा स्थिति:
फ़िलहाल, उपयोगकर्ता से जुड़ा दस्तावेज़ यहां उपलब्ध है :“https://synbiohub.github.io/api-docs/#about-synbiohub “. यह सिर्फ़ एपीआई दस्तावेज़ है और जीयूआई दस्तावेज़ मौजूद नहीं है. इसलिए, डिज़ाइन डेटा स्टोर करने की जगह में नेविगेट करने में उपयोगकर्ता को मदद मिल सकती है. साथ ही, एपीआई से जुड़े दस्तावेज़ों में कुछ खास विषयों को अपडेट करने की ज़रूरत होती है. जैसे, उपयोगकर्ता को होने वाली कुछ खास समस्याओं को हल करना. हालांकि, संगठन ने कुछ ट्यूटोरियल वीडियो रिकॉर्ड किए हैं, जैसे कि यहां दिया गया ट्यूटोरियल वीडियो. SinBioHub के बारे में कोई भी लिखित उपयोगकर्ता दस्तावेज़ मौजूद नहीं है जिससे उपयोगकर्ता को गाइड किया जा सके.
आपके सुझाए गए उपयोगकर्ता दस्तावेज़ को मौजूदा दस्तावेज़ से बेहतर क्यों बनाया गया है? मुझे जीयूआई (जीयूआई) का दस्तावेज़ नए सिरे से बनाना है. इसके लिए, मैं मेंटॉर, मिस्टर क्रिस मायर्स के सुझाए गए GitHub और मार्कडाउन का इस्तेमाल करना चाहता हूं. सुझाए गए उपयोगकर्ता दस्तावेज़ों को इस तरह से बनाया जाएगा कि उसे बेहतर बनाया जा सके और यह पक्का किया जा सके कि किसी भी असली उपयोगकर्ता के काम को बेहतर तरीके से किया जा सके, उसे एक जैसा अनुभव दिया जा सके, और उसे बिना किसी परेशानी के काम किया जा सके. इसमें लिखित गाइड और उससे जुड़ी इमेज शामिल हैं. साथ ही, इसमें ओपन सोर्स सिम्युलेटर SinBioHub की हर सुविधा को इस्तेमाल करने के तरीके के बारे में निर्देश और पूरी जानकारी भी दी गई है. श्री. मायर्स के साथ चर्चा के दौरान यह भी तय किया गया कि API दस्तावेज़ को GUI के साथ मर्ज कर दिया जाएगा और उसमें 6 अनुभाग शामिल किए जाएंगे , जिनमें से छठा अनुभाग वैकल्पिक होगा. सेक्शन के बारे में इस तरह से बताया गया है: 1. परिचय 2. इंस्टॉल करने के निर्देश a) पहले से बनी इमेज से b) सोर्स से c) NGINX कॉन्फ़िगरेशन 3. उपयोगकर्ता निर्देश a) हर GUI की सुविधा के इस्तेमाल के तरीके के बारे में ज़्यादा जानकारी b) इस्तेमाल के सामान्य उदाहरणों के ट्यूटोरियल 4. एपीआई दस्तावेज़ - एंडपॉइंट सेक्शन 5. प्लग इन दस्तावेज़ 6. समस्या हल करना और आने वाले समय में पहचान फ़ाइलें.
पहला हिस्सा:
इस सेक्शन में, उपयोगकर्ताओं को SinBioHub से जुड़ी ज़्यादा जानकारी और कई ट्यूटोरियल दिए जाएंगे.
भाग-2:
इस सेक्शन में, अलग-अलग तरीकों का इस्तेमाल करके, लोगों के ओपन सोर्स सॉफ़्टवेयर को इंस्टॉल करने के अलग-अलग तरीके बताए गए हैं. इनमें ये तरीके शामिल हैं: a) पहले से बनी इमेज से b) सोर्स से c) NGINX कॉन्फ़िगरेशन
भाग-3:
यह दस्तावेज़ का सबसे अहम हिस्सा है और इसमें ज़्यादातर समय लग सकता है. यहां, जीयूआई के संदर्भ में हर मिनट की जानकारी जोड़ी जाएगी. जैसा कि ऊपर बताया गया है, इस सेक्शन में दो समस्याओं के बारे में बताया गया है. जैसे, हर जीयूआई की सुविधा को इस्तेमाल करने के तरीके के बारे में पूरी जानकारी और इस्तेमाल के उदाहरण के लिए कुछ ट्यूटोरियल.
भाग-4:
जैसा कि ऊपर बताया गया है, इस हिस्से के दस्तावेज़ बनाने के लिए स्लेट का इस्तेमाल किया जाएगा. इस सेक्शन में, ये एंडपॉइंट शामिल किए जाएंगे: 1. उपयोगकर्ता एंडपॉइंट 2. एंडपॉइंट खोजें 3. एंडपॉइंट डाउनलोड करें 4. एंडपॉइंट डाउनलोड करें 5. सबमिशन एंडपॉइंट 6. अनुमति वाले एंडपॉइंट. 7. एंडपॉइंट में बदलाव करें 8. अटैचमेंट एंडपॉइंट 9. एडमिन एंडपॉइंट
भाग-5:
इस सेक्शन में, प्लगिन से जुड़े दस्तावेज़ शामिल किए जाएंगे, जो पुराने SinBioHub दस्तावेज़ में पहले से मौजूद हैं. इस सेक्शन को दो सेक्शन में बांटा जाएगा, जैसे कि प्लगिन की जानकारी और लागू करना. भाग -6: [ज़रूरी नहीं] इस सेक्शन में, आम तौर पर होने वाली गड़बड़ियों की सूची दी गई है. साथ ही, उन्हें हल करने से जुड़े कुछ निर्देश भी दिए गए हैं. मिस्टर मायर्स के साथ हुई बातचीत के मुताबिक, यह फ़ैसला लिया गया कि अगर इस सेक्शन को ज़्यादा लंबा नहीं होता, तो इसे परिचय सेक्शन के साथ मर्ज किया जा सकता है. विश्लेषण श्रीमान मायर्स और मेरी बातचीत मौजूदा दस्तावेज़ों को अपडेट करने के तरीकों और GUI के लिए एक नया दस्तावेज़ लिखने के बारे में हुई थी. उन कुछ बातचीत में हमने नए दस्तावेज़ के लिए एक बुनियादी लेआउट तैयार किया, जिसके बारे में ऊपर बताया गया है. साथ ही, नीचे पेज 5 पर एक अनुमानित समयावधि दी गई है. चर्चा के मुताबिक, मैं हर सेक्शन के लिए दस्तावेज़ बनाने के लिए, GitHub और Markdown का इस्तेमाल करूंगा. हालांकि, दस्तावेज़ के चौथे हिस्से को छोड़कर, जिसमें स्लेट का इस्तेमाल किया जाएगा. Slate:- Slate आपको खूबसूरत, स्मार्ट, और रिस्पॉन्सिव एपीआई दस्तावेज़ बनाने में मदद करता है. Slate रूबी पर आधारित एक टूल है. यह Markdown फ़ाइलों के सेट से, तीन पैनल वाले एपीआई के दस्तावेज़ वाली एक आकर्षक साइट जनरेट करता है. इसे डेवलपर रॉबर्ट लॉर्ड ने 2013 में तब बनाया था, जब वे ट्रैवल सॉफ़्टवेयर कंपनी ‘Tripit’ में 18 साल के इंटर्न थे. उस समय उन्होंने अपने बॉस को समझा लिया कि वे इस प्रोजेक्ट को ओपन-सोर्स रखें, बाकी सब इतिहास है. इसमें ये सुविधाएं दी गई हैं: • साफ़ और बेहतर डिज़ाइन — Slate के साथ, आपके एपीआई का ब्यौरा आपके दस्तावेज़ की बाईं तरफ़ होता है और कोड के सभी उदाहरण दाईं ओर दिए जाते हैं. यह Stripe और PayPal के एपीआई दस्तावेज़ों से प्रेरित है. स्लेट रिस्पॉन्सिव है, इसलिए यह टैबलेट, फ़ोन, और प्रिंट में भी बेहतरीन दिखता है. • एक ही पेज पर मौजूद सारी चीज़ें — वे दिन गए जब आपके उपयोगकर्ताओं को अपनी पसंद के मुताबिक लाखों पेजों को खोजने के लिए खोज करनी पड़ती थी. Slate पूरे दस्तावेज़ को एक ही पेज पर रखता है. हालांकि, हमने लिंक करने की सुविधा से समझौता नहीं किया है. स्क्रोल करते समय, आपके ब्राउज़र का हैश सबसे नज़दीकी हेडर में अपडेट हो जाएगा. इसलिए, दस्तावेज़ में किसी खास पॉइंट से लिंक करना अब भी आसान और आम बात है. • Slate सिर्फ़ Markdown है. इसका मतलब है कि Slate पर दस्तावेज़ लिखने पर, आपको सिर्फ़ Markdown लिखा जा सकता है. इससे आपको बदलाव करने और समझने में आसानी होती है. Markdown में सब कुछ लिखा जाता है. यहां तक कि कोड सैंपल, Markdown के कोड ब्लॉक होते हैं. • कोड के सैंपल कई भाषाओं में लिखें — अगर आपके एपीआई की बाइंडिंग एक से ज़्यादा प्रोग्रामिंग भाषाओं में हैं, तो उनके बीच स्विच करने के लिए आसानी से टैब का इस्तेमाल किया जा सकता है. अपने दस्तावेज़ में, हर कोड ब्लॉक के ऊपर भाषा का नाम देकर अलग-अलग भाषाओं को अलग-अलग पहचाना जा सकता है. यह बिलकुल वैसे ही होता है, जैसा GitHub फ़्लेवर्ड मार्कडाउन के साथ होता है. • 100 से ज़्यादा भाषाओं के लिए आउट-ऑफ़-द-बॉक्स सिंटैक्स हाइलाइट करने के लिए, किसी कॉन्फ़िगरेशन की ज़रूरत नहीं है. • पेज के सबसे बाईं ओर अपने-आप, आसानी से स्क्रोल होने वाली विषय सूची. स्क्रोल करने पर, दस्तावेज़ में आपकी मौजूदा जगह दिखती है. यह भी तेज़ है. हम अपने नए एपीआई के लिए दस्तावेज़ बनाने के लिए, TripIt पर स्लेट का इस्तेमाल कर रहे हैं. इस एपीआई के लिए, हमारी विषय सूची में 180 से ज़्यादा एंट्री हैं. हमने इस बात का ध्यान रखा है कि बड़े दस्तावेज़ों के लिए भी परफ़ॉर्मेंस बेहतरीन बने रहे. • उपयोगकर्ताओं को आपके दस्तावेज़ अपडेट करने दें — स्लेट से बनाया गया आपका दस्तावेज़ डिफ़ॉल्ट रूप से, सार्वजनिक GitHub रिपॉज़िटरी में होस्ट किया जाता है. इसका मतलब यह भी है कि आपको GitHub पेज पर अपने दस्तावेज़ों के लिए मुफ़्त होस्टिंग की सुविधा मिलती है. साथ ही, इससे अन्य डेवलपर के लिए भी आपके दस्तावेज़ों के लिए पुल का अनुरोध करना आसान हो जाता है. ऐसा तब होता है, जब उन्हें टाइपिंग की कोई गलती या दूसरी समस्याएं मिलती हैं. बेशक, अगर आपको GitHub का इस्तेमाल नहीं करना है, तो आप अपने दस्तावेज़ कहीं और होस्ट कर सकते हैं. • अरेबिक, फ़ारसी (फ़ारसी), हिब्रू वगैरह जैसी RTL भाषाओं के लिए, RTL का फ़ुल दाएं-से-बाएं लेआउट इस्तेमाल किया जा सकता है. दस्तावेज़ जनरेट करने के लिए, Verdict Slate सबसे अच्छे ओपन सोर्स सॉफ़्टवेयर में से एक है. साथ ही, मेरे मेंटॉर, श्री क्रिस मायर्स के साथ हुई बातचीत के मुताबिक, मुझे पार्ट-4 और अन्य हिस्सों के लिए, GitHub और मार्कडाउन का इस्तेमाल किया जाएगा. इस दस्तावेज़ के बारे में, नीचे दिए गए सेक्शन में ज़्यादा जानकारी दी गई है. प्रस्तावित दस्तावेज़ का स्ट्रक्चर मैंने SinBioHub उपयोगकर्ता गाइड के लिए एक स्ट्रक्चर बनाया है जिसे पेज 2 पर देखा जा सकता है. यह संरचना स्वीकृत है और श्री मायर्स द्वारा पहले ही संशोधित की जा चुकी है. प्रोजेक्ट के लक्ष्य 1. दस्तावेज़ फिर से तैयार करें. 2. दस्तावेज़ को SinBioHub के आधुनिक वर्शन के मुताबिक अपडेट करें. 3. पुरानी जानकारी हटाएं. 4. उपयोगकर्ता के दस्तावेज़ को दोबारा लिखें, ताकि उसे आसानी से समझा जा सके. 5. नए योगदान देने वालों के लिए बने दस्तावेज़ में, ज़रूरी शर्तें पूरी करने वाला एक छोटा सा सेक्शन शामिल करें, ताकि बायोलॉजिकल कॉन्सेप्ट और SinBioHub के इंटरफ़ेस के बारे में उनकी बुनियादी समझ बढ़ाई जा सके.