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