Cara Menulis Dokumentasi Pengguna untuk Panduan Gaya Web

Panduan gaya menjabarkan aturan penggunaan untuk elemen visual suatu merek; mereka biasanya digunakan oleh organisasi yang ingin menjaga gambar yang konsisten di seluruh konten yang dibuat oleh banyak orang. Panduan gaya Web sangat penting jika konten online Anda dibuat dan diedit oleh pengguna dengan berbagai tingkat keahlian. Dengan menetapkan aturan khusus untuk halaman Web yang terkait dengan organisasi Anda, Anda dapat membantu memastikan setiap halaman akan mempromosikan identitas profesional dan konsisten. Saat Anda menulis dokumentasi pengguna untuk panduan gaya, gunakan bahasa yang jelas, ringkas dan tulis ke pengguna dengan tingkat keterampilan desain Web terendah.

1.

Buka dokumentasi dengan penjelasan keseluruhan tata letak dan gaya Web untuk setiap jenis halaman. Meskipun kategori halaman tertentu akan bervariasi menurut organisasi, pertimbangkan halaman arahan, halaman judul, homepage, halaman sub-kategori, halaman hanya gambar dan halaman hanya teks. Gunakan diagram struktural untuk menjelaskan hierarki informasi yang kompleks dan termasuk grafik yang menunjukkan contoh setiap tata letak.

2.

Jelaskan bagaimana logo dapat digunakan pada berbagai jenis halaman Web. Biarkan pengguna tahu di mana mereka harus meletakkan logo dan daftar batas atas dan bawah untuk ukuran. Jika Anda memiliki beberapa tata letak logo dan variasi warna, daftarkan tempat-tempat yang mungkin digunakan; menggunakan tanda logo saja diperbolehkan pada halaman yang menggunakan judul lengkap organisasi dalam judul, misalnya. Sertakan file logo dalam dokumentasi Anda dengan dimensi untuk memudahkan pengguna menyimpan versi yang benar. Tutup teks dengan kalimat yang memperingatkan pengguna untuk tidak mengubah warna, bentuk, ukuran atau tata letak logo Anda untuk mencegah pengeditan yang tidak sah.

3.

Buat daftar font khusus yang harus digunakan di semua halaman Web organisasi Anda. Sertakan font untuk tajuk berita utama, subjudul, judul, teks isi, keterangan dan kutipan. Untuk setiap kategori, berikan nama font, ukuran dan apakah huruf tebal, miring, bergaris bawah, atau huruf besar.

4.

Tulis tentang pengecualian Web ke panduan gaya offline organisasi. Sertakan elemen yang bukan merupakan masalah dengan bahan cetak, seperti bagaimana menyajikan tautan dalam teks atau apakah menyertakan sumber luar atau tidak pada akhir halaman. Jika grup Anda memiliki gaya online yang lebih informal, jelaskan kepada pengguna cara mencapai nada saat menulis salinan Web.

5.

Beri tahu pengguna warna apa yang dapat mereka gunakan saat mendesain halaman. Buat daftar warna untuk setiap jenis teks, garis besar foto, tajuk, bilah navigasi, dan pemisah halaman. Berikan kode warna RGB spesifik untuk memastikan konsistensi. Jelaskan kepada pengguna bahwa warna adalah cara yang ampuh untuk mengekspresikan citra merek Anda dan mengingatkan mereka untuk menggunakan hanya warna yang dinyatakan untuk mempertahankan pengalaman pengguna secara keseluruhan.

6.

Susun aturan untuk penggunaan foto di halaman Web organisasi. Jika semua halaman Anda memiliki desain spesifik, jelaskan di mana pengguna dapat menempatkan foto. Daftar dimensi piksel yang diperlukan untuk berbagai penggunaan: foto dalam teks, foto header atau foto sidebar, misalnya. Untuk membuat situs web lebih mudah dimuat, berikan resolusi gambar spesifik - untuk Web, 72 dpi adalah standar. Beri tahu pengguna untuk memotong, mengubah ukuran, dan mengedit gambar sebelum menempatkannya di situs web untuk mengoptimalkan kecepatan.

7.

Tutup dokumentasi dengan menjelaskan pernyataan atau elemen desain yang diperlukan yang harus ada di setiap jenis halaman. Sertakan item seperti pernyataan kerja dengan kesempatan yang sama dan pemberitahuan hak cipta dan beri tahu pengguna penempatan yang tepat di halaman. Jika Anda memiliki grafik atau gambar yang seharusnya muncul di halaman, daftarkan persyaratan penempatan dan sediakan file untuk segera diunduh.