Halaman ini diterjemahkan oleh Cloud Translation API.

Project INCF

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

Ringkasan proyek

Organisasi open source:: INCF
Penulis teknis:: hq
Nama proyek:: Dokumen pelatihan LORIS untuk ilmu saraf terbuka yang dapat direproduksi
Durasi proyek:: Jangka panjang (5 bulan)

Project description

I. Abstract

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

II. Status Saat Ini

LORIS saat ini menggunakan GitHub Wiki, Baca Dokumen, dan situs LORIS.ca untuk menghosting semua dokumentasi. Secara khusus, LORIS GitHub Wiki menjadi tuan rumah dokumentasi LORIS dalam jumlah terbesar, dan tutorial, presentasi, panduan pengguna, dan panduan LORIS tambahan dihosting di berbagai platform . Dokumentasi LORIS saat ini menyediakan panduan untuk developer dan pengguna LORIS, tetapi dapat memanfaatkan pengembangan dan pengaturan lebih lanjut, terutama dalam pembaruan dokumentasi dan peningkatan dalam detail teknis.

III. Manfaat bagi Komunitas

Dengan meningkatkan kualitas dokumen pelatihan LORIS untuk ilmu saraf 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 dapat memperbarui dan meningkatkan dokumentasi penginstalan/penyiapan LORIS, serta materi pengguna akhir yang menyediakan pelatihan untuk pengguna baru. Selain itu, project ini akan bertujuan membantu melakukan migrasi dan memperbarui dokumentasi dari wiki LORIS GitHub ke Baca Dokumen. Sementara itu, proyek tersebut 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 orang-orang pada LORIS, konteks sains terbuka, dan kasus penggunaannya.

IV. Kekuatan pribadi untuk proyek

Selama beberapa tahun terakhir, saya telah berpartisipasi dalam beberapa proyek teknis di mana saya telah mengembangkan latar belakang yang kuat di bidang penulisan teknis. Secara khusus, saya bertanggung jawab atas penulisan dokumentasi di beberapa project tim sebelumnya dan saya percaya bahwa saya memiliki cukup pengalaman dalam menggunakan 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 ilmu saraf terbuka yang dapat direproduksi dengan INCF akan menjadi peluang besar bagi saya untuk menerapkan teknik penulisan teknis ke LORIS. Selain itu, saya sangat tertarik di bidang neuroimaging dan saya mencoba mencari peluang untuk menerapkan pengetahuan teknis saya di bidang ini. Dokumen pelatihan LORIS untuk project ilmu saraf terbuka yang dapat direproduksi bersama INCF akan menjadi pengalaman berharga bagi saya.

V. Hasil kerja

Memigrasikan dan memperbarui dokumentasi LORIS saat ini
Meninjau, memperbarui, dan memperbaiki dokumentasi penginstalan/penyiapan LORIS, dan isi materi pengguna akhir yang memberikan pelatihan untuk pengguna baru
Membantu membuat diagram database untuk mengomunikasikan hubungan data (mis. subjek, kunjungan studi) dan meningkatkan visualisasi arsitektur
Bantu perbarui dan tingkatkan kualitas dokumentasi LORIS API
Membantu memperbarui dan meningkatkan kualitas konten yang memperkenalkan orang-orang dengan LORIS, konteks sains terbukanya, dan kasus penggunaannya, yang melibatkan berbagai format media

VI. Linimasa

Ikatan Komunitas (17 Agustus - 13 September) a) Memahami software LORIS dan alur kerja tim secara menyeluruh. b) Meninjau, mengupdate, dan meningkatkan kualitas dokumentasi penginstalan/penyiapan LORIS.

Minggu ke-1 (14 September - 20 September) Perbarui dan migrasikan dokumentasi LORIS dari wiki GitHub ke Baca Dokumen.

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

Minggu ke-3 (28 September - 4 Oktober) Menyelesaikan kekurangan dalam mengisi materi pengguna akhir LORIS yang memberikan pelatihan untuk 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 ke-5 (12 Oktober - 18 Oktober) a) Menyelesaikan tugas pembuatan diagram database LORIS. b) Meninjau LORIS API saat ini dan mulai membantu meningkatkan kualitas dokumentasi API.

Minggu ke-6 (19 Oktober - 25 Oktober) Lanjutkan meningkatkan kualitas dokumentasi LORIS API.

Minggu ke-7 (26 Oktober - 1 November) Selesaikan peningkatan kualitas dokumentasi LORIS API.

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

Minggu ke-9 (9 November - 15 November) Selesaikan update dan peningkatan konteks open science dalam konten memperkenalkan orang ke LORIS.

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

Minggu ke-11 (23 November - 29 November) Selesaikan update dan peningkatan semua kasus penggunaan dalam konten yang memperkenalkan pengguna ke LORIS.

Finalisasi 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 dan mengirimkannya ke Google.

VII. Hasil Mendatang

Setelah Google Season Dokumen 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 lebih banyak ruang untuk peningkatan. Terakhir, karena memiliki latar belakang engineering yang relevan, saya bersedia berkontribusi pada aspek lain dari software LORIS di masa mendatang, misalnya, pengembangan software.