Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Mattermost
- Penulis teknis:
- @anindita_basu
- Nama project:
- Meninjau dan Meningkatkan Kualitas Teks dalam Produk
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Saya bergabung ke channel Slack dan mengajukan beberapa pertanyaan kepada Eric. Berdasarkan
responsnya (terima kasih, Eric!), Saya mengusulkan untuk mendekati project ini dengan
cara berikut:
Mengklasifikasikan {i>string<i}
Saya akan mulai dengan mengidentifikasi string mana (https://github.com/mattermost/mattermost-webapp/blob/master/i18n/en.json) yang merupakan string konsol sistem, dan string mana yang ditampilkan kepada pengguna. Saya mengusulkan untuk membahas string yang ditampilkan kepada pengguna untuk ditinjau terlebih dahulu.
Membuat panduan gaya untuk {i>string<i}
Saya ingin menentukan gaya untuk penggunaan huruf besar, panjang, dan kata untuk string yang digunakan dalam item menu, tombol tindakan, label, judul, tooltip, error, peringatan, validasi, notifikasi, dan konfirmasi (lihat contoh screenshot panduan gaya di https://github.com/AninditaBasu/AninditaBasu.github.io/blob/master/gsod/Capture7.PNG). Selain itu, saya ingin membuat beberapa panduan seputar penggunaan token (placeholder) dalam string, terutama string gabungan.
Panduan ini ditujukan untuk satu halaman pada lembar ukuran A4, lebih pendek jika memungkinkan. Tujuannya adalah, developer yang benar-benar menulis string ini akan menemukan panduan yang cepat dan mudah digunakan, plus, jika diikuti, teks UI akan menunjukkan konsistensi di semua layar.
Saya mengusulkan untuk melakukan ini karena dua alasan: (a) sehingga ada konsistensi dalam materi teks dalam hal tata bahasa dan gaya (b) sehingga bahkan setelah GSoD berakhir, ada satu set instruksi yang dapat dengan cepat dirujuk ketika mereka menulis teks UI
Meninjau dan menyempurnakan teks
Berdasarkan panduan gaya yang dibuat di langkah #2, saya akan mengedit string dan membuat permintaan pull di GitHub.
=============
Durasi
Saya belum tahu berapa banyak string yang terlihat oleh pengguna (yang saya usulkan untuk ditinjau dalam project ini). Saya memperkirakan bahwa pembuatan panduan gaya akan memerlukan waktu sekitar 3 minggu (dari draf hingga persetujuan), dan pekerjaan ini dapat dilakukan secara bersamaan dengan mengategorikan string sebagai string sistem atau yang ditampilkan kepada pengguna. Saya mengusulkan untuk mulai dengan asumsi bahwa proyek akan menjadi proyek berdurasi standar (3 bulan), di mana saya hanya menggunakan begitu banyak {i>string<i} untuk ditinjau sebanyak mungkin dalam jangka waktu ini.
Karena saya sudah bekerja penuh waktu, saya hanya dapat mengerjakan project ini sebagian hari. Saya terbuka untuk kemungkinan project berdurasi lebih lama jika Anda merasa pengurangan jam kerja saya akan memerlukannya.