Isi

• Melangkah
• Bagian 1 dari 4: Merencanakan manual pemilik Anda
• Bagian 2 dari 4: Sematkan informasi penting
• Bagian 3 dari 4: Menjelaskan perawatan produk
• Bagian 4 dari 4: Tulis manual yang dapat dibaca
• Tips

Perangkat lunak, komputer, permainan, dan perangkat memerlukan panduan pengguna; panduan yang menjelaskan cara menggunakan produk (dan cara tidak menggunakannya). Panduan pengguna adalah dokumen formal dengan struktur khusus dan harus ditulis oleh seseorang yang mengetahui produk secara menyeluruh, seperti penulis teknis atau perancang produk. Menulis manual pengguna yang efektif mengharuskan Anda mengetahui siapa yang akan menggunakan produk dan bahwa Anda menulis manual dengan mempertimbangkan pengguna ini. Jaga agar tulisan Anda jelas, tepat dan sederhana untuk memastikan pengalaman pengguna yang bebas repot.

Melangkah

Bagian 1 dari 4: Merencanakan manual pemilik Anda

1. Lakukan analisis pengguna. Panduan pengguna harus ditulis untuk pengguna - mereka yang akan membeli produk atau layanan Anda dan membaca panduan pengguna. Analisis pengguna akan memberi tahu Anda siapa audiens utama atau target Anda dan akan memandu Anda melalui penulisan teks.
   • Bicaralah dengan orang-orang yang akan menggunakan perangkat Anda. Tawarkan prototipe pengguna pengujian perangkat dan draf manual pengguna dalam kondisi terkontrol. Mintalah masukan dari pengguna uji ini tentang hal-hal yang tidak jelas atau membingungkan dalam panduan pengguna dan buat perubahan pada panduan pengguna Anda berdasarkan masukan ini.
   • Anda tidak pernah bisa memuaskan seluruh audiens Anda; tulis manual yang disesuaikan dengan target audiens atau audiens terbesar.
   • Pertimbangkan usia, kesehatan (apakah mereka memiliki penyakit, ketidakmampuan belajar atau cacat?) Dan tingkat pendidikan audiens untuk menentukan pendekatan terbaik untuk menulis buku pedoman.
2. Koordinasikan desain panduan pengguna. Jika Anda adalah bagian dari tim yang membantu merancang dan mengembangkan perangkat atau produk, mungkin sulit untuk melihat produk secara objektif untuk menjelaskan cara kerjanya. Oleh karena itu Anda harus mencari nasihat dari seorang penulis (lebih disukai seseorang dengan pengalaman menulis instruksi) dan seorang desainer grafis untuk membantu Anda mempersiapkan manual pengguna. Anda dapat memilih orang-orang ini melalui konsultasi eksternal atau dari perusahaan atau organisasi Anda sendiri.
3. Lakukan analisis tugas. Analisis pekerjaan adalah proses mengidentifikasi dan mengatur langkah-langkah yang diperlukan untuk menggunakan perangkat. Analisis pekerjaan yang menyeluruh mengidentifikasi bahan dan peralatan (seperti baterai, obat-obatan, atau produk lain yang disediakan pengguna) yang diperlukan untuk setiap langkah, serta tindakan, kesalahan, dan saran pemecahan masalah yang mungkin diperlukan oleh setiap langkah.
   • Jika Anda memiliki produk yang bisa melakukan banyak tugas atau subtugas berbeda, Anda harus melakukan analisis tugas untuk setiap tugas. Misalnya: di dalam mobil Anda dapat membunyikan klakson, mengikat diri sendiri, dan menyalakan atau mematikan lampu depan. Buatlah analisis pekerjaan untuk masing-masing ini, jika perlu.
