Halaman ini diterjemahkan oleh Cloud Translation API.

Project National Resource for Network Biology (NRNB)

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:: National Resource for Network Biology (NRNB)
Penulis teknis:: Prubhtej_9
Nama proyek:: Membuat dokumentasi pengguna untuk SynBioHub & mengembangkan tutorial untuk kasus penggunaan tertentu
Durasi proyek:: Durasi standar (3 bulan)

Project description

Abstract

Dokumentasi pengguna dirancang untuk membantu pengguna akhir menggunakan suatu produk atau layanan. Dokumentasi pengguna yang baik sangat penting karena menyediakan cara bagi pengguna untuk mempelajari cara menggunakan perangkat lunak, fiturnya, kiat, trik, dan juga menyelesaikan masalah umum yang dihadapi saat menggunakan perangkat lunak tersebut. Ini juga mengurangi biaya dukungan dan merupakan bagian dari identitas perusahaan produk, yaitu dokumentasi pengguna yang baik adalah tanda produk yang sehat dan tim pengembang. Tanpa dokumentasi pengguna yang baik, seorang pengguna mungkin tidak tahu bagaimana melakukan hal-hal yang disebutkan di atas secara efektif dan efisien. Dokumentasi pengguna dapat memainkan peran penting dalam memastikan keberhasilan suatu produk karena komunikasi yang hebat adalah dan akan selalu menjadi jantung bisnis atau produk apa pun dan dokumentasi yang hebat hanya mengambil komunikasi itu dan menempatkannya dalam kerangka kerja yang mudah dikelola yang dapat diakses semua orang untuk sukses. SynBioHub adalah repositori desain untuk biologi sintetis. OpenSSL tersedia baik sebagai situs web publik maupun sebagai perangkat lunak {i>open source<i}. SynBioHub menggunakan Synthetic Biology Open Language (SBOL), sebuah standar open source untuk merepresentasikan desain genetik, dan juga memungkinkan berbagi bagian desain dari file GenBank dan FASTA. SynBioHub dapat digunakan untuk mempublikasikan library bagian dan desain sintetis sebagai layanan, untuk berbagi desain dengan kolaborator, dan untuk menyimpan desain sistem biologis secara lokal. Data di SynBioHub dapat diakses melalui HTTP API, Java API, atau Python API yang nantinya dapat diintegrasikan ke dalam alat CAD untuk membangun desain genetik. SynBioHub berisi antarmuka bagi pengguna untuk mengupload data biologis baru ke database, untuk memvisualisasikan bagian DNA, melakukan kueri untuk mengakses bagian yang diinginkan, dan mendownload SBOL, GenBank, FASTA, dll. Berbagai makalah penelitian dan beberapa tutorial juga tersedia di internet, seperti berikut: 1. https://pubs.acs.org/doi/abs/10.102cs

Status dokumentasi Saat Ini:

Saat ini, dokumentasi pengguna tersedia di :“https://synbiohub.github.io/api-docs/#about-synbiohub “. Ini hanyalah dokumentasi API dan tidak ada dokumentasi GUI yang dapat membantu pengguna menavigasi dalam repositori desain. Selain itu, dokumentasi API memerlukan sedikit pembaruan, dengan beberapa topik spesifik seperti pemecahan masalah khusus tertentu yang mungkin dihadapi pengguna. Organisasi telah merekam beberapa video tutorial, seperti yang ada di sini. Tidak ada dokumentasi pengguna tertulis tentang SynBioHub yang dapat memandu pengguna.

