Halaman ini diterjemahkan oleh Cloud Translation API.

Project INCF

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

Ringkasan project

Organisasi open source:: INCF
Penulis teknis:: hq
Nama project:: Dokumen pelatihan LORIS untuk neurosains terbuka yang dapat direproduksi
Durasi project:: Berjalan lama (5 bulan)

Project description

I. Abstrak

Longitudinal Online Research and Imaging System (LORIS) adalah platform pengelolaan project yang ditampilkan di web untuk riset pencitraan neuro,yang mendukung beberapa inisiatif Open Science. Dokumentasi memainkan peran penting di LORIS. Secara khusus, dokumentasi membantu pengguna dan developer LORIS memahami detail software sehingga mereka dapat menggunakan platform atau berkontribusi pada pengembangan software dengan lebih baik. Sementara itu, dokumentasi LORIS juga harus diperbarui. Project ini bertujuan untuk membantu LORIS meningkatkan dokumentasinya.

II. Status Saat Ini

LORIS saat ini menggunakan Github Wiki, Read the Docs, dan situs LORIS.ca untuk menghosting semua dokumentasi. Secara khusus, LORIS GitHub Wiki menghosting dokumentasi LORIS dalam jumlah terbesar, serta tutorial, presentasi, panduan pengguna, dan panduan LORIS tambahan di-host di berbagai platform . Dokumentasi LORIS saat ini memberikan panduan bagi developer dan pengguna LORIS, tetapi dapat dioptimalkan dengan pengembangan dan pengaturan lebih lanjut, terutama dalam pembaruan dokumentasi dan peningkatan detail teknis.

III. Manfaat bagi Komunitas

Dengan meningkatkan kualitas dokumen pelatihan LORIS untuk neurosains terbuka yang dapat direproduksi, peneliti dan developer akan mendapatkan manfaat dari alat yang lebih mudah digunakan untuk meningkatkan pengumpulan data dalam studi mereka. Secara khusus, project ini dapat memperbarui dan meningkatkan dokumentasi penginstalan/penyiapan LORIS, serta materi pengguna akhir yang memberikan pelatihan bagi pengguna baru. Selain itu, project ini akan bertujuan untuk membantu memigrasikan dan memperbarui dokumentasi dari wiki GitHub LORIS ke Read the Docs. Sementara itu, proyek ini dapat menyediakan diagram {i>database<i} untuk mengomunikasikan hubungan data dan meningkatkan visualisasi arsitektur. Terakhir, project ini akan memperbarui dan meningkatkan kualitas konten yang memperkenalkan LORIS, konteks sains terbukanya, dan kasus penggunaannya kepada orang-orang.

IV. Kekuatan pribadi untuk project

Selama beberapa tahun terakhir, saya telah berpartisipasi dalam beberapa proyek teknis yang membuat saya memiliki latar belakang yang kuat dalam bidang penulisan teknis. Secara khusus, saya bertanggung jawab untuk menulis dokumentasi dalam beberapa project tim sebelumnya dan saya yakin bahwa saya memiliki cukup pengalaman dalam penggunaan alat penulisan teknis seperti Read the Docs, Sphinx, Mkdocs, markdown, LaTeX, dll. Sementara itu, pengalaman mengajar saya sebelumnya di kursus STEM juga telah meningkatkan keterampilan saya dalam komunikasi teknis. Dokumen pelatihan LORIS untuk project neurosains terbuka yang dapat direproduksi dengan INCF akan menjadi peluang besar bagi saya untuk menerapkan teknik penulisan teknis saya ke LORIS. Selain itu, saya sangat tertarik dengan bidang pencitraan otak dan telah mencoba menemukan peluang untuk menerapkan pengetahuan teknis saya ke bidang ini. Dokumen pelatihan LORIS untuk project neurosains terbuka yang dapat direproduksi dengan INCF akan menjadi pengalaman yang berharga bagi saya.

V. Hasil