4. Pastikan produk Anda memenuhi persyaratan pelabelan dan otorisasi pemasaran. Persyaratan ini memastikan bahwa produk dibuat dengan mengutamakan keselamatan pengguna dan bahwa paparan pengguna terhadap kondisi berbahaya, seperti radiasi dan sengatan listrik, dibatasi. Iklan harus menyatakan dengan jelas tujuan dan pedoman pengoperasian dasar suatu produk, dan Anda harus menggunakan sumber daya ini saat menulis manual pemilik Anda.
   • Agar panduan pengguna produk menjadi efektif, harus ditulis sesuai dengan label yang ditempelkan langsung ke produk.
   • Pastikan perangkat Anda memiliki lisensi resmi untuk dijual sebelum menulis panduan pengguna.
5. Tentukan tata letak manual Anda. Ada beberapa cara penting untuk menyederhanakan manual Anda. Anda harus memberi judul tebal di awal setiap bagian dengan setiap kata menggunakan huruf kapital. Misalnya, "Set up your device", "Operate your device", dan "Troubleshoot" semuanya bisa dicetak tebal.
   • Cara lain untuk menyederhanakan panduan Anda adalah dengan menggunakan dua kolom, satu di sebelah kanan dengan teks dan yang lainnya di sebelah kiri teks, dengan poin, angka, atau ikon kecil, seperti tanda peringatan atau tanda seru merah.
   • Manual ini sebagian besar terdiri dari gambar dengan beberapa teks di bawah setiap gambar untuk menjelaskan perangkat, atau mungkin sebagian besar teks dengan hanya beberapa gambar yang menyertainya. Anda juga dapat menggunakan diagram alur untuk memandu pengguna. Pikirkan tentang produk Anda dan bagaimana setiap metode dapat membantu Anda menulis manual Anda. Namun, hindari mencampur tata letak yang berbeda dalam satu manual. Pilih satu dan pertahankan.

Bagian 2 dari 4: Sematkan informasi penting

1. Atur manual secara logis. Manual harus disusun sedemikian rupa sehingga pengguna akan memperoleh manfaat maksimal darinya. Bagilah manual menjadi beberapa bab atau bagian yang masuk akal untuk menggunakan produk dan sertakan daftar isi di depan manual sehingga setiap bagian dapat ditemukan dengan cepat.
   • Daftar isi sangat diperlukan untuk manual yang lebih panjang.
   • Glosarium atau indeks diperlukan jika ada banyak istilah untuk menjelaskan yang mungkin tidak Anda kenal. Namun, glosarium tidak disarankan; pilihan terbaik adalah menjelaskan istilah-istilah yang membingungkan dalam teks manual itu sendiri. Jika Anda memilih untuk memasukkan glosarium, letakkan di depan manual, tepat setelah daftar isi.
   • Daftar tabel atau gambar hanya diperlukan jika ada lebih dari beberapa tabel atau gambar dalam manual.
   • Apendiks diperlukan untuk hal-hal yang perlu dijelaskan tetapi tidak dapat dijelaskan di tempat lain dalam manual, karena akan mengganggu aliran dan fokus.
2. Sertakan peringatan yang diperlukan. Peringatan umum atau informasi pencegahan harus memberikan informasi tentang potensi bahaya yang disebabkan oleh penggunaan produk yang tidak tepat, termasuk kematian atau cedera serius. Peringatan ini harus ditempatkan di bagian paling depan manual, setelah halaman depan, sehingga pengguna dapat melihatnya terlebih dahulu. Peringatan khusus juga harus disertakan dalam teks manual tepat setelah atau tepat sebelum langkah yang berpotensi berbahaya disarankan.
   • Misalnya, peringatan umum untuk peralatan listrik adalah jangan menggunakannya saat hujan.
   • Instruksi khusus mungkin untuk memastikan bahwa kedua tangan dan perangkat Anda kering sebelum mencolokkan perangkat ke stopkontak.
   • Berikan gambar (seperti tengkorak dan tulang bersilang) atau teks dengan warna berbeda (seperti teks merah) untuk membedakan peringatan dari petunjuk lainnya di IFU dan menarik perhatian pengguna padanya.