Mengapa dokumentasi pengguna yang Anda usulkan lebih baik dari yang saat ini? Saya akan membuat dokumentasi GUI dari awal menggunakan github dan markdown seperti yang disarankan oleh mentor, Mr. Chris Myers. Dokumentasi pengguna yang diajukan akan disusun untuk meningkatkan dan memastikan efisiensi, konsistensi, dan ketenangan pikiran bagi setiap pengguna akhir. Panduan ini akan berisi panduan tertulis dan gambar terkait, termasuk petunjuk dan penjelasan tentang cara menggunakan setiap fitur simulator open source SynBioHub. Selama diskusi dengan Mr. Myers , diputuskan bahwa dokumentasi API akan digabungkan dengan GUI dan akan berisi 6 bagian yaitu di mana bagian ke-6 akan bersifat opsional. Bagian-bagian tersebut disebutkan sebagai berikut: 1. Pendahuluan 2. Petunjuk penginstalan a) Dari image bawaan b) Dari sumber c) Konfigurasi NGINX 3. Instruksi Pengguna a) Instruksi terperinci tentang cara menggunakan setiap fitur GUI b) Tutorial untuk kasus penggunaan umum 4. Dokumentasi API - Endpoint bagian 5. Dokumentasi Plugin 6. Pemecahan masalah dan referensi pada masa mendatang.

Bagian-1:

Di bagian ini, pengguna akan diberi pengantar yang terperinci dan berbagai tutorial sehubungan dengan SynBioHub.

Bagian-2:

Di bagian ini, berbagai cara yang dapat digunakan pengguna untuk menginstal software open source menggunakan berbagai metode, yaitu: a) Dari image bawaan b) Dari sumber c) konfigurasi NGINX

Bagian-3:

Ini adalah bagian paling penting dari dokumentasi dan akan memakan sebagian besar waktu. Di sini, setiap detail menit akan ditambahkan dalam konteks ke GUI. Seperti yang disebutkan di atas, terutama dua permasalahan akan dibahas di bagian ini, yaitu petunjuk terperinci tentang cara menggunakan setiap fitur GUI dan beberapa tutorial untuk kasus penggunaan umum.

Bagian-4:

Seperti yang disebutkan di atas, slate akan digunakan untuk membuat dokumentasi bagian ini. Di bagian ini, endpoint berikut akan disertakan: 1. Endpoint Pengguna 2. Endpoint Penelusuran 3. Download Endpoint 4. Mendownload Endpoint 5. Endpoint Pengiriman 6. Endpoint Izin. 7. Mengedit Endpoint 8. Endpoint Lampiran 9. Endpoint Administrasi

Bagian-5:

