Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- CERN-HSF
- {i>Technical writer <i}(Penulis teknis):
- John
- Nama project:
- CERN-HSF - Dokumentasi ROOT untuk Penerapan Audiens Umum, Binding Python Dinamis, dan Tutorial
- Durasi proyek:
- Berjalan lama (5 bulan)
Project description
CERN-HSF - ROOT Documentation for General Audience Adoption, Dynamic Python Bindings, and Tutorials Mentor: Olivier Couet, Axel Naumann
Abstrak: Dokumentasi sangat penting untuk keberhasilan dan efisiensi penggunaan software oleh pengguna. Dokumentasi pengguna yang jelas, akurat, dan komprehensif memfasilitasi kemahiran pengguna dengan software saat mereka berusaha mencapai tujuan mereka. Oleh karena itu, contoh dan tutorial eksplisit berfungsi sebagai alat yang efektif yang dapat digunakan pengguna untuk belajar dengan cepat.
Saat kami memeriksa penggunaan ROOT oleh fisikawan, peneliti, dan developer dalam ruang analisis dan visualisasi data untuk fisika, ada pengakuan atas manfaat dokumentasi yang mudah digunakan dan diperbarui. Secara khusus, karena luasnya kode sumber dan pertumbuhannya, sistem dokumentasi akan mendapatkan manfaat dari perkembangan paralel untuk memberi pengguna kemampuan untuk memaksimalkan semua yang ditawarkan ROOT.
Ringkasan &Analisis Dokumentasi Saat Ini Saat ini, dokumentasi pengguna menawarkan panduan yang memungkinkan fisikawan mengadopsi ROOT 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 mendetail yang diperlukan. Akhirnya, dokumentasi saat ini tidak menyertakan tutorial terkait ROOT 7.
Metodologi: Setelah berkonsultasi 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 Dynamic Python Bindings yang lebih mendetail, menerapkan “tutorial untuk analisis modern” untuk ROOT 7, dan membuat spesifikasi teknis mendetail untuk RNTuple. Sejalan dengan hal tersebut, selama proses ini, dokumentasi dapat menyertakan Jupyter Notebook sehingga alat pembelajaran yang nyata dan interaktif dapat membantu pengguna.
Linimasa: Tahap-tahap untuk project ini diperkirakan sebagai berikut: Mengidentifikasi kesenjangan pengetahuan antara peneliti khusus dan audiens umum (sambil membaca dokumentasi dan kode sumber 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 Menerapkan tutorial untuk ROOT 7 → 4 minggu Membuat spesifikasi teknis mendetail untuk RNTuple → 3 minggu Meninjau tujuan project telah berhasil diselesaikan → 1 minggu
Hasil & Panduan untuk Sukses: Dokumentasi pengguna terpadu tunggal tanpa celah Dokumentasi pengguna yang sepenuhnya diperbarui untuk mencerminkan fitur terbaru, yaitu class turunan baru Tutorial melalui notebook Jupyter