Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- CERN-HSF
- Penulis teknis:
- Budi
- 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 AKAR untuk Adopsi Audiens Umum, Binding Python Dinamis, dan Tutorial Mentor: Olivier Couet, Axel Naumann
Abstrak: Dokumentasi sangat penting untuk adopsi software yang sukses dan efisien oleh pengguna. Dokumentasi pengguna yang jelas, akurat, dan komprehensif memfasilitasi kemahiran pengguna dalam menggunakan software saat mereka berusaha mencapai tujuan mereka. Oleh karena 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 analisis data dan ruang visualisasi untuk fisika, ada pengakuan tentang manfaat dokumentasi yang ramah pengguna dan diperbarui. Secara khusus, karena luasnya kode sumber dan pertumbuhannya, sistem dokumentasi mendapatkan manfaat dari perkembangan paralel itu sehingga 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 khalayak 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. Terakhir, dokumentasi saat ini tidak memiliki tutorial yang terkait dengan AKAR 7.
Metodologi: Setelah berunding dengan Olivier, tampaknya untuk mengatasi masalah yang disebutkan di atas, fokus utamanya harus melibatkan identifikasi kesenjangan pengetahuan antara peneliti khusus dan audiens umum, membuat dokumentasi untuk menjembatani kesenjangan tersebut, menulis dokumentasi yang lebih mendetail tentang Dynamic Python Bindings, 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 sebagai berikut: Mengidentifikasi kesenjangan pengetahuan antara peneliti khusus dan audiens umum (saat membaca dokumentasi dan kode sumber saat ini) → 1-2 minggu Membuat dan memfaktorkan ulang dokumentasi untuk menjembatani kesenjangan tersebut → 3 minggu Menulis dokumentasi yang lebih mendetail tentang Binding Python Dinamis → 3 minggu Menerapkan tutorial untuk Binding Python Dinamis → 3 minggu Mengimplementasikan spesifikasi proyek secara mendetail untuk ROOT 7 → 4 minggu
Hasil & Panduan untuk Sukses: Dokumentasi pengguna terpadu tunggal tanpa ada celah Dokumentasi pengguna yang sepenuhnya diperbarui untuk mencerminkan fitur terbaru, mis. kelas turunan baru Tutorial melalui notebook Jupyter