Project CERN-HSF

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:
CERN-HSF
Penulis teknis:
LuckInTheRain
Nama proyek:
Memperluas dan meningkatkan dokumentasi AKAR
Durasi proyek:
Jangka panjang (5 bulan)

Project description

Proyek ini memiliki tujuan untuk memperbaiki dokumentasi AKAR, yaitu sistem perangkat lunak utama untuk analisis data dan presentasi data yang digunakan oleh komunitas fisika energi tinggi di seluruh dunia.

Selain keterampilan penulis teknis yang dapat saya berikan untuk proyek ini, saya juga akrab dengan AKAR (6 & 7) dan saya memiliki pengetahuan tentang komponen lain yang dibutuhkan oleh proyek, seperti:

  • C++
  • Python
  • Git/GitHub
  • Alat konstruksi situs web (html, markdown, Jekyll)

Saya mengidentifikasi tiga bagian utama dalam dokumentasi AKAR:

  • situs web https://root.cern,
  • panduan referensi kelas C++ https://root.cern/doc/master/,
  • forum https://root-forum.cern.ch

Menurut saya, dokumentasi AKAR ("manual AKAR") yang baru perlu ditingkatkan dan dilengkapi dengan hal-hal berikut:

  • Seharusnya, konten ini menjadi lebih mudah diakses dan dipahami oleh non-fisika, khususnya bab pendahuluan.
  • Tutorial lainnya yang menjelaskan fungsi umum dari AKAR akan dikembangkan.
  • Beberapa topik dan pengembangan baru akan disertakan dengan deskripsi dan contoh mendetail. Di antara opsi yang dapat saya cantumkan:
    • Binding Python
    • Perpustakaan matematika
    • Deskripsi manual untuk alat grafis tingkat tinggi (TRatioPLot, THStack)
    • Alat analisis penambangan data baru (RDataFrame dan RNtuple)
  • Format data kunci baru (RDataFrame dan RNtuple) memerlukan spesifikasi dan tutorial teknis yang mendetail.

  • Jawaban atas pertanyaan penting dari pengguna, seperti yang diposting di forum AKAR, perlu disertakan dalam dokumentasi. Hal ini memerlukan analisis yang baik dari pertanyaan yang paling sering diajukan diikuti dengan periode sintesis untuk menerjemahkannya menjadi beberapa dokumentasi dalam "Manual AKAR" yang baru atau dalam beberapa tutorial baru dalam Panduan Referensi.

  • Tutorial yang menggambarkan fungsionalitas yang disediakan oleh ROOT 7.

    • Histogram ROOT 7 baru
    • Grafis ROOT 7 baru

Perkiraan jadwal waktu (5 bulan):

  • Fase 1: Definisi tugas dan ruang lingkup untuk dokumentasi dan tutorial AKAR: 2 minggu.
  • Fase 2: Mengumpulkan dan menganalisis pertanyaan pengguna penting dari forum AKAR: 2 minggu
  • Fase 3: Menulis dokumentasi AKAR: 8 minggu.
  • Tahap 4: Tutorial pengembangan: 8 minggu

Terakhir, saya harus menambahkan bahwa saya telah berkontribusi pada dokumentasi AKAR tahun lalu dengan proyek Google Season Dokumen jangka panjang. Saya menentukan struktur baru Pedoman ini. Proposal tahun ini akan berkontribusi pada penyelesaian aspek dokumentasi lain yang masih belum ada di ROOT.