Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- OpenMRS
- Penulis teknis:
- Pelangi
- Nama proyek:
- Meningkatkan Dokumentasi Teknis OpenMRS untuk Developer Baru
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Argumentasi
Saat dunia menghadapi konsekuensi pandemi COVID-19, semakin jelas bahwa sistem rekam medis open source seperti OpenMRS dapat menjadi bagian dari solusi untuk krisis semacam ini. Untuk membantu developer baru memahami ekosistem OpenMRS, mempersingkat proses orientasi, dan memungkinkan lebih banyak pendatang baru agar dapat berkontribusi dengan cepat pada pengembangan OpenMRS, kita harus memiliki dokumentasi yang ringkas, jelas, dan terbaru. Ada dua dokumen untuk developer baru: • Memulai sebagai Developer • Panduan Developer Namun, beberapa konten sudah usang dan formatnya perlu ditingkatkan. Tujuan dari proyek ini adalah untuk memperbarui konten dan meningkatkan format kedua dokumen ini agar lebih mudah digunakan.
Cakupan
- Mengatur ulang dan memformat ulang konten kedua dokumen ini. Untuk dokumen Memulai sebagai Developer: a. Bagi 17 langkah dalam petunjuk menjadi beberapa bagian, setiap bagian berisi langkah yang lebih sedikit, sehingga lebih mudah bagi pengguna untuk mengikutinya. b. Atur ulang urutan langkah; beberapa langkah dapat digabungkan. c. Buat daftar tautan ke halaman wiki lainnya dalam tabel, sehingga petunjuk lebih ringkas dan mudah dibaca.
Untuk Panduan Developer: a. Informasi latar belakang OpenMRS dalam beberapa bab pertama dapat dipersingkat, pengguna dapat diarahkan ke halaman OpenMRS.org untuk mengetahui lebih lanjut. b. Bab Pengaturan harus dipindahkan sebelum bab Proses Pengembangan
Perbarui konten. Untuk dokumen Memulai sebagai Developer: a. Mengupdate lingkungan yang disiapkan untuk Linux dan Windows (Memperkenalkan Docker) b. Mengupdate konfigurasi IDE untuk IntelliJ dan Eclipse c. Menautkan ke Panduan Developer atau Panduan Developer jika ada. d. Pastikan semua konten link-ke sudah yang terbaru.
Untuk Panduan Developer: a. Memperkenalkan alur kerja pengembangan. b. Memperkenalkan cara penyusunan tim pengembangan, cara anggota tim bekerja sama; menambahkan link ke rapat tim, diskusi tim; membantu developer baru menemukan tim yang ingin mereka ikuti. c. Menambahkan Docker di bab penyiapan sistem. d. Tambahkan detail lebih lanjut tentang berbagai jenis modul (modul aplikasi referensi, modul OWA, dan modul platform), cara kerjanya bersama. e. Tambahkan kode contoh sederhana untuk menunjukkan bagaimana setiap jenis modul dibangun dan di-deploy. f. Tambahkan contoh pengujian sederhana untuk setiap jenis modul.
Analisis Audiens
Audiens yang dituju untuk Memulai sebagai Developer dan Panduan Developer adalah developer yang memiliki sedikit atau tidak memiliki pengetahuan tentang OpenMRS. Mungkin ada dua jenis developer: Jenis audiens pertama adalah developer junior dengan sedikit atau tanpa pengalaman pengembangan software. Misalnya, mahasiswa GSoC yang sedang mencari proyek dunia nyata untuk belajar tentang pengembangan software open source. Bagi para pengembang ini, kedua dokumen tersebut harus menyajikan detail dan referensi yang cukup sehingga mereka dapat mulai mengisi kesenjangan pengetahuan, dan mulai berkontribusi pada proyek OpenMRS dalam waktu yang relatif singkat. Tujuan utama bagi pengembang junior adalah: 1. Memahami keterampilan yang dibutuhkan untuk berpartisipasi dalam OpenMRS (MySQL, Java Spring. React.js, Git, dll.) dan temukan referensi untuk mempelajari keterampilan ini. 2. Bergabunglah dengan komunitas OpenMRS, pelajari alat komunikasi. 3. Menyiapkan lingkungan dan IDE. 4. Instal OpenMRS SDK. 5. Memahami alur kerja pengembangan. 6. Buat kode sederhana untuk membuat modul baru. 7. Deploy modul yang baru dibuat. 8. Modul pengujian. 9. Menggunakan Git untuk membuat permintaan pull. Jenis audiens kedua adalah developer tingkat menengah atau developer senior yang ingin menyesuaikan OpenMRS agar sesuai dengan kebutuhan organisasi mereka atau berkontribusi pada OpenMRS. Bagi developer yang lebih berpengalaman, kedua dokumen tersebut harus memberikan ringkasan OpenMRS dan berfungsi sebagai panduan untuk mengarahkan mereka ke detail teknologi yang lebih mendalam dalam Panduan Developer dan referensi lainnya. Tujuan utama bagi developer berpengalaman adalah: 1. Memahami model dan arsitektur data OpenMRS 2. Bergabunglah dengan komunitas OpenMRS, pelajari alat komunikasi. 3. Temukan link ke repositori kode OpenMRS. 4. Temukan referensi yang lebih mendalam.
Rencana Proyek
Fase perencanaan: • Menyempurnakan tujuan yang ditetapkan di bagian Cakupan • Mengidentifikasi konten usang • Membuat garis besar dua dokumen • Mempresentasikan garis besar kepada mentor dan Pakar Materi Pokok (SME) • Memperbarui rencana proyek
Fase pengembangan konten • Pelajari Docker, pelajari semua langkah penginstalan, dan hasilkan kode contoh/kode pengujian sederhana • Wawancarai UKM untuk mengajukan pertanyaan • Kembangkan draf pertama dari dua dokumen
Peninjauan dan publikasi konten • Edit sendiri konten • Kirim draf yang sudah selesai kepada peninjau (mentor dan UKM) serta pengguna akhir untuk meminta masukan • Perbaiki draf • Publikasikan kedua dokumen di halaman wiki OpenMRS. • Menulis laporan proyek
Pekerjaan Awal
Saya telah menyelesaikan beberapa pekerjaan terkait lingkungan pengembangan yang disiapkan di sistem Linux dan penyiapan OpenMRS SDK. Saya sedang dalam proses mengonfigurasi IDE. Saya akan terus membuat modul sederhana dan menulis kode pengujian.
Referensi dan Diskusi
https://talk.openmrs.org/t/breaking-down-walls-and-attracting-more-devs-to-openmrs/28502 https://talk.openmrs.org/t/openmrs-course-on-udemy-for-new-developer-learner/18861/.