3. Jelaskan perangkatnya. Deskripsi Anda harus menyertakan penjelasan tertulis tentang tujuan perangkat dan representasi grafis kecil dari tampilan perangkat tersebut. Gambar tersebut harus memberi label dan nama semua sakelar, tombol, dan bagian yang dapat dipasang yang terdapat di perangkat.
4. Berikan instruksi penginstalan. Bagian penginstalan harus berisi informasi dasar tentang cara mempersiapkan penggunaan produk atau perangkat. Jika alat tidak dapat dibuat atau diatur oleh pengguna rumahan, sebutkan ini dengan jelas dalam tajuk tebal di bagian atas bagian pemasangan. Anda juga harus memasukkan yang berikut ini:
   • Daftar bagian
   • Instruksi Pembongkaran
   • Peringatan instalasi
   • Konsekuensi dari penginstalan yang salah
   • Siapa yang harus dihubungi jika terjadi kesulitan selama pemasangan
5. Berikan informasi tentang operasi tersebut. Bagian ini adalah bagian terpenting dari panduan pengguna dan harus memberikan informasi yang konkret dan mendetail tentang cara menggunakan perangkat. Mulailah dengan persiapan dasar untuk menggunakan unit, seperti mencolokkan kabel daya atau mencuci tangan Anda. Lanjutkan dengan langkah logis bernomor yang menjelaskan cara menggunakan perangkat, serta masukan apa pun (misalnya, "Anda akan mendengar bunyi klik ...") yang diharapkan pengguna saat menggunakan perangkat dengan benar.
   • Di akhir bab ini, pengguna harus dirujuk ke bab pemecahan masalah untuk menyelesaikan masalah yang tidak dapat dijelaskan dengan cepat.
   • Tempatkan gambar jika perlu. Beberapa langkah paling baik dijelaskan dengan gambar dan kata-kata. Pertimbangkan penggunaan foto atau ilustrasi dalam manual Anda.
   • Di bagian ini, seperti di bagian mana pun, Anda harus menyertakan peringatan keselamatan yang relevan tentang penggunaan atau pengoperasian yang tidak benar. Misalnya, Anda dapat memperingatkan pengguna gergaji untuk tidak minum alkohol atau menggunakan gergaji mesin saat menjalani pengobatan tertentu.
   • Jika menurut Anda pengguna akan mendapatkan keuntungan, pertimbangkan untuk menyertakan tautan ke video online yang menunjukkan penggunaan dan pengoperasian perangkat yang benar. Anda dapat merekam video ini di awal bagian ini, atau (untuk video yang menggambarkan hanya satu langkah) di akhir setiap langkah.
6. Sertakan ringkasan produk di akhir. Ringkasan akan muncul di akhir manual, tepat sebelum indeks, untuk memberikan langkah-langkah pengoperasian dasar. Ini harus merupakan versi informasi operasional yang disederhanakan dan dipreteli, dan tidak boleh lebih dari satu halaman. Rangkum bagaimana perangkat atau produk akan digunakan. Sertakan peringatan dasar, langkah bernomor yang menjelaskan cara menggunakan produk, dan nomor telepon atau alamat email yang mengarahkan pengguna untuk membantu.
   • Jika Anda mengharapkan pengguna untuk sering melepas atau merujuk pada lembar ringkasan, Anda dapat mencetaknya pada kartu laminasi yang dapat dilepas atau karton tebal agar lebih mudah bagi pengguna untuk membawa dan merujuk.
   • Atau, Anda dapat menerapkan ringkasan langsung ke produk untuk referensi cepat dan mudah oleh pengguna.

Bagian 3 dari 4: Menjelaskan perawatan produk

1. Jelaskan cara membersihkan perangkat. Jika perangkat atau produk Anda perlu dibersihkan, jelaskan cara melakukannya. Buat daftar agen pembersih yang dibutuhkan. Beri tahu pembaca seberapa sering membersihkan. Kemudian, seperti di bagian lain dari manual ini, sertakan petunjuk langkah demi langkah bernomor tentang cara membersihkannya.
   • Jika pembersihan mengharuskan produk dibongkar, atau bagian tertentu atau bagian harus dilepas, tunjukkan bagaimana produk harus dibongkar.
   • Berikan peringatan tentang hasil kegagalan membersihkan perangkat. Misalnya, Anda bisa mengatakan, "Jika perangkat tidak dibersihkan, kinerjanya akan kurang optimal".
