Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- OpenMRS
- Teknik yazar:
- Gökkuşağı
- Projenin adı:
- Yeni Geliştiriciler İçin OpenMRS Teknik Belgelerini İyileştirme
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Gerekçe
Dünya COVID-19 pandemisinin sonuçlarından yararlanırken, OpenMRS gibi açık kaynaklı bir tıbbi kayıt sisteminin bu tür krizlerin çözümünün bir parçası olabileceği daha da açıkça görülüyor. Yeni geliştiricilerin OpenMRS ekosisteminde gezinmelerine, ilk katılım süreçlerini kısaltmalarına ve OpenMRS'nin geliştirilmesine hızla katkıda bulunmalarına yardımcı olmak için kısa, öz, net ve güncel belgeler kullanmanız gerekir. Yeni geliştiriciler için mevcut iki doküman mevcuttur: • Geliştirici Olarak Başlarken • Geliştirici Kılavuzu Ancak, içeriğin bir kısmı eski ve biçimin iyileştirilmesi gerekiyor. Bu projenin amacı, bu iki belgenin içeriğini güncellemek ve biçimini daha iyi hale getirerek daha kullanıcı dostu hale getirmektir.
Kapsam
- Bu iki dokümanın içeriğini yeniden düzenleyin ve biçimlendirin. Geliştirici Olarak Kullanmaya Başlama dokümanı için: a. Talimattaki 17 adımı bölümlere ayırın. Her bölümde daha az adım bulunur, böylece kullanıcının daha kolay takip etmesi sağlanır. b. Adımların sırasını yeniden düzenleyin. Bazı adımlar birleştirilebilir. c. Talimatların daha kısa ve okunabilir olması için diğer wiki sayfalarının bağlantılarını tablolarda listeleyin.
Geliştirici Kılavuzu için: a. İlk birkaç bölümdeki OpenMRS arka plan bilgileri kısaltılabilir; kullanıcılar daha fazla bilgi edinmek için OpenMRS.org sayfasına yönlendirilebilir. b. Kurulum bölümü, Geliştirme Süreci bölümünden önce yukarı taşınmalıdır.
İçeriği güncelleyin. Geliştirici Olarak Kullanmaya Başlama dokümanı için: a. Linux ve Windows için ortamın ayarlanmasını güncelleme (Docker'ı tanıtın) b. IntelliJ ve Eclipse için IDE yapılandırmasını güncelleme c. Uygun durumlarda Geliştirici Kılavuzu'na veya Geliştirici Kılavuzu'na bağlantı verin. d. Bağlantı içeriğinin güncel olduğundan emin olun.
Geliştirici Kılavuzu için: a. Geliştirme iş akışını tanıtın. b. Geliştirme ekiplerinin nasıl düzenlendiğini ve ekip üyelerinin birlikte nasıl çalıştığını tanıtın, ekip toplantılarına ve ekip tartışmalarına bağlantılar ekleyin, yeni geliştiricilerin katılmak isteyebilecekleri ekipleri bulmalarına yardımcı olun. c. Sistem kurulumu bölümünde Docker'ı ekleyin. d. Farklı modül türleri (başvuru uygulama modülü, OWA modülü ve platform modülü), bunların birlikte nasıl çalıştığı hakkında ayrıntılı bilgi verin. Her bir modülün nasıl derlenip dağıtıldığını göstermek için basit örnek kodlar ekleyin. Her modül türü için basit test örnekleri ekleyin.
Kitle Analizi
Geliştirici Olarak Kullanmaya Başlama ve Geliştirici Kılavuzu için hedeflenen kitle, OpenMRS hakkında çok az bilgisi olan veya hiç bilgisi olmayan geliştiricilerdir. İki tür geliştirici olabilir: Birinci kitle türü, çok az yazılım geliştirme deneyimi olan veya hiç olmayan yeni geliştiricilerdir. Örneğin, açık kaynak yazılım geliştirme hakkında bilgi edinmek için gerçek hayattan projeler arayan GSoC öğrencileri. Bu geliştiricilerin bilgi eksikliklerini doldurmaya başlayabilmeleri ve nispeten kısa bir süre içinde OpenMRS projelerine katkıda bulunmaya başlayabilmeleri için iki belgede yeterli ayrıntı ve referans sunulmalıdır. Genç geliştiricilerin ana hedefleri şunlardır: 1. OpenMRS'ye katılmak için gereken becerileri anlama (MySQL, Java Spring. React.js, Git vb.) yer alabilir ve bu becerileri öğrenmek için gereken kaynakları bulabilirsiniz. 2. OpenMRS topluluğuna katılın, iletişim araçlarını öğrenin. 3. Ortamı ve IDE'yi ayarlayın. 4. OpenMRS SDK'sını yükleyin. 5. Geliştirme iş akışını anlayın. 6. Yeni modüller oluşturmak için basit kod üretin. 7. Yeni oluşturulan modülleri dağıtın. 8. Modülleri test edin. 9. Pull istekleri oluşturmak için Git kullanın. İkinci kitle türü ise OpenMRS'yi kendi kuruluşlarının ihtiyaçlarına uygun şekilde özelleştirmek veya OpenMRS'ye katkıda bulunmak isteyen orta düzey geliştiriciler ya da kıdemli geliştiricilerdir. Bu daha deneyimli geliştiriciler için iki belge, OpenMRS'ye genel bir bakış sunmalı ve onları Geliştirici Kılavuzu ile diğer kaynaklarda yer alan daha derinlemesine teknoloji ayrıntılarına yönlendirmeye yönelik bir rehber görevi görmelidir. Deneyimli geliştiricilerin ana hedefleri şunlardır: 1. OpenMRS'nin veri modelini ve mimarisini anlama 2. OpenMRS topluluğuna katılın, iletişim araçlarını öğrenin. 3. OpenMRS kod depolarının bağlantılarını bulun. 4. Daha ayrıntılı kaynaklar bulun.
Proje Planı
Planlama aşaması: • Kapsam bölümünde belirlenen hedeflerin hassaslaştırılması • Güncelliğini yitirmiş içerikleri belirleme • İki belgenin ana hatları oluşturma • Ana hatları mentora ve Konu Uzmanlarına (SME'ler) sunma • Proje planını güncelleme
İçerik geliştirme aşaması • Docker'ı öğrenme, tüm kurulum adımlarını uygulama ve basit örnek kod/test kodu üretme • Soru sormak için KOBİ'lerle görüşme • İki belgenin ilk taslağını hazırlama
İçerik inceleme ve yayınlama • İçeriği kendiniz düzenleme • Tamamlanan taslakları geri bildirim için incelemecilere (danışman ve KOBİ'ler) ve son kullanıcılara gönderin • Taslağı gözden geçirin • İki dokümanı OpenMRS wiki sayfasında yayınlayın. • Proje raporu yazmak
Ön Çalışma
Linux sisteminde geliştirme ortamı kurulumu ve OpenMRS SDK kurulumu üzerinde bazı çalışmalar yaptım. IDE'yi yapılandırma sürecindeyim. Basit modüller oluşturmak ve test kodu yazmak üzerinde çalışmaya devam edeceğim.
Referanslar ve Tartışmalar
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-look-learner/18861/14-a%C4%B1%C5%B1m%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C3%B1%2eci2%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%C5%B1%%C5%95