Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Open Collective
- Penulis teknis:
- Anna e só
- Nama project:
- Meningkatkan dokumentasi bantuan umum
- Durasi project:
- Durasi standar (3 bulan)
Project description
Kesan pertama Biasanya Anda akan menemukan halaman dokumentasi yang berisi petunjuk tanpa media pendukung (video, GIF, gambar), sementara bagian lain dalam bab yang sama memiliki entri yang lebih lengkap. Misalnya, Edit Kolektif hanya terdiri dari petunjuk, sedangkan Tambahkan Host Fiskal menyertakan media pendukung.
Di halaman yang saya jelajahi, tidak ada media yang dijelaskan menggunakan atribut teks alternatif. Kurangnya deskripsi gambar akan menghambat pemahaman lengkap tentang dokumentasi bagi pengguna pembaca layar dan pengguna dengan koneksi internet yang lebih lambat, sehingga media apa pun mungkin gagal dimuat.
Beberapa bagian dokumentasi menggabungkan FAQ dan petunjuk langsung untuk menavigasi antarmuka pengguna, seperti Mengubah Host Fiskal. Karena tidak ada daftar isi di antarmuka dokumentasi, pengguna yang mengetahui konsekuensi perubahan dalam catatan pendaftaran dan hanya menginginkan petunjuk objektif mungkin menganggap dokumentasi tersebut panjang dan terlalu tidak relevan.
Meskipun bahasa dokumentasi teknis cukup konsisten, Panduan Gaya yang tersedia secara publik tidak terlalu menjelaskan cara penulisan dokumentasi. Karena halaman Berkontribusi menyebutkan kontribusi pada dokumentasi teknis, Open Collective dan calon kontributor akan mendapatkan manfaat dari panduan yang lebih komprehensif.
Proposal Saya mengusulkan peninjauan halaman bantuan pengguna, dengan memikirkan kembali presentasi dan strukturnya saat ini.
Metodologi dan linimasa Saya ingin meningkatkan kualitas dokumentasi Open Collective dengan bekerja sama dengan komunitas yang mempromosikan siklus masukan berkelanjutan dengan durasi yang bervariasi.
Periode ikatan komunitas (1 Agustus - 1 September 2019): Mengenal komunitas Open Collective. Mewawancarai anggota aktif dari project yang terkenal dan baru dimulai, dengan mengajukan pertanyaan tentang status dokumentasi saat ini (Laporan #1). Mencatat semua sistem internal yang digunakan untuk melacak kueri dan masalah serta proses untuk mendokumentasikannya di Dokumen Open Collective (Laporan #2). Evaluasi masalah laten dalam dokumentasi versi saat ini dan persiapan rencana untuk menyelesaikannya (Laporan #3).
2-6 September: Siklus masukan dan penyesuaian pertama, dengan mempertimbangkan semua komentar dan saran yang dibuat oleh komunitas selama periode ikatan komunitas. Apakah rencana kita sudah baik? Apakah ada hal yang perlu diubah? (Laporan #4)
9-20 September: Pengembangan bukti konsep dengan bab dokumentasi yang tidak terlalu padat. Draf Panduan Gaya publik (Laporan #5).
23-25 September: Pengiriman bukti konsep untuk evaluasi (grup tertutup).
26-27 September: Apakah bukti konsep kami memerlukan penyesuaian sebelum ditayangkan? Apakah kita perlu lebih banyak waktu? Lakukan penyesuaian. (Laporan #6)
30 September - 9 Oktober: Bukti konsep ditayangkan. Siklus masukan kedua (grup publik).
10-15 Oktober: Bukti akhir evaluasi konsep dan siklus penyesuaian. (Laporan #7)
16-20 Oktober: Rehat kecil dari aktivitas [1].
21 Oktober - 23 November: Panduan Gaya Publik sudah final (Laporan #8). Penerapan semua petunjuk yang ada dalam Panduan Gaya ke semua halaman dokumentasi pengguna (Laporan #9). Laporan yang mengevaluasi semua aktivitas yang dilakukan dan rekomendasi lebih lanjut untuk komunitas (Laporan #10).
Durasi project dapat diperpanjang jika diminta.
[1]: Perjalanan direncanakan sebelum pendaftaran Season Dokumen saya.
Hasil Proyek - Sepuluh laporan publik tentang aktivitas yang dilakukan - Panduan gaya publik yang dapat digunakan oleh Open Collective dan kontributor luar - Halaman dokumentasi pengguna yang diperbarui