Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Kolektif Terbuka
- Penulis teknis:
- Anna e só
- Nama proyek:
- Tingkatkan dokumentasi bantuan umum
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Kesan pertama Biasanya ditemukan 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 Collective hanya terdiri dari instruksi, sedangkan Add Fiscal Host menyertakan media pendukung.
Pada halaman yang telah saya jelajahi, tidak ada media yang dijelaskan menggunakan atribut teks alternatif. Kurangnya deskripsi gambar menghambat pemahaman lengkap tentang dokumentasi bagi pengguna yang menggunakan pembaca layar dan pengguna dengan koneksi internet yang lebih lambat saat media apa pun mungkin gagal dimuat.
Beberapa bagian dokumentasi menggabungkan FAQ dan petunjuk langsung untuk menavigasi antarmuka pengguna, seperti Change Fiscal Host. Karena tidak ada daftar isi dalam antarmuka dokumentasi, pengguna yang menyadari konsekuensi perubahan dalam catatan pendaftaran dan hanya menginginkan instruksi objektif mungkin menganggap dokumentasi tersebut panjang dan terlalu tangensial.
Meskipun bahasa dokumentasi teknis cukup konsisten, dokumen Panduan Gaya yang tersedia secara publik terlalu sedikit tentang bagaimana dokumentasi harus ditulis. Karena halaman Berkontribusi menyebutkan kontribusi pada dokumentasi teknis, baik Open Collective maupun kontributor potensial akan mendapatkan manfaat dari pedoman yang lebih komprehensif.
Proposal Saya mengusulkan peninjauan terhadap halaman bantuan pengguna, dengan mempertimbangkan kembali presentasi dan struktur saat ini.
Metodologi dan linimasa Saya ingin meningkatkan kualitas dokumentasi Open Collective dengan bekerja bersama komunitas untuk mendorong siklus masukan berkelanjutan dengan durasi yang berbeda-beda.
Periode ikatan komunitas (1 Agustus - 1 September 2019): Kenali komunitas Open Collective! Mewawancarai anggota aktif dari proyek terkemuka dan yang baru memulai, mengajukan pertanyaan kepada mereka tentang status dokumentasi saat ini (Laporan #1). Memperhatikan semua sistem internal yang digunakan untuk melacak kueri dan masalah serta proses mendokumentasikannya dalam Open Collective Docs (Laporan #2). Evaluasi masalah laten dalam versi dokumentasi 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 komunitas selama periode ikatan komunitas. Apakah rencana kita sudah selesai? Apakah ada sesuatu padanya yang perlu diubah? (Laporan #4)
9-20 September: Pengembangan bukti konsep dengan bab dokumentasi yang kurang padat penduduk. Draf Panduan Gaya publik (Laporan #5).
23-25 September: Pengiriman bukti konsep untuk dievaluasi (grup tertutup).
26-27 September: Apakah bukti konsep kami memerlukan penyesuaian sebelum ditayangkan? Apakah kami perlu lebih banyak waktu? Sesuaikan dengan semestinya. (Laporan #6)
30 September—9 Oktober: Proof of concept (Bukti Konsep) mulai ditayangkan. Siklus kedua masukan (grup publik).
10-15 Oktober: Bukti akhir siklus penyesuaian dan evaluasi konsep. (Laporan #7)
16-20 Oktober: Istirahat kecil dari aktivitas [1].
21 Oktober - 23 November: Panduan Gaya Publik sudah final (Laporan #8). Penerapan semua petunjuk yang ada dalam Panduan Gaya untuk semua halaman dokumentasi pengguna (Laporan #9). Laporan yang mengevaluasi semua aktivitas yang dilakukan dan rekomendasi lebih lanjut untuk komunitas (Laporan #10).
Durasi proyek dapat diperpanjang berdasarkan permintaan.
[1]: Perjalanan yang direncanakan sebelum Season saya mengajukan permohonan Dokumen.
Hasil Kerja - Sepuluh laporan publik tentang aktivitas yang dilakukan - Panduan gaya publik yang dapat digunakan oleh Open Collective maupun kontributor eksternal - Halaman dokumentasi pengguna yang diperbarui