Menulis Teknis Hebat: Buang Dua Sikap Ini

Ikhtisar

Artikel ini dipersembahkan oleh PutraRental.com
Dokumen Pengguna yang Tidak Lengkap mengecewakan Pembaca Anda. Dua sikap dari banyak Penulis Teknis menghasilkan Dokumen Pengguna yang tidak lengkap. Kedua sikap ini adalah:

. "Semua orang tahu itu", dan

. "Pengguna dapat menggambarkannya"

Artikel ini menjelaskan tentang sikap dan menyajikan metode untuk mengatasinya. Hasilnya adalah User Documents yang lebih efektif dan Pengguna yang lebih puas.

1. "Semua orang tahu itu"

Sikap "Semua Orang Tahu Itu" membuat asumsi tentang pengetahuan Pembaca Anda. Asumsi ini menyebabkan kesedihan Reader Anda.

Inilah contoh kemungkinan "Everyone Knows That." Apakah kamu tahu ini:

Tomat. Sebagian besar dari kita menyimpannya di kulkas. Namun, menyimpannya di kulkas akan merusak rasa dan gizi tomat. Tomat harus disimpan di meja dapur pada suhu kamar, sampai dipotong. Setelah dipotong, tomat kemudian harus disimpan di kulkas.

Apakah semua orang tahu itu? Apa yang Anda kira bahwa semua orang tahu tentang produk Anda?

Terkadang Dokumen Pengguna Anda harus mengatasi pengalaman Pengguna sebelumnya. Semua orang berpikir bahwa mereka tahu bagaimana cara yang benar (aman) mematikan barbekyu ... tidak! Metode shutdown aman dijelaskan di kebanyakan Dokumen Pengguna barbekyu, namun tidak "diiklankan" (secara kuat disajikan) dalam Dokumen Pengguna.

Memang jarang benar bahwa "Everyone Knows That". Hanya karena Anda menemukan sesuatu yang jelas, bukan berarti semua orang tahu sesuatu.

Inilah contoh lain: Bagaimana Anda menggunakan sampo dan kondisioner (produk gabungan - '2 dalam satu') dan kondisioner rambut? Saat keramas, shampo dipijat ke kulit kepala dan segera dibilas. Saat mengkondisikan rambut, kondisioner dipijat ke rambut, dan tetap di atas rambut selama sekitar dua menit. Sekarang, apa yang Pengguna lakukan untuk produk gabungan: bilas dengan cepat, atau biarkan produk tetap berada di rambut?

Jika Anda memiliki sikap "Everyone Knows That" saat menulis, Anda akan cenderung meninggalkan materi yang dibutuhkan dari Dokumen Pengguna Anda. Anda akan melakukan pembalasan terhadap Pembaca Anda, dan tulisan Anda.

Bila ragu apakah "semua orang tahu sesuatu," asumsikan tidak. Kemudian,

. tambahkan beberapa teks yang menjelaskan topik, atau

. beritahu Reader dimana mencari informasi yang akan menjelaskan topiknya

Perhatian lain

Hati-hati dengan mengasumsikan bahwa hanya karena Anda telah menjelaskan sesuatu di Dokumen Pengguna Anda sebelumnya, Reader Anda akan mengingat (atau bahkan telah membaca) informasi itu. Sangat jarang bagi Pengguna untuk membaca dokumentasi produk dari awal sampai akhir.

Bila ragu, tambahkan referensi ke informasi sebelumnya (latar belakang). Beritahu Pembaca Anda di mana menemukannya, atau berikan tautan ke situ jika dokumen Anda elektronik.

Inilah Percobaan Pemikiran: Anda adalah pengguna produk: Seberapa sering Anda membaca dokumentasi produk dari awal sampai akhir? Jika Anda selalu melakukannya, maka mintalah beberapa orang lain. (Hal yang hebat tentang fakta ini - bahwa Pengguna tidak membaca dokumentasi dari awal sampai akhir - adalah menghasilkan fleksibilitas dalam menulis, memformat dan mengedit dokumentasi produk.)

2. "Pengguna dapat menggambarkannya"

Pengguna tidak ingin memikirkan semuanya. Pengguna tidak membaca novel misteri atau literatur lainnya, di mana dia ingin memikirkan apa yang sedang terjadi.

Bila seseorang menggunakan produk Anda, mereka menggunakannya untuk memenuhi kebutuhan mereka sendiri. Produk Anda mungkin penting bagi kehidupan Anda, namun bagi Pengguna Anda, produk Anda adalah sarana untuk mencapai tujuan. Dan mereka tidak ingin menguraikan dokumentasi produk Anda.

Inilah contoh sederhana. Sebuah e-mail memberitahu Anda untuk menelepon seseorang, namun pesan tersebut meninggalkan nomor teleponnya. Anda diharapkan menemukan nomor telepon Anda sendiri. Penulis mungkin tahu nomor teleponnya, tapi membiarkannya keluar. "Pengawasan informasi" ini menjadi mahal di dalam perusahaan saat e-mail dikirim ke banyak karyawan ... masing-masing mencari nomor teleponnya sendiri.

Hewan kesayangan saya mengasyikkan: kencan. Dalam ingatan terakhir kita "bertahan" transisi Tahun-2000. Namun kita masih menulis tanggal dengan kata sembarangan. Kami menggunakan "06" selama setahun, bukan "2006." Ketika kita melihat hal-hal seperti "07/11/04" berapakah tanggal yang dimaksud? Apakah tanggal 4 November 2007, 11 April 2007, atau beberapa permutasi lainnya dari angka tersebut. Standar untuk format tanggal bervariasi di seluruh dunia. Ini adalah contoh dari kedua asumsi tersebut:

. "semua orang tahu itu" (karena ada format tanggal "standar" - tidak ada), dan

. "Pengguna bisa mengetahuinya" (dengan melihat apakah tanggal saya yang lain memberi petunjuk pada formatnya)

Jangan tinggalkan hal-hal untuk User / Reader untuk mencari tahu sendiri. Anda hanya perlu beberapa saat untuk memasukkan materi yang dibutuhkan Reader Anda, dan akan menghemat banyak Pembaca banyak jam untuk memikirkan semuanya.

Lakukan:

Literatur penulisan memberitahu Anda untuk "mengenal Pembaca Anda." Di sinilah Anda menggunakan pengetahuan itu untuk memperbaiki tulisan Anda.

Salah Satu

. cari seseorang yang seperti Reader yang anda maksudkan, atau

. "lakukan yang terbaik" untuk bertindak seperti Reader yang Anda maksudkan (Anda dapat melakukannya jika Anda perlu)

Dalam membaca dan mengevaluasi dokumen, carilah tempat di mana

. tulisannya mengasumsikan bahwa "semua orang tahu itu"

. tulisannya mengharapkan Reader bisa "mengetahuinya"

. tulisan membuat lompatan yang tidak dapat diikuti oleh Pembaca Anda

. Tulisan tersebut membuat asumsi bahwa Pembaca telah membaca dan mengingat seluruh dokumen

Perbaiki tempat ini. Hanya dibutuhkan beberapa kata atau kalimat.

Semua orang akan lebih bahagia.

Posted by Unknown

Tweet