Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Bahasa Julia
- Penulis teknis:
- Shuo Liu
- Nama project:
- Dokumen LightGraphs 2.0 & Tutorial JuliaGraphs yang Mudah Digunakan
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Dalam proyek yang berjalan lama ini, saya akan meningkatkan kualitas situs web dan dokumentasi modul di JuliaGraphs. Secara khusus, karya saya akan mencakup, tetapi tidak terbatas pada, konten berikut.
Dokumen LightGraphs 2.0 - 10 Minggu
- Ringkasan: LightGraphs.jl adalah paket grafik ringan yang dioptimalkan untuk Julia, yang berfungsi sebagai inti ekosistem JuliaGraphs. LightGraphs versi 2.0 mendatang mewakili perubahan mendasar pada LightGraphs API. Saya akan memastikan dokumentasinya mewakili fitur LightGraphs terbaru dan terhebat.
- Hasil: Saya akan melakukan audit pada dokumen API yang ada untuk melihat dokumentasi yang dapat tetap sama dan menganalisis perubahan yang dilakukan dalam rilis 2.0 untuk memastikan dokumentasi tersebut didokumentasikan dengan benar beserta contohnya. Selama proses ini, saya akan menulis postingan yang menyoroti perubahan utama dalam rilis 2.0. Untuk membantu pendatang baru lebih memahami LightGraphs, saya akan membuat panduan pemula bagi mereka yang mengambil langkah pertama ke dunia penggunaan grafik di Julia.
- Catatan: Dalam project ini, Documenter.jl akan digunakan sebagai generator dokumen untuk membuat dokumen LightGraphs. Selain referensi API untuk modul seperti Coloring.jl, saya juga memerlukannya untuk submodul seperti greedy_color.jl. Saya akan mempelajari cara menambahkannya untuk memperbarui dokumentasi LightGraphs. Selain itu, teori grafik adalah bidang matematika yang cukup teknis dan tidak jelas bagi mereka yang tidak memiliki latar belakang matematika. Saya telah terlibat dalam penelitian akademis selama sekitar 2 tahun dan menulis banyak postingan blog di situs pribadi saya. Oleh karena itu, saya dengan percaya diri untuk menjelaskan inti berbagai algoritma dan memberikan petunjuk yang dapat digunakan dalam berbagai situasi saat membuat panduan pemula.
Tutorial JuliaGraphs - 10 Minggu
- Ringkasan: Banyak dokumentasi paket JuliaGraphs yang berorientasi pada developer. Saya akan menambahkan beberapa contoh sederhana dan mengilustrasikan penggunaan untuk setiap fitur, sehingga lebih mudah diakses oleh pengguna.
- Hasil: Saya akan melakukan audit pada tutorial LightGraphs yang ada untuk melihat materi apa yang perlu ditambahkan dan menunjukkan penggunaan serta motivasi setiap fitur. Lalu, saya akan mengikuti cara JuliaGraphsTutorials untuk memperluas tutorial JuliaGraphs, termasuk panduan pemula dalam ekosistem LightGraphs.
- Catatan: Konten JuliaGraphsTutorials saat ini tidak cukup menyeluruh, hasil yang tercantum di atas sebagian besar untuk paket LightGraphs. Jika waktu memungkinkan, saya juga akan menambahkan tutorial untuk modul lain di JuliaGraphs seperti GraphPlot.jl, MetaGraphs.jl, dan SimpleWeightedGraphs.jl.
Situs Pusat JuliaGraphs - 4 Minggu
- Ikhtisar: Situs web pusat JuliaGraphs menawarkan ikhtisar paket ekosistem. Namun, sebagian besar masih berupa deskripsi dan dapat ditingkatkan lebih lanjut agar menjadi referensi pertama bagi orang yang memulai grafik di Julia. Saya akan menemukan cara intuitif dengan visualisasi untuk menyoroti fitur berbagai paket JuliaGraphs.
- Hasil: Saya akan menawarkan kasus penggunaan dan contoh untuk menyoroti fungsi paket JuliaGraphs dan melakukan audit untuk memastikan paket tersebut masih relevan dan didukung. Saya akan membuat bagian yang menyoroti berbagai penggunaan berbagai paket di berbagai domain (Kesehatan, Pendidikan, dll.) Jika waktu memungkinkan, saya akan meneliti penjelasan visual tentang algoritma yang digunakan dalam Grafik.
- Catatan: Banyak paket JuliaGraphs telah banyak digunakan dalam domain yang berbeda. Selain memplot ekstensi seperti DiGraph untuk NetworkViz, beberapa aplikasi lain dalam mata pelajaran tertentu yang akan saya sertakan adalah MetaGraph untuk BioStructures dalam Biologi, DijkstraState untuk TrafficAssighnment dalam Perencanaan Kota, DiGraph untuk TreeView dalam Pendidikan, dll.