Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Bahasa Julia
- Penulis teknis:
- mkg33
- Nama proyek:
- Dokumentasi terpadu dari Scientific Machine Learning
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Saya ingin bekerja pada penyatuan organisasi SciML karena ada banyak hal yang dapat ditingkatkan di bidang ini dan penyelesaian proyek ini jelas akan memberikan manfaat langsung, baik bagi programmer Julia maupun kontributor/pemelihara SciML aktif. Paket-paket yang tersebar di seluruh SciML menawarkan beberapa alat yang sangat berguna, tetapi selalu ada bahaya bahwa paket tersebut mungkin tidak diperhatikan (terutama oleh pendatang baru) hanya karena pengguna tidak dapat menemukan paket dan menerapkannya pada masalah yang dihadapi.
Hal ini agak menjengkelkan mengingat tujuan utama paket ini adalah untuk menjangkau banyak audiens programmer (baik pemula maupun pakar). Untuk menghindari situasi yang dijelaskan di atas, saya mengusulkan untuk merevisi 'halaman depan' dokumentasi SciML secara menyeluruh dan membuat semacam hub yang dapat digunakan pengguna untuk menelusuri paket terkait dan mengeksplorasi ekosistem yang berkembang. Portofolio juga dapat berfungsi sebagai titik referensi yang berharga bagi pengguna yang lebih berpengalaman dan memungkinkan mereka untuk bekerja dengan lebih efisien.
Pertama-tama, dokumentasi yang ada dari semua paket individual memerlukan revisi sehubungan dengan masalah gaya yang paling dasar (seperti ejaan, tanda baca, tata bahasa, dll.). Untuk memastikan konsistensi gaya, SciML perlu memiliki panduan gaya yang konkret (sangat diperlukan untuk membuat perubahan retrospektif dan sebagai referensi di masa mendatang). Akan membuang-buang waktu untuk memulai dari awal. Sebaliknya, laporan ini harus didasarkan pada konvensi Julia yang ada dan menyertakan keseluruhan baru untuk masalah khusus SciML.
Setelah {i>style guide<i} selesai, saya bermaksud untuk merevisi dokumentasi saat ini di fase kedua proyek. Ini akan membuat dokumentasi terlihat lebih profesional dan stabil. Saya sudah membuat beberapa permintaan pull yang menggambarkan pendekatan saya terhadap tugas ini. Pada fase ini, saya juga bermaksud untuk merancang (dan menerapkan) sistem kutipan yang efisien. Tugas pertama adalah memperbarui halaman kutipan yang sudah usang.
Fase ketiga, yang bisa dikatakan paling penting, akan melibatkan perancangan roadmap SciML, yang akan menekankan interaksi antara paket-paket yang tersebar. Semakin kuat kohesi antara dua paket (sehubungan dengan masalah atau kode itu sendiri), keduanya akan muncul dalam daftar 'lihat juga'. Saya mengusulkan untuk membuat dua kunci rekomendasi: satu untuk kesamaan kode dan satu untuk kesamaan masalah. Dengan cara ini, pengguna akan dapat mengidentifikasi paket lain yang berpotensi berguna jauh lebih cepat daripada dengan menelusuri repositori dan dokumentasi masing-masing yang susah payah. Alih-alih mencantumkan semua koneksi yang mungkin di antara paket, saya lebih suka fokus pada paket yang lebih besar dan mencoba menyajikan tautan dengan paket yang lebih kecil (metode ini juga akan diperluas untuk memperbarui tutorial di mana koneksi dengan paket lain harus ditunjukkan). Pendekatan ini menjamin bahwa daftar 'lihat juga' akan informatif tanpa menjadi enumerasi lengkap kombinasi paket.