Cara Menulis Panduan Pengguna Hebat untuk Hampir Apa Pun

Daftar Isi:

Anonim

Sekali waktu, manual pengguna yang solid disertai produk-produk baru dari segala jenis, memberikan instruksi luas tentang cara mempelajari semua fungsi dan memaksimalkan penggunaan Anda. Namun, saat ini, panduan pengguna yang disediakan pabrik jauh lebih sepintas dan sering dalam berbagai bahasa, memperumit kurva belajar Anda. Untuk memiliki panduan pengguna yang layak adalah komoditas berharga dan jika Anda tahu cara menulisnya, ini adalah bakat yang sangat diminati. Ini hanyalah masalah menguasai beberapa prinsip utama.

Item yang Anda butuhkan

  • Microsoft Word atau program pengolah kata lainnya

  • Koleksi clip art atau foto digital

  • Perangkat lunak pembuat halaman web sederhana

Tentukan formatnya, apakah dokumen cetak, halaman web, email atau kombinasi. Setelah Anda menulis dalam satu format, mudah untuk mentransfernya ke format lain. Beberapa orang lebih nyaman membaca dokumen cetak yang dapat mereka pegang dan simpan. Orang lain mungkin lebih suka URL atau tautan ke dokumen di situs web Anda.

Terorganisir, jelas, dan ringkas. Mengantisipasi dan menjelaskan tidak hanya apa yang akan dilakukan pengguna produk tetapi juga apa yang tidak boleh dilakukan. Anda harus menulis dengan mata ke arah keduanya.

Mulai dari awal, buka hanya informasi yang diperlukan secara logis. Menulis dengan suara aktif, bukan pasif. Jaga agar salinan Anda ramping, menghilangkan kata-kata asing. Tetap sederhana dan metodis.

Pecah teks dengan foto, ilustrasi, atau diagram sebanyak mungkin. Membuat pembaca mengarungi teks tanpa akhir dengan paragraf mengerikan adalah cara yang pasti untuk kehilangan mereka. Paragraf dan halaman yang panjang dan rumit tidak masalah untuk manual teknis tetapi tidak sesuai untuk panduan pengguna yang sederhana. Tetap pendek dan manis.

Peringatkan pembaca apa yang tidak boleh dilakukan pada berbagai interval. Ini membantu meminimalkan frustrasi ketika mempelajari produk atau aplikasi baru.

Berikan pembaca dengan sumber daya lain yang dapat mereka gunakan untuk melengkapi panduan Anda.

Kiat

  • Tulis dengan istilah yang sangat sederhana. Jangan menganggap tingkat pengetahuan apa pun. Apa yang tampaknya mudah dan luas bagi Anda mungkin tidak demikian bagi pembaca Anda. Gunakan grafik, clip art, dan foto berkualitas tinggi untuk menyempurnakan tampilan dokumen Anda dan meningkatkan keterbacaan. Buat paragraf dan deskripsi singkat.

Peringatan

Jangan pernah berasumsi bahwa pembaca sudah terbiasa dengan produk tersebut. Tulis setiap panduan seolah-olah mereka belum pernah melihatnya sebelumnya.