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:
- CERN-HSF
- Teknik yazar:
- John
- Proje adı:
- CERN-HSF: Genel Kitle Kullanımına Yönelik ROOT Belgeleri, Dinamik Python Bağlantıları ve Eğiticiler
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
CERN-HSF - Genel Kitlenin Kullanımına Yönelik ROOT Belgeleri, Dinamik Python Bağlamaları ve Eğiticiler Mentor: Olivier Couet, Axel Naumann
Özet: Kullanıcıların yazılımı başarılı ve verimli bir şekilde benimsemesi için dokümanlar çok önemlidir. Net, doğru ve kapsamlı kullanıcı dokümanları, kullanıcıların hedeflerine ulaşmak için yazılımı kullanma becerilerini kolaylaştırır. Bu bağlamda, açık örnekler ve eğitici içerikler, kullanıcıların hızlı bir şekilde öğrenebileceği güçlü araçlardır.
Fizik alanındaki veri analizi ve görselleştirme alanında fizikçiler, araştırmacılar ve geliştiriciler tarafından ROOT'un kullanımını incelerken kullanıcı dostu ve güncellenmiş dokümanların avantajlarının farkındayız. Özellikle kaynak kodun kapsamı ve büyümesi nedeniyle, doküman sistemi, kullanıcılara ROOT'un sunduğu tüm avantajlardan yararlanma olanağı tanımak için paralel olarak gelişiyor.
Mevcut Dokümanların Özeti ve Analizi Mevcut kullanıcı dokümanlarında, fizikçilerin ROOT'u genel kitleye kıyasla daha kolay benimsemelerini sağlayan bir kılavuz sunulmaktadır. Ayrıca, Dinamik Python Bağlamaları gibi belirli konularda daha kapsamlı ve net dokümanlar için iyileştirmeler yapılabilir. Benzer şekilde, yeni veri biçimi RNTuple'da da gerekli ayrıntılı spesifikasyonlar eksiktir. Son olarak, mevcut dokümanda ROOT 7 ile ilgili eğitici içerikler eksik.
Metodoloji: Olivier ile görüştükten sonra, söz konusu sorunların çözülmesi için başlıca odak noktasının uzman araştırmacılar ile genel kitle arasındaki bilgi boşluklarını belirlemek, bu boşluğu doldurmak için belgeler oluşturmak, Dynamic Python Bağlamaları hakkında daha ayrıntılı dokümanlar yazmak, ROOT 7 için "modern analiz için eğiticiler" uygulamak ve RNTuple için ayrıntılı teknik spesifikasyonlar oluşturmak olduğu belirlendi. Aynı şekilde, somut ve etkileşimli öğrenim araçlarının kullanıcılara yardımcı olabilmesi için belgeler, bu süreçte Jupyter not defterlerini de sürece dahil edebilir.
Zaman çizelgesi: Projenin aşamaları şu şekilde tahmin edilir: Uzman araştırmacılarla genel hedef kitle arasındaki bilgi boşluklarını tespit edin (mevcut belgeleri ve kaynak kodunu okurken) → 1-2 hafta Bu boşluğu kapatmak için belgeler oluşturun ve yeniden düzenleme yapın → 3 hafta Dinamik Python Bağlantıları hakkında daha ayrıntılı belgeler yazın → 3 hafta Dinamik Python Bağlantıları için ayrıntılı eğitimler oluşturun → 4 hafta için ayrıntılı teknik spesifikasyonları uygulayın → 4 hafta için ayrıntılı teknik spesifikasyonlar oluşturun
Teslim Edilecek Ürünler ve Başarı İçin Kurallar: Herhangi bir boşluk içermeyen tek bir birleşik kullanıcı dokümanı En son özellikleri (ör. yeni türetilmiş sınıflar) yansıtacak şekilde tamamen güncellenmiş kullanıcı dokümanı Jupyter not defterleri aracılığıyla eğitici içerikler