Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- OpenMRS
- Teknik yazar:
- Gökkuşağı
- Proje adı:
- Yeni Geliştiriciler İçin OpenMRS Teknik Belgelerini İyileştirme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Gerekçe
Dünya COVID-19 salgınının sonuçlarından muzdaripken OpenMRS gibi açık kaynak bir tıbbi kayıt sisteminin bu tür krizlerin çözümünün bir parçası olabileceği daha da netleşiyor. Yeni geliştiricilerin OpenMRS ekosisteminde gezinmesine, ilk katılım süreçlerini kısaltmasına ve daha fazla yeni katılımcının OpenMRS'in geliştirilmesine hızlı bir şekilde katkıda bulunabilmesine yardımcı olmak için kısa, net ve güncel dokümanlara sahip olmak gerekir. Yeni geliştiriciler için iki doküman mevcuttur: • Geliştirici Olarak Başlama • Geliştirici Kılavuzu Bununla birlikte, içeriklerin bir kısmı güncel değildir ve biçimin iyileştirilmesi gerekir. Bu projenin amacı, bu iki dokümanın içeriğini güncellemek ve biçimini daha kullanıcı dostu hale getirmektir.
Kapsam
- Bu iki dokümanın içeriğini yeniden düzenleyin ve biçimlendirin. Geliştirici Olarak Başlarken dokümanı için: a. Talimattaki 17 adımı, kullanıcının takip etmesini kolaylaştırmak için bölümlere ayırın. Her bölümde daha az adım bulunmalıdı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üne taşınmalıdır.
İçeriği güncelleyin. Geliştirici Olarak Başlayın dokümanı için: a. Linux ve Windows için ortam kurulumunu güncelleme (Docker'ı tanıtma) b. IntelliJ ve Eclipse için IDE yapılandırmasını güncelleyin. Uygun olduğu durumlarda Geliştirici Kılavuzu'nun veya Geliştirici Rehberi'nin bağlantısı. d. Bağlantısı verilen tüm içeriklerin 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ı anlatın, ekip toplantılarının ve ekip tartışmalarının bağlantılarını ekleyin, yeni geliştiricilerin katılmak isteyebilecekleri ekipleri bulmasına yardımcı olun. c. Sistem kurulumu bölümüne Docker'ı ekleyin. d. Farklı modül türleri (referans uygulama modülü, OWA modülü ve platform modülü) ve bunların birlikte nasıl çalıştıkları hakkında daha fazla ayrıntı ekleyin. Her modül türünün nasıl oluşturulduğunu ve dağıtıldığını gösteren basit örnek kodlar ekleyin. f. Her modül türü için basit test örnekleri ekleyin.
Kitle Analizi
Geliştirici Olarak Başlama ve Geliştirici Kılavuzu'nun hedef kitlesi, OpenMRS hakkında çok az bilgiye sahip olan veya hiç bilgisi olmayan geliştiricilerdir. İki tür geliştirici olabilir: İlk kitle türü, yazılım geliştirme deneyimi az olan veya hiç olmayan yeni başlayan geliştiricilerdir. Örneğin, açık kaynak yazılım geliştirme hakkında bilgi edinmek için gerçek dünyadaki projeler arayan GSoC öğrencileri. Bu geliştiriciler için bu iki doküman, bilgi eksikliklerini gidermeye başlayabilmeleri ve nispeten kısa bir süre içinde OpenMRS projelerine katkıda bulunabilmeleri için yeterli ayrıntı ve referans sunmalıdır. Yeni başlayan geliştiricilerin başlıca hedefleri şunlardır: 1. OpenMRS'ye (MySQL, Java Spring) katılmak için gereken becerileri anlayın. React.js, Git vb.) ve bu becerileri öğrenmek için kaynakları bulun. 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 kodlar oluşturun. 7. Yeni oluşturulan modülleri dağıtın. 8. Modülleri test edin. 9. Pull isteği göndermek için Git'i kullanın. İkinci kitle türü, OpenMRS'yi kendi kuruluşlarının ihtiyaçlarına göre ö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 bu iki doküman, OpenMRS'ye genel bir bakış sunmalı ve geliştirici kılavuzundaki ve diğer kaynaklardaki daha ayrıntılı teknoloji bilgilerine yönlendiren bir rehber görevi görmelidir. Deneyimli geliştiricilerin başlıca hedefleri şunlardır: 1. OpenMRS'nin veri modelini ve mimarisini anlayın. 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 hedefleri iyileştirme • Eski içerikleri belirleme • İki doküman için ana hatlar oluşturma • Özeti mentora ve konunun uzmanlarına (SME'ler) sunma • Proje planını güncelleme
İçerik geliştirme aşaması • Docker'ı öğrenin, tüm kurulum adımlarını uygulayın ve basit örnek kod/test kodu oluşturun • SME'lerle görüşerek soru sorun • İki dokümanın ilk taslağını geliştirin
İçerik inceleme ve yayınlama • İçerikleri kendi kendinize düzenleyin • Tamamlanan taslakları geri bildirim için incelemecilere (mentor ve SME'ler) ve son kullanıcılara gönderin • Taslağı düzeltin • İki belgeyi OpenMRS wiki sayfasında yayınlayın. • Proje raporu yazma
Ön Çalışma
Linux sisteminde geliştirme ortamı oluşturma ve OpenMRS SDK'yı ayarlama konusunda bazı çalışmalar yaptım. IDE'yi yapılandırıyorum. Basit modüller oluşturmaya ve test kodu yazmaya 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-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