এই পৃষ্ঠায় Google সিজন অফ ডক্সের জন্য গৃহীত প্রযুক্তিগত লেখার প্রকল্পের বিশদ বিবরণ রয়েছে৷
প্রকল্পের সারসংক্ষেপ
- ওপেন সোর্স সংস্থা:
- ন্যাশনাল রিসোর্স ফর নেটওয়ার্ক বায়োলজি (NRNB)
- কৌশলী লেখক:
- প্রভুতেজ_9
- প্রকল্পের নাম:
- SynBioHub-এর জন্য ব্যবহারকারীর ডকুমেন্টেশন তৈরি করুন এবং নির্দিষ্ট ব্যবহারের ক্ষেত্রে টিউটোরিয়াল তৈরি করুন
- প্রকল্পের দৈর্ঘ্য:
- স্ট্যান্ডার্ড দৈর্ঘ্য (3 মাস)
প্রকল্প বর্ণনা
বিমূর্ত
একটি ব্যবহারকারী ডকুমেন্টেশন শেষ ব্যবহারকারীদের একটি পণ্য বা পরিষেবা ব্যবহার করতে সহায়তা করার জন্য ডিজাইন করা হয়েছে। ভাল ব্যবহারকারীর ডকুমেন্টেশন খুবই গুরুত্বপূর্ণ কারণ এটি ব্যবহারকারীদের একটি সফ্টওয়্যার, এর বৈশিষ্ট্য, টিপস, কৌশলগুলি কীভাবে ব্যবহার করতে হয় এবং সফ্টওয়্যার ব্যবহার করার সময় সম্মুখীন হওয়া সাধারণ সমস্যাগুলি সমাধান করতে হয় তা শিখতে একটি উপায় প্রদান করে৷ এটি সমর্থন খরচও হ্রাস করে এবং পণ্যটির কর্পোরেট পরিচয়ের অংশ, অর্থাৎ একটি ভাল ব্যবহারকারীর ডকুমেন্টেশন একটি স্বাস্থ্যকর পণ্য এবং বিকাশকারী দলের লক্ষণ। একটি ভাল ব্যবহারকারীর ডকুমেন্টেশন ছাড়া, একজন ব্যবহারকারী কার্যকরভাবে এবং দক্ষতার সাথে উপরে উল্লিখিত জিনিসগুলি কীভাবে করবেন তা জানেন না। ব্যবহারকারীর ডকুমেন্টেশনগুলি একটি পণ্যের সাফল্য নিশ্চিত করার ক্ষেত্রে একটি গুরুত্বপূর্ণ ভূমিকা পালন করতে পারে কারণ দুর্দান্ত যোগাযোগ সর্বদা যে কোনও ব্যবসা বা পণ্যের কেন্দ্রবিন্দুতে থাকে এবং থাকবে এবং একটি দুর্দান্ত ডকুমেন্টেশন কেবল সেই যোগাযোগটিকে গ্রহণ করে এবং এটিকে একটি পরিচালনাযোগ্য কাঠামোতে রাখে যা প্রত্যেকে সাফল্যের জন্য অ্যাক্সেস করতে পারে। SynBioHub হল সিন্থেটিক বায়োলজির জন্য একটি ডিজাইন ভান্ডার। এটি একটি পাবলিক ওয়েবসাইট এবং ওপেন সোর্স সফ্টওয়্যার হিসাবে উভয়ই উপলব্ধ। SynBioHub সিন্থেটিক বায়োলজি ওপেন ল্যাঙ্গুয়েজ (SBOL) ব্যবহার করে, জেনেটিক ডিজাইনের প্রতিনিধিত্ব করার জন্য একটি ওপেন-সোর্স স্ট্যান্ডার্ড, এবং এছাড়াও GenBank এবং FASTA ফাইলগুলি থেকে ডিজাইনের অংশগুলি ভাগ করার অনুমতি দেয়। SynBioHub একটি পরিষেবা হিসাবে সিন্থেটিক অংশ এবং ডিজাইনের একটি লাইব্রেরি প্রকাশ করতে, সহযোগীদের সাথে ডিজাইন শেয়ার করতে এবং স্থানীয়ভাবে জৈবিক সিস্টেমের ডিজাইন সংরক্ষণ করতে ব্যবহার করা যেতে পারে। SynBioHub-এ ডেটা HTTP API, Java API, বা Python API-এর মাধ্যমে অ্যাক্সেস করা যেতে পারে যেখানে এটি জেনেটিক ডিজাইন তৈরির জন্য CAD সরঞ্জামগুলিতে একীভূত করা যেতে পারে। 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 আছে কিছু ডকুমেন্টেশন বলতে যা শুধুমাত্র API এর সাথে সম্পর্কিত যেখানে GUI এর জন্য কোন ডকুমেন্টেশন নেই।
ডকুমেন্টেশনের বর্তমান অবস্থা:
বর্তমানে, ব্যবহারকারীর ডকুমেন্টেশন এখানে উপলব্ধ:"https://synbiohub.github.io/api-docs/#about-synbiohub"৷ এটি শুধুমাত্র API ডকুমেন্টেশন এবং GUI ডকুমেন্টেশন বিদ্যমান নেই যা ব্যবহারকারীকে নকশা সংগ্রহস্থলের মধ্যে নেভিগেট করতে সাহায্য করতে পারে। এছাড়াও API ডকুমেন্টেশনের কিছু নির্দিষ্ট বিষয় যেমন ব্যবহারকারীর মুখোমুখি হতে পারে এমন কিছু অদ্ভুত সমস্যার সমস্যা সমাধানের সাথে সাথে কিছুটা আপডেটেরও প্রয়োজন। যদিও সংস্থাটি কিছু টিউটোরিয়াল ভিডিও রেকর্ড করেছে, যেমন এখানে একটি। SynBioHub সম্পর্কে সত্যিই কোন লিখিত ব্যবহারকারীর ডকুমেন্টেশন নেই যা ব্যবহারকারীকে গাইড করতে পারে।
কেন আপনার প্রস্তাবিত ব্যবহারকারী ডকুমেন্টেশন বর্তমানের তুলনায় একটি উন্নতি? পরামর্শদাতা, জনাব ক্রিস মায়ার্সের পরামর্শ অনুযায়ী আমি গিথুব এবং মার্কডাউন ব্যবহার করে স্ক্র্যাচ থেকে GUI ডকুমেন্টেশন তৈরি করব। প্রস্তাবিত ব্যবহারকারীর ডকুমেন্টেশন যে কোনো শেষ ব্যবহারকারীর জন্য দক্ষতা, ধারাবাহিকতা এবং মানসিক শান্তি উন্নত এবং নিশ্চিত করার জন্য গঠন করা হবে। এতে লিখিত নির্দেশিকা এবং এর সাথে সম্পর্কিত ছবি থাকবে, ওপেন সোর্স সিমুলেটর SynBioHub-এর প্রতিটি বৈশিষ্ট্য কীভাবে ব্যবহার করবেন তার নির্দেশাবলী এবং ব্যাখ্যা অন্তর্ভুক্ত থাকবে। মিস্টার মায়ার্সের সাথে আলোচনার সময়, এটাও সিদ্ধান্ত নেওয়া হয়েছিল যে API ডকুমেন্টেশন GUI এর সাথে একত্রিত হবে এবং এতে 6টি বিভাগ থাকবে যার মধ্যে 6 তম বিভাগ ঐচ্ছিক হতে চলেছে। বিভাগগুলি নিম্নরূপ উল্লেখ করা হয়েছে: 1. ভূমিকা 2. ইনস্টলেশন নির্দেশাবলী ক) পূর্বনির্মাণ চিত্র থেকে খ) উত্স থেকে গ) এনজিআইএনএক্স কনফিগারেশন 3. ব্যবহারকারীর নির্দেশাবলী ক) প্রতিটি GUI বৈশিষ্ট্য কীভাবে ব্যবহার করবেন সে সম্পর্কে বিশদ নির্দেশাবলী খ) সাধারণ ব্যবহারের ক্ষেত্রে টিউটোরিয়াল 4 API ডকুমেন্টেশন - এন্ডপয়েন্ট বিভাগ 5. প্লাগইন ডকুমেন্টেশন 6. সমস্যা সমাধান এবং ভবিষ্যতের রেফারেন্স।
অংশ 1:
এই বিভাগে, ব্যবহারকারীদের SynBioHub-এর বিষয়ে একটি বিস্তারিত ভূমিকা এবং বিভিন্ন টিউটোরিয়াল প্রদান করা হবে।
অংশ ২:
এই বিভাগে, বিভিন্ন উপায়ে ব্যবহারকারী বিভিন্ন পদ্ধতি ব্যবহার করে ওপেন সোর্স সফ্টওয়্যার ইনস্টল করতে পারেন, যথা: ক) প্রি-বিল্ট ইমেজ থেকে খ) উত্স থেকে গ) এনজিআইএনএক্স কনফিগারেশন
পর্ব-৩:
এটি ডকুমেন্টেশনের সবচেয়ে গুরুত্বপূর্ণ অংশ এবং বেশিরভাগ সময় লাগবে। এখানে, প্রতিটি মিনিটের বিস্তারিত GUI এর প্রসঙ্গে যোগ করা হবে। উপরে উল্লিখিত হিসাবে প্রধানত দুটি উদ্বেগ এই বিভাগে সুরাহা করা হবে অর্থাৎ প্রতিটি GUI বৈশিষ্ট্য এবং সাধারণ ব্যবহারের ক্ষেত্রে কিছু টিউটোরিয়াল কিভাবে ব্যবহার করতে হয় তার বিস্তারিত নির্দেশাবলী।
পর্ব-৪:
উপরে উল্লিখিত হিসাবে, এই অংশের ডকুমেন্টেশন তৈরি করতে স্লেট ব্যবহার করা হবে। এই বিভাগে নিম্নলিখিত শেষ পয়েন্টগুলি অন্তর্ভুক্ত করা হবে: 1. ব্যবহারকারীর এন্ডপয়েন্ট 2. সার্চ এন্ডপয়েন্ট 3. এন্ডপয়েন্ট ডাউনলোড করুন 4. এন্ডপয়েন্ট ডাউনলোড করুন 5. জমা দেওয়ার শেষ পয়েন্ট 6. অনুমতি শেষ পয়েন্ট। 7. এন্ডপয়েন্ট এডিট করুন 8. অ্যাটাচমেন্ট এন্ডপয়েন্ট 9. অ্যাডমিনিস্ট্রেশন এন্ডপয়েন্ট
পর্ব-5:
এই বিভাগে, প্লাগইন ডকুমেন্টেশন অন্তর্ভুক্ত করা হবে যা ইতিমধ্যেই পুরানো SynBioHub ডকুমেন্টেশনে উপস্থিত রয়েছে। এই বিভাগটিকে দুটি বিভাগে উপ-বিভক্ত করা হবে, যথা: প্লাগইন স্পেসিফিকেশন এবং বাস্তবায়ন। পার্ট-6: [ঐচ্ছিক] এই বিভাগে অন্তর্ভুক্ত থাকবে, ব্যবহারকারীদের মুখোমুখি হওয়া ত্রুটির একটি খুব সাধারণ তালিকা এবং কিছু সমস্যা সমাধানের নির্দেশাবলীও থাকবে। মিস্টার মায়ার্সের সাথে আলোচনা অনুসারে, সিদ্ধান্ত নেওয়া হয়েছে যে এই বিভাগটিকে পরিচিতি বিভাগের সাথে একীভূত করা যেতে পারে, যদি এটি খুব দীর্ঘ না হয়। বিশ্লেষণ মিঃ মায়ার্স এবং আমি বিদ্যমান ডকুমেন্টেশন আপডেট করতে এবং GUI এর জন্য একটি নতুন লেখার বিষয়ে একটি কথোপকথন করেছি। এই কয়েকটি কথোপকথনে আমরা নতুন ডকুমেন্টেশনের জন্য একটি মৌলিক বিন্যাস তৈরি করেছি যা উপরে উল্লিখিত হয়েছে এবং নীচের পৃষ্ঠা 5-এ একটি আনুমানিক সময়রেখা দেওয়া হয়েছে। আলোচনা অনুসারে, আমি স্লেট ব্যবহার করা ডকুমেন্টেশনের পার্ট-4 ব্যতীত প্রতিটি বিভাগের জন্য ডকুমেন্টেশন তৈরি করার জন্য গিথুব এবং মার্কডাউন ব্যবহার করব। স্লেট:- স্লেট আপনাকে সুন্দর, বুদ্ধিমান, প্রতিক্রিয়াশীল API ডকুমেন্টেশন তৈরি করতে সাহায্য করে। স্লেট একটি রুবি-ভিত্তিক টুল যা মার্কডাউন ফাইলের একটি সেট থেকে একটি দুর্দান্ত-সুদর্শন, তিন-প্যানেলযুক্ত API ডকুমেন্টেশন স্ট্যাটিক সাইট তৈরি করে। এটি 2013 সালে বিকাশকারী রবার্ট লর্ড দ্বারা নির্মিত হয়েছিল যখন তিনি ভ্রমণ সফ্টওয়্যার কোম্পানি 'ট্রিপিট'-এর একজন 18 বছর বয়সী ইন্টার্ন ছিলেন। তিনি সেই সময়ে তার বসকে প্রজেক্টটি ওপেন সোর্স করতে দিতে রাজি করেছিলেন এবং বাকিটা ইতিহাস। এটির নিম্নলিখিত বৈশিষ্ট্য রয়েছে: • পরিষ্কার, স্বজ্ঞাত নকশা — স্লেটের সাহায্যে, আপনার API-এর বিবরণ আপনার ডকুমেন্টেশনের বাম দিকে, এবং সমস্ত কোড উদাহরণ ডানদিকে রয়েছে৷ Stripe's এবং PayPal এর API ডক্স দ্বারা অনুপ্রাণিত৷ স্লেট প্রতিক্রিয়াশীল, তাই এটি ট্যাবলেট, ফোন এবং এমনকি মুদ্রণেও দুর্দান্ত দেখায়। • একটি একক পৃষ্ঠায় সবকিছু — সেই দিনগুলি চলে গেছে যখন আপনার ব্যবহারকারীদের তারা যা চায় তা খুঁজে পেতে এক মিলিয়ন পৃষ্ঠার মাধ্যমে অনুসন্ধান করতে হয়েছিল৷ স্লেট সমগ্র ডকুমেন্টেশন একটি একক পৃষ্ঠায় রাখে। যদিও আমরা সংযোগযোগ্যতা ত্যাগ করিনি। আপনি স্ক্রোল করার সাথে সাথে আপনার ব্রাউজারের হ্যাশ নিকটতম হেডারে আপডেট হবে, তাই ডকুমেন্টেশনের একটি নির্দিষ্ট পয়েন্টে লিঙ্ক করা এখনও স্বাভাবিক এবং সহজ। • স্লেট হল শুধু মার্কডাউন — আপনি যখন স্লেট দিয়ে ডক্স লেখেন, তখন আপনি শুধু মার্কডাউন লিখছেন, যা সম্পাদনা এবং বোঝা সহজ করে তোলে। সবকিছুই মার্কডাউনে লেখা আছে — এমনকি কোডের নমুনাগুলো শুধু মার্কডাউন কোড ব্লক। • একাধিক ভাষায় কোড নমুনা লিখুন — যদি আপনার API-এর একাধিক প্রোগ্রামিং ভাষায় বাইন্ডিং থাকে, তাহলে আপনি সহজেই তাদের মধ্যে স্যুইচ করতে ট্যাব রাখতে পারেন। আপনার নথিতে, আপনি GitHub ফ্লেভারড মার্কডাউনের মতোই প্রতিটি কোড ব্লকের শীর্ষে ভাষার নাম উল্লেখ করে বিভিন্ন ভাষাকে আলাদা করতে পারবেন। • 100টিরও বেশি ভাষার জন্য আউট-অফ-দ্য-বক্স সিনট্যাক্স হাইলাইটিং, কোনো কনফিগারেশনের প্রয়োজন নেই। • স্বয়ংক্রিয়, মসৃণভাবে পৃষ্ঠার বাম দিকে বিষয়বস্তুর সারণী। আপনি স্ক্রোল করার সাথে সাথে এটি নথিতে আপনার বর্তমান অবস্থান প্রদর্শন করে। এটাও দ্রুত। আমরা আমাদের নতুন API এর জন্য ডকুমেন্টেশন তৈরি করতে TripIt-এ স্লেট ব্যবহার করছি, যেখানে আমাদের বিষয়বস্তুর সারণীতে 180 টির বেশি এন্ট্রি রয়েছে। আমরা নিশ্চিত করেছি যে পারফরম্যান্সটি দুর্দান্ত থাকে, এমনকি বড় নথিগুলির জন্যও। • আপনার ব্যবহারকারীদের আপনার জন্য আপনার ডকুমেন্টেশন আপডেট করতে দিন — ডিফল্টরূপে, আপনার স্লেট-জেনারেটেড ডকুমেন্টেশন একটি পাবলিক গিটহাব রিপোজিটরিতে হোস্ট করা হয়। এর অর্থ এই নয় যে আপনি গিটহাব পৃষ্ঠাগুলির সাথে আপনার ডক্সের জন্য বিনামূল্যে হোস্টিং পান, তবে এটি অন্যান্য বিকাশকারীরা টাইপো বা অন্যান্য সমস্যা খুঁজে পেলে আপনার ডক্সে অনুরোধ করা সহজ করে তোলে। অবশ্যই, আপনি যদি GitHub ব্যবহার করতে না চান, তাহলে অন্য কোথাও আপনার ডক্স হোস্ট করার জন্য আপনাকে স্বাগত জানাই। • RTL সমর্থন আরবি, ফার্সি (ফার্সি), হিব্রু ইত্যাদির মতো RTL ভাষার জন্য সম্পূর্ণ ডান-থেকে-বামে বিন্যাস। ডকুমেন্টেশন তৈরি করার জন্য এবং আমার পরামর্শদাতার সাথে আলোচনা অনুসারে ভার্ডিক্ট স্লেট অন্যতম শক্তিশালী ওপেন সোর্স সফ্টওয়্যার। ক্রিস মায়ার্স আমি পার্ট-৪ এর জন্য স্লেট ব্যবহার করব এবং অন্যান্য অংশের জন্য গিথুব এবং মার্কডাউন ব্যবহার করা হবে। ডকুমেন্টেশনের আরও বিশদ দৃষ্টিভঙ্গি নীচের বিভাগে আলোচনা করা হয়েছে। প্রস্তাবিত ডকুমেন্টেশনের জন্য কাঠামো আমি SynBioHub ব্যবহারকারী গাইডের জন্য একটি কাঠামো তৈরি করেছি যা পৃষ্ঠা 2 এ পাওয়া যাবে। প্রকল্পের লক্ষ্য 1. ডকুমেন্টেশন পুনর্গঠন. 2. SynBioHub-এর আধুনিক সংস্করণের সাথে মানানসই ডকুমেন্টেশন আপডেট করুন। 3. অপ্রচলিত তথ্য সরান। 4. বুঝতে সহজ করার জন্য ব্যবহারকারীর ডকুমেন্টেশন পুনরায় লিখুন। 5. নতুন অবদানকারীদের জন্য ডকুমেন্টেশনে একটি সংক্ষিপ্ত প্রাক-প্রয়োজনীয় বিভাগ অন্তর্ভুক্ত করুন যাতে মৌলিক জৈবিক ধারণা এবং SynBioHub-এর ইন্টারফেস সম্পর্কে তাদের প্রাথমিক উপলব্ধি বৃদ্ধি পায়।