Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- CERN-HSF
- Penulis teknis:
- Joan
- Nama proyek:
- CERN-HSF - Dokumentasi ROOT untuk Adopsi Audiens Umum, Binding Python Dinamis, dan Tutorial
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
CERN-HSF - Dokumentasi ROOT untuk Adopsi Audiens Umum, Binding Python Dinamis, dan Tutorial Mentor: Olivier Couet, Axel Naumann
Abstrak: Dokumentasi sangat penting untuk keberhasilan dan efisiensi adopsi software oleh pengguna. Dokumentasi pengguna yang jelas, akurat, dan komprehensif memfasilitasi kemahiran pengguna dalam menggunakan software saat mereka berusaha mencapai tujuan mereka. Sejalan dengan itu, contoh dan tutorial eksplisit berfungsi sebagai alat canggih yang dapat digunakan pengguna untuk belajar dengan cepat.
Saat kita memeriksa penggunaan ROOT oleh fisikawan, peneliti, dan pengembang dalam ruang analisis dan visualisasi data untuk fisika, ada pengakuan tentang manfaat dokumentasi yang ramah pengguna dan diperbarui. Secara khusus, karena luasnya kode sumber dan pertumbuhannya, sistem dokumentasi akan mendapat manfaat dari perkembangan paralel yang memberi pengguna kemampuan untuk memaksimalkan semua yang ditawarkan AKAR.
Ringkasan & Analisis Dokumentasi Saat Ini Saat ini, dokumentasi pengguna menawarkan panduan yang memungkinkan fisikawan mengadopsi AKAR dengan lebih mudah dibandingkan dengan audiens umum. Selain itu, dalam topik tertentu seperti Dynamic Python Bindings, peningkatan dapat dilakukan untuk dokumentasi yang lebih komprehensif dan jelas. Demikian pula, format data baru RNTuple tidak memiliki spesifikasi terperinci yang diperlukan. Akhirnya, dokumentasi saat ini kehilangan tutorial yang terkait dengan ROOT 7.
Metodologi: Setelah berunding dengan Olivier, tampaknya untuk mengatasi masalah yang disebutkan di atas, fokus utamanya adalah mengidentifikasi kesenjangan pengetahuan antara peneliti khusus dan audiens umum, membuat dokumentasi untuk menjembatani kesenjangan tersebut, menulis dokumentasi Dynamic Python Bindings yang lebih mendetail, menerapkan “tutorial untuk analisis modern” untuk ROOT 7, dan membuat spesifikasi teknis mendetail untuk RNTuple. Sejalan dengan itu, selama proses ini, dokumentasi dapat menggabungkan Jupyter notebooks sehingga alat pembelajaran yang nyata dan interaktif dapat membantu pengguna.
Linimasa: Tahapan proyek diperkirakan adalah: Mengidentifikasi kesenjangan pengetahuan antara peneliti khusus dan audiens umum (sambil membaca dokumentasi dan kode sumber yang ada saat ini) → 1-2 minggu Membuat dan memfaktorkan ulang dokumentasi untuk menjembatani kesenjangan tersebut → 3 minggu Menulis dokumentasi Dynamic Python Bindings yang lebih mendetail → 3 minggu Menerapkan tutorial untuk Dynamic Python Bindings → 3 minggu Mengimplementasikan tutorial mendetail untuk ROOT 7 → 4 minggu
Hasil & Pedoman untuk Sukses: Dokumentasi pengguna terpadu tunggal tanpa kesenjangan apa pun Dokumentasi pengguna yang sepenuhnya diperbarui untuk mencerminkan fitur terbaru, yaitu kelas turunan baru Tutorial melalui notebook Jupyter