CERN-HSF projesi

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:
LuckInTheRain
Proje adı:
ROOT dokümanlarını genişletme ve iyileştirme
Proje uzunluğu:
Uzun süreli (5 ay)

Proje açıklaması

Projenin amacı, dünya çapında yüksek enerjili fizik topluluğu tarafından kullanılan veri analizi ve veri sunumuna yönelik ana yazılım sistemi olan ROOT'un belgeleme sürecini iyileştirmektir.

Proje için sağlayabileceğim teknik yazarlık becerilerinin yanı sıra ROOT (6 ve 7) hakkında bilgi sahibiyim ve projenin gerektirdiği diğer bileşenler hakkında bilgim var. Örneğin:

  • C++
  • Python
  • Git/GitHub
  • Web sitesi oluşturma araçları (html, markdown, Jekyll)

ROOT belgelerinde üç ana parça tespit ediyorum:

  • https://root.cern web sitesi,
  • C++ sınıf referans kılavuzu https://root.cern/doc/master/,
  • https://root-forum.cern.ch forumu

Bana göre ROOT belgelerinin (yeni "ROOT kılavuzu") iyileştirilmesi ve aşağıdaki alanlarda bu belgelere katkıda bulunması gerekiyor:

  • Özellikle giriş bölümleri, fizikçi olmayanlar için daha erişilebilir ve anlaşılır hale gelecektir.
  • ROOT'un genel işlevlerini açıklayan daha fazla eğitim geliştirilecektir.
  • Bazı yeni konular ve gelişmeler ayrıntılı açıklamalar ve örneklerle dahil edilecek. Bunlardan bazıları:
    • Python bağlaması
    • Matematiksel kitaplıklar
    • Yüksek düzey grafik araçları (TRatioPLot, THStack) için manuel açıklama
    • Yeni veri madenciliği analiz araçları (RDataFrame ve RNtuple)
  • Yeni temel veri biçimleri (RDataFrame ve RNtuple) için ayrıntılı teknik özellikler ve eğitici içerikler gerekir.

  • Kullanıcılardan gelen önemli soruların (ROOT forumunda yayınlananlar gibi) cevapların dokümanlara eklenmesi gerekir. Bu, en sık sorulan soruların ayrıntılı bir şekilde analiz edilmesini ve ardından bu soruları yeni "ROOT Kılavuzu"ndaki veya Referans Kılavuzu'ndaki yeni eğitici içeriklere dönüştürmek için bir sentez dönemi geçirmeyi gerektirir.

  • ROOT 7 tarafından sağlanan işlevleri gösteren eğiticiler.

    • Yeni ROOT 7 histogramları
    • Yeni ROOT 7 grafikleri

Tahmini süre programı (5 ay):

  • 1. Aşama: ROOT dokümanları ve eğitimleri için görevlerin ve kapsamın tanımı: 2 hafta.
  • 2. Aşama: ROOT forumunda önemli kullanıcıların sorularını toplayın ve analiz edin: 2 hafta
  • 3. Aşama: ROOT belgelerini yazma: 8 hafta.
  • 4. Aşama: Eğitimler geliştirme: 8 hafta

Son olarak, geçen yıl uzun süreli bir Google Dokümanlar Sezonu projesiyle ROOT dokümanlarına katkıda bulunduğumu da eklemek isterim. Kılavuzun yeni yapısını tanımladım. Bu yılki teklif, ROOT'ta hâlâ eksik olan diğer doküman özelliklerinin tamamlanmasına katkıda bulunacaktır.