2. Hitung pengguna bagaimana melakukan perawatan dasar. Jika produk atau perangkat dapat diservis pengguna untuk memperbaiki masalah kinerja, berikan instruksi bernomor tentang cara melakukannya untuk pengguna. Misalnya, jika baterai perlu diganti setiap 300 jam penggunaan, berikan petunjuk tentang cara memeriksa apakah baterai perlu diganti, cara melepas baterai yang sudah mati, dan cara memasang yang baru.
   • Jika ada tugas pemeliharaan tertentu yang hanya dapat dilakukan oleh teknisi bersertifikat, bagi bagian pemeliharaan manual menjadi dua bagian.
3. Diskusikan opsi penyimpanan. Jika perlu, manual harus menjelaskan cara menyimpan produk atau perangkat dengan benar. Anda juga harus memasukkan informasi tentang mengapa penyimpanan diperlukan dan konsekuensi dari penyimpanan yang tidak tepat. Misalnya: Anda bisa menulis:
   • Simpan produk di tempat yang sejuk dan kering. Penyimpanan yang tidak tepat dapat mempersingkat masa pakai produk Anda karena penumpukan kelembapan. "
   • “Hindarkan produk dari panas atau simpan pada suhu di atas 50 derajat Celcius.Jika Anda melakukannya, itu dapat menyebabkan pembakaran. "
4. Berikan informasi pemecahan masalah. Anda dapat mengatur bagian ini sebagai daftar masalah umum dan solusinya. Kelompokkan masalah serupa di bawah judul logis. Dengan cara ini, pengguna dapat dengan cepat menemukan masalah tertentu.
   • Misalnya, jika ada beberapa masalah dengan komputer yang menampilkan layar biru, kelompokkan di bawah subpos, seperti "Masalah layar umum".
   • Anda juga harus menyertakan nomor telepon dan / atau email untuk layanan pelanggan di bagian ini.

Bagian 4 dari 4: Tulis manual yang dapat dibaca

1. Baca panduan pengguna lainnya. Sebelum menulis manual untuk produk Anda sendiri, lihat panduan pengguna efektif lainnya. Perhatikan struktur, pilihan kata, dan struktur kalimat. Merek-merek besar seperti Apple, Google, dan Microsoft menghasilkan panduan pengguna yang kuat dan efektif yang dapat membantu Anda membuat panduan pengguna yang ditulis dengan lebih cermat.
   • Jangan hanya membaca semua manual pengguna. Baca manual untuk produk serupa yang Anda jual. Misalnya, jika Anda menjual produk bayi, bacalah buku manual bayi, bukan yang teknis.
2. Pilih standar Anda. Standarisasi ejaan, pilihan kata dan susunan kata akan membuat panduan pengguna lebih ramah pengguna. Chicago Manual of Style dan Microsoft Manual of Style juga dapat menjadi panduan gaya yang berguna saat menulis manual pemilik Anda; periksa keduanya untuk melihat apakah ada yang tepat untuk manual Anda.
   • Misalnya, alih-alih menggunakan "sakelar daya" dan "tombol daya" di manual Anda, pilih salah satu dari dua istilah dan patuhi.
3. Gunakan suara aktif. Suara aktif adalah cara menulis yang menjelaskan berbagai hal dari sudut pandang pengguna. Ini lebih mudah dipahami daripada alternatifnya, kalimat pasif, di mana subjeknya tidak terdefinisi.
   • Coba Aplikasi Hemingway (www.hemmingwayapp.com) untuk mengidentifikasi bagian pasif dalam tulisan Anda.
   • Pelajari dua contoh kalimat ini - yang pertama aktif dan yang kedua pasif:
     • Anda harus membuka paket dengan perlahan dan hati-hati.
     • Paket harus dibuka perlahan dan hati-hati.