Di bagian ini, dokumentasi plugin akan disertakan yang sudah ada dalam dokumentasi SynBioHub yang lama. Bagian ini akan dibagi menjadi dua bagian, yaitu: spesifikasi dan implementasi plugin. Bagian-6: [Opsional] Bagian ini akan berisi daftar error yang sangat umum yang dihadapi pengguna dan berisi beberapa petunjuk pemecahan masalah. Sesuai dengan diskusi dengan Bapak Myers, telah diputuskan bahwa bagian ini dapat digabungkan dengan bagian pendahuluan, jika tidak terlalu lama. Analisis Mr. Myers dan saya berdiskusi tentang cara memperbarui dokumentasi yang ada dan juga menulis dokumentasi baru untuk GUI . Dalam beberapa percakapan tersebut, kami merumuskan tata letak dasar untuk dokumentasi baru yang telah disebutkan di atas dan perkiraan waktu telah diberikan pada halaman 5 di bawah ini. Sesuai diskusi, saya akan menggunakan github dan markdown untuk membangun dokumentasi untuk setiap bagian kecuali Bagian-4 dari dokumentasi di mana slate akan digunakan. Slate:- Slate membantu Anda membuat dokumentasi API yang indah, cerdas, dan responsif. Slate adalah alat berbasis Ruby yang menghasilkan situs statis dokumentasi API tiga panel dengan tampilan menarik dari sekumpulan file markdown. Project ini dibangun oleh developer Robert Lord pada tahun 2013 saat dia masih magang di perusahaan software perjalanan 'Tripit' berusia 18 tahun. Pada saat itu, dia meyakinkan atasannya untuk menjadikannya open source project dan sisanya adalah sejarah. Kode ini memiliki fitur berikut: • Desain yang rapi dan intuitif — Dengan Slate, deskripsi API Anda terletak di sisi kiri dokumentasi, dan semua contoh kode ada di sebelah kanan. Terinspirasi oleh dokumen API Stripe dan PayPal. Slate bersifat responsif, sehingga terlihat bagus di tablet, ponsel, dan bahkan media cetak. • Segala sesuatu dalam satu halaman — Anda tidak perlu lagi menelusuri jutaan halaman untuk menemukan apa yang mereka inginkan. Slate menempatkan seluruh dokumentasi di satu halaman. Namun, kami tidak mengorbankan kemampuan penautan. Saat Anda menggulir, hash browser Anda akan diperbarui ke header terdekat, sehingga menautkan ke titik tertentu dalam dokumentasi akan tetap alami dan mudah. • Slate hanyalah Markdown — Saat menulis dokumen dengan Slate, Anda hanya menulis Markdown, yang membuatnya mudah untuk diedit dan dipahami. Semuanya ditulis dalam Markdown — bahkan contoh kode hanyalah blok kode Markdown. • Tulis contoh kode dalam berbagai bahasa — Jika API Anda memiliki binding dalam banyak bahasa pemrograman, Anda dapat dengan mudah memasukkan tab untuk beralih antar-bahasa. Dalam dokumen, Anda akan membedakan bahasa yang berbeda dengan menentukan nama bahasa di bagian atas setiap blok kode, seperti halnya GitHub Flavored Markdown. • Sorotan sintaks siap pakai untuk lebih dari 100 bahasa, tidak diperlukan konfigurasi. • Pengguliran daftar isi secara otomatis dan mulus di ujung kiri laman. Saat di-scroll, scroll akan menampilkan posisi Anda saat ini dalam dokumen. Juga cepat. Kami menggunakan Slate di TripIt untuk membuat dokumentasi API baru, dengan daftar isi yang memiliki lebih dari 180 entri. Kami telah memastikan bahwa performanya tetap sangat baik, bahkan untuk dokumen yang lebih besar. • Izinkan pengguna memperbarui dokumentasi untuk Anda — Secara default, dokumentasi yang dibuat Slate Anda dihosting di repositori GitHub publik. Hal ini tidak hanya berarti Anda mendapatkan hosting gratis untuk dokumen Anda dengan Halaman GitHub, tetapi juga memudahkan developer lain untuk membuat permintaan pull ke dokumen Anda jika mereka menemukan kesalahan ketik atau masalah lainnya. Jika tidak ingin menggunakan GitHub, Anda juga bisa menghosting dokumen di tempat lain. • Dukungan RTL Tata letak kanan ke kiri penuh untuk bahasa RTL seperti bahasa Arab, Persia (Farsi), Ibrani, dll. Verdict Slate adalah salah satu software open source paling ampuh untuk membuat dokumentasi dan sesuai diskusi dengan mentor saya, Mr. Chris Myers, saya akan menggunakan slate untuk Bagian-4 dan untuk bagian lainnya, github dan markdown akan digunakan. Tampilan dokumentasi yang lebih mendetail dibahas di bagian di bawah ini. Struktur untuk dokumentasi yang diusulkan saya membuat struktur untuk Panduan Pengguna SynBioHub yang dapat ditemukan di halaman 2. Struktur ini diterima dan telah dimodifikasi oleh Mr. Myers . Tujuan Proyek 1. Mengubah struktur dokumentasi. 2. Perbarui dokumentasi agar sesuai dengan versi modern SynBioHub. 3. Hapus informasi yang sudah tidak digunakan. 4. Menulis ulang dokumentasi pengguna agar lebih mudah dipahami. 5. Menyertakan bagian prasyarat singkat pada dokumentasi bagi kontributor baru untuk meningkatkan pemahaman dasar mereka tentang konsep biologis dasar dan antarmuka SynBioHub.