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:
- CERN-HSF
- Teknik yazar:
- Can
- Projenin adı:
- CERN-HSF - Genel Kitle Benimseme, Dinamik Python Bağlamaları ve Eğiticiler için ROOT Belgeleri
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
CERN-HSF - Genel Kitle Benimseme, Dinamik Python Bağlamaları ve Eğiticiler için ROOT Belgeleri Mentor: Olivier Couet, Axel Naumann
Özet: Kullanıcılar tarafından yazılımın başarılı ve verimli bir şekilde benimsenmesi için belgeler olmazsa olmazdır. Anlaşılır, doğru ve kapsamlı kullanıcı belgeleri, kullanıcılar hedeflerine ulaşmak için çalışırken yazılımdaki yetkinliğini artırır. Bu doğrultuda, açık örnekler ve eğitimler kullanıcıların hızlı bir şekilde öğrenmelerini sağlayan güçlü araçlar görevi görür.
Fizik için veri analizi ve görselleştirme alanında ROOT'un fizikçiler, araştırmacılar ve geliştiriciler tarafından kullanımını incelerken, kullanıcı dostu ve güncellenmiş belgelerin faydalarının kabul edildiğini görüyoruz. Özellikle, kaynak kodun genişliği ve büyümesi sayesinde, dokümantasyon sistemi kullanıcılara ROOT'un sunduğu tüm olanakları en üst düzeye çıkarmak için paralel olarak gelişen bir değişimden faydalanır.
Mevcut Belgelerin Özeti ve Analizi Şu anda kullanıcı dokümanları, fizikçilerin genel kitleye göre KÖY'ü daha kolay benimsemelerini sağlayan bir kılavuz sunuyor. Ayrıca, Dynamic Python Bindings gibi belirli konularda daha kapsamlı ve net belgeler için iyileştirmeler yapılabilir. Benzer şekilde, yeni RNTuple veri biçimi için gerekli ayrıntılı özellikler de mevcut değil. Son olarak, mevcut dokümanlarda ROOT 7 ile ilgili eğiticiler eksiktir.
Metodoloji: Oliivier ile görüştükten sonra, yukarıda belirtilen sorunları ele almak için ana odak noktasının uzman araştırmacılar ile genel bir kitle arasındaki bilgi boşluklarını belirlemek, bu boşluğu dolduracak dokümanlar hazırlamak, Dinamik Python Bağlantıları hakkında daha ayrıntılı bir belge yazmak, ROOT 7 için "modern analiz için eğiticiler"i uygulamak ve RNTuple için ayrıntılı teknik özellikler oluşturmak gerektiğini anladım. Aynı şekilde bu süreçte, dokümanlarda Jupyter not defterleri yer alabilir. Böylece, somut ve etkileşimli öğrenim araçları kullanıcılara yardımcı olabilir.
Zaman çizelgesi: Proje aşamalarının şu şekilde olacağı tahmin edilir: Uzman araştırmacılar ve genel kitle arasındaki bilgi boşluklarını tespit edin (mevcut belgeleri ve kaynak kodunu okurken) → 1-2 hafta Bu boşluğu doldurmak için belgeler oluşturun ve yeniden düzenleyin. → 3 hafta Dinamik Python Bağlamaları ile ilgili daha ayrıntılı bir belge hazırlayın → 3 hafta Dinamik Python Bağlamaları için daha ayrıntılı bir belge hazırlayın → 3 hafta Dinamik Python Bağlamaları için ayrıntılı eğitimler oluşturun → 3 hafta ayrıntılı Python proje hedefleri için eğiticiler oluşturun → 3 hafta boyunca TPG'ler için ayrıntılı eğitimler oluşturun
Başarı için Teslimatlar ve Yönergeler: Herhangi bir boşluk olmadan, tek bir birleşik kullanıcı belgesi En yeni özellikleri (ör. türetilmiş yeni sınıfları) yansıtacak şekilde tamamen güncellenmiş kullanıcı dokümanları Jupyter not defterleri aracılığıyla eğiticiler