4. Tulis instruksi bernomor. Instruksi yang disusun secara numerik membantu pembaca untuk lebih fokus pada proses menggunakan, menghubungkan, atau membuat produk yang dimaksud. Alih-alih menulis paragraf panjang dan bertele-tele, atau serangkaian paragraf tak bernomor, tulis panduan pengguna Anda dengan langkah-langkah sederhana dan eksplisit, masing-masing diberi nomor jelas.
5. Mulailah setiap langkah dengan perintah. Sebuah imperatif adalah kata kerja yang berorientasi pada tindakan. Dengan memulai setiap langkah dengan kata kerja, Anda memberikan petunjuk kepada pembaca tentang tindakan yang diperlukan untuk menyelesaikan langkah tersebut. Misalnya, bergantung pada produk yang Anda tulis, Anda dapat memulai langkah Anda dengan perintah seperti "Hubungkan", "Konfirmasi" atau "Geser". Namun, jangan memulai langkah Anda dengan respons dari sistem.
   • Misalnya, jika layar berubah menjadi biru dan mulai berkedip, jangan memulai langkah dengan: “Layar akan berkedip dan berubah menjadi biru.” Coba: “Tekan dan tahan tombol home. Layar akan berkedip dan menjadi biru. "
6. Tentukan kosakata yang akan Anda gunakan. Jika Anda menulis manual yo-yo, audiens Anda kebanyakan adalah anak-anak. Gunakan kata-kata dan kosa kata sederhana untuk menjelaskan cara kerja yo-yo. Saat Anda menulis panduan pemindaian mikroskop elektron, audiens Anda terdiri dari ilmuwan yang sangat terampil yang dapat memahami informasi yang sangat detail, jadi jangan ragu untuk menggunakan kosa kata khusus atau penjelasan yang bernuansa.
   • Secara umum, Anda mencoba menghindari jargon dan bahasa teknis.
   • Agar efektif untuk basis pengguna seluas mungkin, cobalah untuk menulis pada tingkat dari kelas enam sampai tujuh sekolah dasar.
7. Saat mengirim produk ke luar negeri, pastikan terjemahan Anda akurat. Sewa penerjemah untuk menerjemahkan panduan pengguna Anda ke dalam bahasa asli negara tujuan pengiriman produk Anda. Anda juga dapat menggunakan program terjemahan online, tetapi meminta penutur asli untuk membaca terjemahan dan memeriksa kesalahan.
   • Jika beberapa kelompok bahasa terwakili dalam audiens Anda, harap sertakan terjemahan dari panduan pengguna di setiap bahasa yang relevan.
   • Penerjemah harus paham dengan produk karena mungkin ada kata yang berbeda dalam bahasa target untuk istilah tertentu yang bukan terjemahan kata demi kata.
8. Tulis dalam kalimat pendek. Alih-alih beberapa paragraf panjang, Anda menggunakan banyak paragraf pendek. Cari jeda logis di setiap bagian dan cerna informasi berguna dalam potongan satu atau dua kalimat. Hal yang sama berlaku di tingkat kalimat. Buat kalimat Anda pendek dan sederhana, bukan panjang dan bertele-tele.
   • Jika sebuah langkah menjadi terlalu panjang, bagi menjadi beberapa langkah kecil. Ini tidak akan mengurangi jumlah kata, tetapi jeda baris akan membuatnya lebih mudah dibaca.
9. Periksa manual untuk kesalahan. Sebuah manual bisa kehilangan kredibilitas karena kesalahan tata bahasa dan ejaan. Minta kolega atau penulis teknis untuk mengedit dan mengoreksi manual juga. Selain ejaan dan tata bahasa, korektor harus memperhatikan hal-hal berikut:
   • Suara pasif
   • Bahasa tidak jelas atau membingungkan
   • Struktur kalimat yang dibungkus
   • Paragraf yang terlalu panjang

Tips

• Orang belajar dengan cara yang berbeda; Jika memungkinkan dan sesuai, sertakan alat bantu visual atau tautan ke video online dalam manual untuk mengakomodasi pembaca yang berorientasi visual.