Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- Bahasa Julia
- Penulis teknis:
- sophb
- Nama project:
- Mengubah Situs FluxML
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Proposal ini bertujuan untuk meningkatkan situs web dokumentasi Flux, sehingga informasi di dalamnya menjadi terstruktur dan menarik bagi para pendatang baru dan pakar. Lebih khusus lagi, tujuannya adalah untuk mengatur ulang dokumentasi yang ada ke dalam bagian baru dan membuat tutorial memulai baru untuk pendatang baru yang memperluas tutorial Flux 60-mine-blitz.
Project ini terdiri dari fase berikut:
Menganalisis situs dokumentasi saat ini: Audit informasi yang ada dan tentukan panduan gaya (untuk informasi) guna membuat tutorial baru.
Menentukan struktur baru untuk informasi dan tutorial memulai: Bekerja sama dengan mentor untuk menentukan bagian baru dan reorganisasi situs dokumentasi. Selain itu, tentukan daftar isi untuk tutorial memulai menggunakan tutorial Flux 60-mine-blitz sebagai titik awal dan kembangkan dari sana.
Mengubah struktur informasi: Perbarui situs web dengan rencana yang ditentukan melalui kerja sama dengan mentor pada langkah sebelumnya.
Buat tutorial memulai: Tulis draf pertama lalu tinjau. Mendapatkan umpan balik dari mentor. Setelah mentor dan saya memutuskan bahwa kami memiliki versi akhir dokumen ini, saya akan memublikasikannya ke situs dokumentasi.
(Opsional) Mengonversi dokumentasi yang ada dalam bentuk README ke HTML: Jika saya memiliki waktu tersisa setelah menyelesaikan empat fase utama, saya dapat mengonversi tutorial yang ada yang berupa README sehingga lebih mudah diakses dari situs.
Untuk mencapai sasaran project, saya akan bekerja sama dengan komunitas Flux untuk memahami dokumentasi yang ada dan menentukan pendekatan terbaik. Saya sendiri adalah pendatang baru di Julia dan saya yakin hal ini akan sangat membantu dalam menentukan tingkat informasi yang tepat untuk tutorial memulai yang baru.
Saya akan berfokus untuk memastikan bahwa pekerjaan saya membantu komunitas Flux untuk orientasi tentang penggunaan baru. Selain itu, saya akan fokus untuk membantu pengguna berpengalaman menemukan kasus penggunaan baru dan menjelajahi detail Flux yang lebih mendetail.