Memigrasikan dan memperbarui dokumentasi LORIS saat ini
Meninjau, memperbarui, dan meningkatkan dokumentasi penginstalan/penyiapan LORIS, dan mengisi kekurangan dalam materi pengguna akhir yang memberikan pelatihan untuk pengguna baru
Membantu membuat diagram {i>database<i} untuk mengomunikasikan hubungan data (misalnya subjek, kunjungan studi) dan meningkatkan visualisasi arsitektur
Membantu memperbarui dan meningkatkan kualitas dokumentasi LORIS API
Membantu memperbarui dan meningkatkan kualitas konten yang memperkenalkan LORIS, konteks sains terbuka, dan kasus penggunaannya, yang melibatkan berbagai format media

VI. Linimasa

Pengikatan Komunitas (17 Agustus - 13 September) a) Menyelesaikan pengenalan software LORIS dan alur kerja tim. b) Meninjau, memperbarui, dan meningkatkan dokumentasi penginstalan/penyiapan LORIS.

Minggu ke-1 (14 September - 20 September) Mengupdate dan memigrasikan dokumentasi LORIS dari wiki GitHub ke Membaca Dokumen.

Minggu ke-2 (21 September - 27 September) a) Tinjau materi pengguna akhir LORIS saat ini. b) Mulai mengisi kekurangan dalam materi pengguna akhir LORIS yang memberikan pelatihan bagi pengguna baru berdasarkan dokumentasi saat ini.

Minggu 3 (28 September - 4 Oktober) Menyelesaikan kesenjangan dalam mengisi materi pengguna akhir LORIS yang memberikan pelatihan bagi pengguna baru.

Minggu ke-4 (5 Oktober - 11 Oktober) a) Memahami arsitektur database LORIS saat ini. b) Mulai menerapkan diagram database untuk platform LORIS.

Minggu 5 (12 Oktober - 18 Oktober) a) Selesaikan tugas pembuatan diagram database LORIS. b) Tinjau LORIS API saat ini dan mulai bantu tingkatkan dokumentasi API.

Minggu 6 (19 Oktober - 25 Oktober) Lanjutkan peningkatan dokumentasi LORIS API.

Minggu ke-7 (26 Oktober - 1 November) Menyelesaikan peningkatan pada dokumentasi LORIS API.

Minggu ke-8 (2 November - 8 November) Tinjau konten saat ini yang memperkenalkan orang-orang kepada LORIS dan mulai lakukan update serta tingkatkan kualitas konteks sains terbuka.

Minggu 9 (9 November - 15 November) Menyelesaikan pembaruan dan peningkatan konteks sains terbuka dalam konten yang memperkenalkan LORIS kepada orang-orang.

Minggu 10 (16 November - 22 November) Membantu memperbarui dan meningkatkan kualitas sebagian kasus penggunaan dalam konten yang memperkenalkan LORIS kepada orang-orang.

Minggu 11 (23 November - 29 November) Menyelesaikan pembaruan dan peningkatan semua kasus penggunaan dalam konten yang memperkenalkan LORIS kepada orang-orang.

Penyelesaian Project (30 November - 5 Desember) a) Membersihkan semua kontribusi dokumentasi yang saya buat. b) Menggabungkan semua permintaan pull yang dibuat di GitHub dan menutup semua masalah yang saya buat. c) Menyelesaikan laporan project akhir saya dan mengirimkan laporan ke Google.

VII. Hasil Mendatang

Setelah Google Season of Docs 2020, saya ingin melanjutkan kontribusi saya pada dokumentasi untuk LORIS. Secara khusus, saya ingin berdiskusi dengan developer LORIS tentang kemungkinan untuk terus memperbarui dan membuat dokumentasi untuk rilis baru. Selain itu, saya ingin meluangkan waktu ekstra untuk meninjau dokumentasi yang telah saya buat selama project Google Season of Docs dan memeriksa apakah ada ruang untuk peningkatan. Terakhir, karena memiliki latar belakang engineering yang relevan, saya terbuka untuk berkontribusi pada aspek lain dari software LORIS di masa mendatang, misalnya, pengembangan software.