Unduh PDF
Unduh PDF
Panduan pengguna adalah panduan dalam format kertas atau elektronik (PDF atau XPS) yang memberikan instruksi tentang prosedur atau penggunaan sesuatu. Meskipun “panduan pengguna” sering kali diasosiasikan dengan panduan aplikasi komputer, panduan pengguna juga diberikan bersama komputer dan perangkat elektronik lainnya seperti televisi, stereo, sistem telepon, pemutar MP3, serta peralatan rumah tangga dan perlengkapan kebun dan halaman. Panduan pengguna yang baik mendidik pengguna tentang fitur produk sambil mengajari mereka bagaimana menggunakan fitur tersebut secara efektif. Panduan pengguna disusun sedemikian rupa sehingga mudah dibaca dan dirujuk. Berikut beberapa langkah yang perlu Anda pertimbangkan saat mengembangkan konten yang efektif dan merancang tata letak panduan pengguna.
Langkah
-
Tentukan siapa yang akan menggunakan panduan. Untuk menulis panduan pengguna yang baik, Anda perlu mengembangkan profil pengguna, baik secara formal dengan membuat profil tertulis atau secara informal dengan meluangkan waktu untuk membuat asumsi yang masuk akal tentang karakteristik pengguna. Profil seperti itu berguna saat Anda menjadi bagian dari tim penulisan panduan pengguna dan saat mengerjakan produk yang dimaksud sejak masih berupa konsep hingga ke bentuk akhir. Pertimbangkan faktor berikut saat membuat profil pengguna:
- Lokasi pengguna akan menggunakan panduan tersebut, misalnya di rumah, di kantor, di tempat kerja yang terpencil, atau di mobil. Faktor ini tidak hanya menentukan konten, tetapi juga gaya penulisan yang akan diadopsi oleh panduan.
- Bagaimana pengguna akan menggunakan panduan. Jika mereka jarang menggunakannya atau hanya memerlukannya untuk mencari informasi, sebaiknya panduan dibuat dalam bentuk dokumen referensi. Di sisi lain, jika pengguna akan menggunakannya secara rutin di awal, bagian referensi harus dilengkapi dengan bagian “Cara Memulai” dan petunjuk tentang fungsi paling umum yang akan dilakukan produk tersebut.
- Berapa banyak pengalaman yang dimiliki pengguna terhadap produk atau barang sejenisnya. Jika produk terbilang baru atau sangat berbeda dari produk sejenis, Anda harus menyertakan penjelasan tentang bagaimana produk itu berbeda dibanding yang lain dan instruksi tentang cara menggunakannya. Jika produk berhubungan dengan sesuatu yang sering kali membuat pengguna merasa kesulitan, misalnya aplikasi komputer, Anda harus memberikan informasi dan detail yang sesuai dengan cara yang dapat dipahami.
-
Buatlah panduan yang sesuai dengan kebutuhan pengguna dengan cara yang bisa mereka pahami. Jika pengguna bukan orang-orang yang memiliki pengetahuan teknis, mungkin sebaiknya Anda menghindari bahasa yang sangat teknis dan memberikan penjelasan dengan gamblang dan sederhana. Teks juga harus diatur dengan cara yang menyerupai cara berpikir pengguna. Membuat daftar fitur produk yang dikelompokkan berdasarkan fungsi sering kali lebih masuk akal daripada berdasarkan fitur yang paling sering digunakan.
- Terkadang menggunakan istilah teknis tidak dapat dihindari, misalnya untuk aplikasi pembuat grafik yang mencakup grafik Fibonacci bersama dengan grafik lingkaran ( pie chart ) dan grafik batang yang lebih umum. Dalam kasus seperti ini, akan lebih baik jika Anda mendefinisikan istilah dan memberikan informasi, misalnya penjelasan tentang apa itu grafik Fibonacci dan bagaimana penggunaannya dalam analisis keuangan.
-
Jelaskan masalah yang sedang coba dipecahkan pengguna, kemudian berikan solusi untuk masalah itu. Menawarkan fitur sebagai solusi untuk masalah umum boleh-boleh saja saat mengiklankan produk, tetapi begitu pelanggan memiliki produk, dia perlu memahami cara menggunakannya. Identifikasi masalah yang akan dihadapi pengguna, paparkan di dalam panduan pengguna, diikuti dengan instruksi untuk mengatasinya.
- Jika masalahnya rumit, pecahlah menjadi bagian-bagian kecil. Tuliskan setiap bagian dengan instruksi bagaimana mengatasinya atau menghadapinya, kemudian diikuti dengan setiap bagian lain secara berurutan. Memecah informasi dengan cara seperti ini dikenal sebagai metode pengelompokan atau pemisahan.
Iklan
-
Buatlah halaman sampul dan judul yang sesuai. Anda membutuhkan sampul depan untuk panduan pengguna apa pun yang lebih dari sekadar kartu referensi dan halaman judul untuk panduan yang mencakup lebih dari sekadar selembar kertas terlipat (dengan panjang 4 halaman atau lebih).
- Jika panduan dilindungi oleh hak cipta, pemberitahuan hak cipta harus dicantumkan pada sampul depan dan belakang, serta pada halaman judul.
- Jika ada syarat dan ketentuan untuk menggunakan panduan dan produk yang terkait dengannya, cantumkan di bagian dalam sampul depan.
-
Letakkan referensi ke dokumen terkait dalam kata pengantar. Jika panduan pengguna lebih dari satu, buatlah referensi ke dokumen yang lain, dengan mencantumkan nomor versi yang benar, di sini. Kata pengantar juga merupakan tempat untuk meletakkan bagian “Cara Menggunakan Panduan Ini” jika ada.
-
Sertakan daftar isi jika panduan lebih dari 10 halaman.
-
Letakkan instruksi/prosedur dan bahan referensi di batang tubuh panduan. Dalam kebanyakan kasus, baik prosedur dan bahan referensi masing-masing harus memiliki bagian tersendiri. Namun, Anda dapat memberi tahu pengguna untuk merujuk pada konten spesifik dalam satu bagian dan membedakannya dengan bagian lainnya. Dengan cara ini, pengguna bisa dengan cepat menemukan informasi yang dia cari.
- Prosedur harus ditulis dalam struktur yang konsisten di seluruh bagian instruksi pada panduan. Mulailah dengan gambaran umum fungsi produk, lalu jelaskan apa yang harus dilakukan pengguna dan hasil apa yang akan dia dapatkan atau lihat. Langkah-langkahnya harus diberi nomor dan dimulai dengan kata kerja tindakan, seperti cara penulisan langkah-langkah dalam setiap bagian artikel ini.
- Bahan referensi dapat meliputi daftar pilihan, kiat-kiat pemecahan masalah, dan pertanyaan umum. Glosarium dan indeks dapat ditambahkan di akhir panduan, meskipun daftar istilah yang sering digunakan bisa diberikan di awal. Indeks bisa diabaikan jika panduan memiliki kurang dari 20 halaman.
-
Gunakan gambar grafis sesuai kebutuhan untuk mendukung teks. Gambar grafis, atau tangkapan layar, dapat memberikan ilustrasi poin-poin tertentu dalam panduan secara lebih baik dibanding teks, terutama dalam prosedur kompleks yang membuat pengguna membutuhkan konfirmasi visual untuk memastikan mereka mengikuti langkah-langkah dengan benar. Gambar grafis dapat dibuat menggunakan computer-aided drafting (CAD) atau aplikasi pengedit grafis, kamera digital dan aplikasi pengolah foto, atau jika Anda ingin menggunakan tangkapan layar, gunakan fitur tangkapan layar yang ada di komputer atau program grafis dengan kemampuan menangkap layar.
- Begitu Anda membuat gambar grafis, simpan dalam format terkompresi sehingga Anda dapat menggunakannya dalam aplikasi pengolah kata atau desktop publishing . Anda juga perlu memperkecil ukuran gambar agar lebih sesuai dengan halaman, tetapi tetap memberikan detail yang lengkap untuk pengguna. (Jika perlu, Anda bisa memotong gambar asli menjadi beberapa bagian dan menunjukkan bagian yang relevan bersama teks yang mendukungnya).
- Jika Anda menggunakan banyak gambar grafis dalam prosedur, pastikan gambar dibuat dengan ukuran yang konsisten, entah dalam dimensi panjang dan lebar yang sama atau dalam proporsi memperkecil ukuran gambar asli. Dengan begitu, gambar akan terlihat lebih menarik bagi pengguna. Hal yang sama juga berlaku saat membuat tangkapan layar dari komputer; pastikan komputer menampilkan skema warna standar saat mengambil gambar jika panduan akan menampilkan tangkapan layar berwarna.
- Meskipun aplikasi pengedit gambar seperti Photoshop dan Paint Shop Pro memiliki kemampuan pengambilan gambar yang baik, program yang didedikasikan untuk mengambil tangkapan layar seperti SnagIt juga menawarkan kemampuan untuk memodifikasi, membuat katalog dan anotasi pada tangkapan layar dengan mudah.
Iklan
-
Pilih beberapa fon yang mudah dibaca. Meskipun komputer dapat mendukung sejumlah fon, tujuan pembuatan panduan pengguna adalah mudah dibaca. Memilih beberapa fon yang serasi adalah cara terbaik untuk mencapai tujuan tersebut. Fon bisa dikelompokkan menjadi dua jenis: serif dan sans serif .
- Fon serif memiliki garis hias kecil di ujung garis utama yang membentuk huruf. Fon yang termasuk kelompok serif diantaranya Times New Roman , Baskerville , dan Book Antiqua . Fon serif sangat cocok untuk sebagian besar teks yang ditampilkan dalam ukuran 10-12 di batang tubuh utama untuk panduan cetak.
- Fon sans serif hanya menampilkan garis yang membentuk huruf, tanpa hiasan. Fon yang termasuk kelompok sans serif di antaranya Arial , Calibri , dan Century Gothic . Fon sans serif dapat digunakan untuk sebagian besar teks dengan ukuran 8 sampai 10 dalam file PDF atau panduan daring, meskipun dengan tidak adanya hiasan membuat kalimat yang ditampilkan dengan fon ukuran 12 atau lebih besar menjadi lebih sulit dibaca. Namun, fon dapat digunakan secara efektif dalam ukuran lebih besar untuk menampilkan judul dan heading , dan dalam ukuran lebih kecil sangat cocok untuk catatan kaki dan nomor dalam kolom dan tabel.
- Secara umum, akan lebih baik jika Anda memilih fon sederhana seperti Arial atau Times New Roman untuk panduan, meskipun Anda dapat menggunakan fon dekoratif untuk kutipan atau judul jika Anda menulis panduan untuk gim video dengan latar fantasi atau fiksi ilmiah. (Dalam hal kutipan, sering kali Anda dapat menggunakan fon sederhana dan menampilkan kutipan lengkap dengan huruf miring).
- Setelah memutuskan fon-fon yang akan digunakan, buatlah halaman contoh untuk memverifikasi bahwa fon-fon tersebut terlihat serasi di atas kertas. Anda juga harus menunjukkan halaman contoh ini kepada orang yang bertanggung jawab memberikan persetujuan untuk tampilan panduan sebelum Anda melanjutkan dengan proses penulisan.
-
Pikirkan tentang tata letak. Setelah memilih fon untuk panduan, Anda harus memutuskan bagaimana menyusun konten di atas halaman.
- Secara umum, Anda mungkin harus menempatkan judul dokumen atau judul bab dalam header atau footer , mungkin menggunakan judul panduan di sebelah kiri halaman dan judul bab di sebelah kanan halaman. Anda harus menempatkan nomor halaman di header atau footer , entah di luar ( header atau footer ) atau di tengah (hanya di footer ). Anda mungkin juga perlu membedakan halaman pertama setiap bagian atau bab dari halaman lain dengan menempatkan nomor halaman di tengah footer dan halaman berikutnya di sudut luar header .
- Anda mungkin perlu membuat teks sisipan di dalam kotak berwarna atau kotak yang diblok untuk membedakannya dengan teks lainnya. Pastikan Anda memilih warna atau tingkat pengeblokan sehingga tidak membuat teks sulit dibaca.
- Berikan margin yang cukup lebar di semua sisi, dengan ruang ekstra di bagian tepi yang akan dijilid.
-
Pertimbangkan jenis jilid untuk panduan pengguna. Jika panduan lebih dari 4 halaman, halaman harus dijilid dengan cara tertentu. Meskipun dokumen internal dapat dijepit dengan stapler di sudut halaman, panduan pengguna eksternal yang dikirimkan bersama produk biasanya dijilid dengan salah satu dari 3 metode berikut:
- Metode side-stapling (dijepit pada bagian sisi halaman dengan stapler) untuk panduan yang dicetak di kertas berukuran 21 x 27,5 cm, 21 x 35 cm, atau 27,5 x 42,5 cm yang dilipat. Sebagian besar panduan murah yang terdiri dari 48 halaman atau lebih sedikit dijilid dengan cara seperti ini.
- Metode saddle-stitching (dijahit di bagian sisi halaman) lebih sering digunakan untuk panduan referensi pihak ketiga dibanding panduan yang disertakan dengan produk selain mobil, meskipun beberapa panduan yang lebih panjang dijilid dengan cara ini. (Panduan Paint Shop Pro awalnya dilengkapi panduan yang dijilid dengan cara saddle-stitching saat masih diproduksi oleh JASC Software).
- Jilid spiral paling cocok untuk panduan yang digunakan di lingkungan yang lebih keras, misalnya di luar ruangan (dalam hal ini metode side-stapling dan saddle-stitching tidak cukup kuat sehingga halaman akan terlepas). Beberapa panduan yang dijilid spiral mungkin juga dilengkapi halaman yang dilaminasi plastik untuk mencegah agar tidak rusak saat basah atau terkena lumpur.
-
Buatlah dokumen templat untuk panduan. Banyak aplikasi pengolah kata dan desktop publishing menawarkan pilihan untuk membuat dokumen templat untuk panduan pengguna. Jadi, saat Anda mengetik, teks akan muncul secara otomatis dengan fon yang Anda pilih untuk bagian panduan yang sedang Anda kerjakan. (Sebenarnya, artikel ini pada awalnya ditulis menggunakan templat Microsoft Word). Sebagian besar program ini juga menyertakan seperangkat templat standar yang dapat Anda modifikasi sesuai kebutuhan sehingga Anda tidak perlu membuat templat sendiri dari nol.
- Aplikasi pengolah kata dan desktop publishing juga menawarkan kemampuan untuk menciptakan “gaya”, ukuran fon yang telah ditetapkan untuk header , footer , heading , dan teks batang tubuh. Anda dapat memilih salah satu nama gaya yang telah ditetapkan (misalnya, Heading , Normal, Quote ) atau membuat gaya sendiri dengan nama sendiri. Sedapat mungkin, ikuti konvensi untuk membuat nama gaya jika Anda memiliki beberapa gaya untuk jenis teks yang sama. (Contohnya, nama gaya yang diadopsi Microsoft Word untuk heading adalah Heading1 , Heading2 , dan sebagainya untuk heading utama sampai beberapa tingkat subhead ). Cobalah untuk membuat semua gaya yang akan Anda butuhkan terlebih dahulu sehingga Anda tidak perlu berhenti dan membuatnya di tengah-tengah proses pengetikan yang sebenarnya.
Iklan
Tips
- Gunakan field code atau variabel teks jika memungkinkan. Anda dapat menetapkan nilai-nilai seperti nama produk, judul panduan atau judul bab, dan menaruhnya di dalam dokumen sehingga Anda tidak perlu mengetik teks yang sebenarnya. Saat Anda menampilkan pratinjau atau mencetak panduan, teks otomatis terisi untuk variabel tersebut. Jika nama produk berubah, atau jika Anda ingin mengubah nama panduan atau bab, akan lebih mudah untuk mengubah informasi tersebut dengan mengubah nilai variabel teks daripada melakukan pencarian dalam dokumen dan menggantinya.
Iklan
Hal yang Anda Butuhkan
- Aplikasi pengolah kata atau desktop publishing
- Aplikasi pengedit grafis atau program penangkap layar
Referensi
- http://www.asktog.com/columns/017ManualWriting.html
- http://headrush.typepad.com/creating_passionate_users/2007/03/the_best_user_t.html
- http://klariti.com/technical-writing/User-Guides-Tutorial.shtml
- Rodney Ruff, Omaha, NE; berpengalaman lebih dari 10 tahun dalam menulis berkas bantuan dan panduan pengguna
Tentang wikiHow ini
Halaman ini telah diakses sebanyak 46.176 kali.
Iklan
