Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Bahasa Julia
- Penulis teknis:
- sophb
- Nama proyek:
- Mengubah situs FluxML
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Proposal ini bertujuan untuk meningkatkan kualitas situs dokumentasi Flux agar informasi di dalamnya terstruktur dan menarik bagi pendatang baru dan pakar. Lebih spesifik lagi, tujuannya adalah untuk menata ulang dokumentasi yang ada menjadi bagian-bagian baru dan membuat tutorial memulai yang baru bagi pendatang baru yang memperluas tutorial Flux 60-mine-blitz.
Proyek ini terdiri dari fase-fase berikut:
Analisis situs web dokumentasi saat ini: Audit informasi yang ada dan tentukan panduan gaya (sebagai informasi) untuk membuat tutorial baru.
Menentukan struktur baru untuk informasi dan tutorial memulai: Bekerja samalah dengan para mentor untuk menentukan bagian baru dan menata ulang situs web dokumentasi. Tentukan juga daftar isi untuk tutorial memulai menggunakan tutorial Flux 60-mine-blitz sebagai titik awal dan kembangkan berdasarkan tutorial tersebut.
Susun ulang informasi: Perbarui situs web dengan rencana yang ditetapkan melalui kerja sama dengan para mentor di langkah sebelumnya.
Membuat tutorial memulai: Tulis draf pertama dan tinjau. Memperoleh umpan balik dari para mentor. Ketika mentor dan saya memutuskan bahwa kami memiliki versi akhir dokumen ini, saya akan mempublikasikannya ke situs web dokumentasi.
(Opsional) Konversi dokumentasi yang ada dalam bentuk README menjadi HTML: Jika saya memiliki waktu tersisa setelah menyelesaikan empat fase utama, maka saya dapat mengubah tutorial yang ada yang merupakan README sehingga tutorial tersebut lebih mudah diakses dari situs.
Untuk mencapai tujuan proyek ini, 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 fokus untuk memastikan bahwa pekerjaan saya membantu komunitas Flux untuk memperkenalkan penggunaan baru. Selain itu, saya akan fokus membantu pengguna berpengalaman untuk menemukan kasus penggunaan baru dan mengeksplorasi detail Flux yang lebih mendetail.