Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Terpenting
- Penulis teknis:
- @anindita_basu
- Nama proyek:
- Meninjau dan Menyempurnakan Teks Dalam Produk
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Saya bergabung dengan saluran Slack dan memberikan beberapa pertanyaan kepada Eric. Berdasarkan
responsnya (terima kasih, Eric!), Saya mengusulkan untuk menjalankan project ini dengan
cara berikut:
Mengklasifikasikan string
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 menggunakan {i>string<i} yang dilihat pengguna untuk ditinjau terlebih dahulu.
Membuat panduan gaya untuk string
Saya ingin menentukan gaya untuk kapitalisasi, panjang, dan penggunaan kata untuk string yang digunakan dalam item menu, tombol tindakan, label, judul, tooltip, error, peringatan, validasi, notifikasi, dan konfirmasi (lihat screenshot contoh styleguide 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 {i>string<i}, terutama {i>string<i} komposit.
Saya mencoba menyertakan panduan ini pada satu halaman lembar berukuran A4, lebih pendek jika memungkinkan. Tujuannya, developer yang benar-benar menulis string ini harus menemukan panduan dengan cepat dan mudah digunakan, ditambah lagi, jika diikuti, teks UI akan menunjukkan konsistensi di semua layar.
Saya mengusulkan untuk melakukan ini karena dua alasan: (a) agar terdapat konsistensi dalam materi teks dalam hal tata bahasa dan gaya (b) sehingga bahkan setelah GSoD berakhir, ada seperangkat petunjuk yang dapat dirujuk dengan cepat ketika mereka menulis teks UI
Meninjau dan mempertajam teks
Berdasarkan panduan gaya yang dibuat di #2, saya akan mengedit {i>string<i} dan membuat permintaan pull di GitHub.
=============
Durasi
Saya belum tahu berapa banyak {i>string<i} yang merupakan {i>string<i} yang dilihat pengguna (yaitu yang saya usulkan untuk ditinjau dalam proyek ini). Saya memperkirakan bahwa pembuatan panduan gaya akan memerlukan waktu sekitar 3 minggu (mulai dari draf hingga persetujuan), dan pekerjaan ini dapat dilakukan secara bersamaan dengan mengategorikan string sebagai string sistem atau yang dilihat pengguna. Saya mengusulkan untuk memulai dengan asumsi bahwa proyek akan menjadi proyek standar (3 bulan), di mana saya hanya mengambil begitu banyak string untuk ditinjau dalam jangka waktu ini.
Karena saya sudah bekerja purnawaktu, saya hanya dapat bekerja sebagian hari untuk proyek ini. Saya terbuka untuk kemungkinan proyek berdurasi lebih lama jika Anda merasa pengurangan jam kerja saya akan membutuhkannya.