Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- CERN-HSF
- Penulis teknis:
- LuckInTheRain
- Nama project:
- Memperluas dan meningkatkan dokumentasi ROOT
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Project ini bertujuan untuk meningkatkan dokumentasi ROOT, yang merupakan sistem software 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 project ini, saya juga memahami ROOT (6 & 7) dan memiliki pengetahuan tentang komponen lain yang diperlukan oleh project ini, seperti:
- C++
- Python
- Git/GitHub
- Alat pembuatan situs (html, markdown, Jekyll)
Saya mengidentifikasi tiga bagian utama dalam dokumentasi ROOT:
- situs web https://root.cern,
- panduan referensi kelas C++ https://root.cern/doc/master/,
- forum https://root-forum.cern.ch
Menurut saya, dokumentasi ROOT ("manual ROOT" baru) perlu ditingkatkan dan dilengkapi di area berikut:
- Buku ini akan menjadi lebih mudah diakses dan dipahami oleh non-fisikawan, terutama bab pengantar.
- Tutorial lainnya yang menjelaskan fungsi umum ROOT akan dikembangkan.
- Beberapa topik dan pengembangan baru akan disertakan dengan deskripsi dan contoh terperinci.
Berikut daftar yang dapat saya cantumkan:
- Binding Python
- Pustaka matematika
- Deskripsi manual untuk alat grafis tingkat tinggi (TRatioPLot, THStack)
- Alat analisis data mining 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 ROOT, harus disertakan dalam dokumentasi. Hal ini memerlukan analisis yang cermat terhadap pertanyaan yang paling sering diajukan, diikuti dengan periode sintesis untuk diterjemahkan menjadi potongan-potongan dokumentasi di "ROOT Manual" yang baru atau dalam beberapa tutorial baru dalam Panduan Referensi.
Tutorial yang menggambarkan fungsi yang disediakan oleh ROOT 7.
- Histogram ROOT 7 baru
- Grafik ROOT 7 baru
Perkiraan jadwal waktu (5 bulan):
- Fase 1: Definisi tugas dan cakupan untuk dokumentasi dan tutorial ROOT: 2 minggu.
- Tahap 2: Mengumpulkan dan menganalisis pertanyaan pengguna yang penting dari forum ROOT: 2 minggu
- Fase 3: Menulis dokumentasi ROOT: 8 minggu.
- Tahap 4: Mengembangkan tutorial: 8 minggu
Terakhir, saya harus menambahkan bahwa saya telah berkontribusi pada dokumentasi ROOT tahun lalu dengan project Google Season of Docs jangka panjang. Saya menentukan struktur baru Panduan. Proposal tahun ini akan berkontribusi pada penyelesaian aspek dokumentasi lainnya yang masih belum ada di ROOT.