Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- OpenMRS
- Penulis teknis:
- Pelangi
- Nama project:
- Memperbaiki Dokumentasi Teknis OpenMRS untuk Developer Baru
- Durasi project:
- Durasi standar (3 bulan)
Project description
Alasan
Saat dunia menderita akibat 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 menjelajahi ekosistem OpenMRS, mempersingkat proses orientasi mereka, dan memungkinkan lebih banyak pendatang baru untuk dapat berkontribusi dengan cepat pada pengembangan OpenMRS, dokumentasi yang ringkas, jelas, dan terbaru diperlukan. Ada dua dokumen yang ada untuk developer baru: • Memulai sebagai Developer • Panduan Developer Namun, beberapa kontennya sudah tidak berlaku dan formatnya perlu ditingkatkan. Tujuan project ini adalah memperbarui konten dan meningkatkan format kedua dokumen ini agar lebih mudah digunakan.
Cakupan
- Atur ulang dan format ulang konten kedua dokumen ini. Untuk dokumen Memulai sebagai Developer: a. Bagi 17 langkah dalam petunjuk menjadi beberapa bagian, setiap bagian berisi lebih sedikit langkah, sehingga lebih mudah diikuti oleh pengguna. b. Atur ulang urutan langkah; beberapa langkah dapat digabungkan. c. Cantumkan tautan ke halaman wiki lainnya dalam tabel, sehingga instruksi lebih ringkas dan mudah dibaca.
Untuk Panduan Developer: a. Informasi latar belakang OpenMRS di beberapa bab pertama dapat dipersingkat, pengguna dapat diarahkan ke halaman OpenMRS.org untuk mengetahui informasi lebih lanjut. b. Bab Penyiapan harus dipindahkan ke atas sebelum bab Proses Pengembangan
Perbarui konten. Untuk dokumen Memulai sebagai Developer: a. Menyiapkan lingkungan update untuk Linux dan Windows (Memperkenalkan Docker) b. Update konfigurasi IDE untuk IntelliJ dan Eclipse c. Link ke Panduan Developer atau Panduan Developer jika berlaku. d. Pastikan semua konten yang ditautkan sudah yang terbaru.
Untuk Panduan Developer: a. Memperkenalkan alur kerja pengembangan. b. Memperkenalkan cara tim pengembangan diatur, cara anggota tim bekerja sama; menambahkan link ke rapat tim, diskusi tim; membantu developer baru menemukan tim yang mungkin ingin mereka ikuti. c. Menambahkan Docker di bab penyiapan sistem. d. Menambahkan detail selengkapnya tentang berbagai jenis modul (modul aplikasi referensi, modul OWA, dan modul platform), cara kerjanya bersama-sama. e. Menambahkan 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. Ada dua jenis developer: Jenis audiens pertama adalah developer junior yang memiliki sedikit atau tanpa pengalaman pengembangan software. Misalnya, siswa GSoC, yang mencari project di dunia nyata untuk mempelajari pengembangan software open source. Bagi para pengembang tersebut, kedua dokumen tersebut harus menyajikan detail dan referensi yang cukup sehingga mereka dapat mulai mengisi kekosongan pengetahuan, dan mulai berkontribusi pada proyek OpenMRS dalam waktu yang relatif singkat. Sasaran utama untuk developer junior adalah: 1. Memahami keterampilan yang diperlukan 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. Men-deploy modul yang baru dibuat. 8. Menguji modul. 9. Gunakan Git untuk membuat permintaan pull. Jenis audiens yang kedua adalah developer tingkat menengah atau developer senior yang ingin menyesuaikan OpenMRS dengan kebutuhan organisasi mereka sendiri atau untuk berkontribusi pada OpenMRS. Bagi developer yang lebih berpengalaman ini, kedua dokumen tersebut harus memberikan ringkasan tentang OpenMRS dan berfungsi sebagai panduan untuk mengarahkan mereka ke detail teknologi yang lebih mendalam di Panduan Developer dan referensi lainnya. Sasaran utama bagi developer berpengalaman adalah: 1. Memahami model dan arsitektur data OpenMRS 2. Bergabunglah dengan komunitas OpenMRS, pelajari alat komunikasi. 3. Menemukan link ke repositori kode OpenMRS. 4. Temukan referensi yang lebih mendalam.
Rencana Proyek
Fase perencanaan: • Mempertajam sasaran yang ditetapkan di bagian Cakupan • Mengidentifikasi konten yang sudah tidak berlaku • Membuat ringkasan untuk kedua dokumen tersebut • Mempresentasikan ringkasan kepada mentor dan Pakar Materi (SME) • Memperbarui rencana project
Fase pengembangan konten • Pelajari Docker, lakukan semua langkah penginstalan, dan buat contoh kode/kode pengujian sederhana • Wawancarai SME untuk mengajukan pertanyaan • Kembangkan draf pertama dari dua dokumen
Peninjauan dan publikasi konten • Mengedit konten sendiri • Mengirim draf yang telah selesai kepada peninjau (mentor dan SME) dan pengguna akhir untuk mendapatkan masukan • Merevisi draf • Memublikasikan kedua dokumen di halaman wiki OpenMRS. • Menulis laporan project
Pekerjaan Awal
Saya telah melakukan beberapa pekerjaan terkait penyiapan lingkungan pengembangan di sistem Linux dan penyiapan OpenMRS SDK. Saya sedang dalam proses mengonfigurasi IDE. Saya akan terus berupaya mem-build 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/14 https://talk.openmrs.org/t/looking-for-a-mentor-for-gsod2020-project-improving-documentation-for-new-developers/28999 https://talk.openmrs.org/t/a-possible-new-gsod-2020-project/28947