Ini klise, tapi benar-gambarnya melukis seribu kata. Ini adalah pesan penting untuk diingat saat menulis dokumentasi pengguna apa pun, seperti panduan pemasangan atau petunjuk manual. Sebuah dokumen yang membuat penggunaan gambar dan diagram yang bijaksana akan jauh lebih mudah dipahami daripada teks yang seluruhnya terdiri dari deskripsi teks.
Saya mengamati ini tangan pertama tahun yang lalu, ketika seorang programmer junior di satu perusahaan diminta untuk memperbarui manual instalasi perangkat lunak untuk mesin kontroler mereka. Salah satu hal pertama yang dia lakukan adalah membuang semua gambar tangkapan layar, sehingga mengurangi keseluruhan dokumen menjadi teks biasa. "Gambar-gambar ini hanya konyol!" Katanya. "Mereka mengambil tempat, dan mereka tidak perlu. Saya percaya bahwa siapa pun yang membaca dokumen ini akan cukup pintar untuk mengetahuinya."
Ini ternyata menjadi kesalahan besar. Para teknisi yang harus menggunakan manual itu memiliki waktu yang sulit untuk memahami instruksinya. Mereka harus berulang kali meminta klarifikasi, dan salah satu dari mereka mengatakan kepada saya bahwa deskripsi teks murni terlalu rumit untuk diikuti. Mereka takut menggunakan petunjuk ini sama sekali, mengetahui bahwa salah langkah salah dapat mengunci pengendali ke keadaan yang tidak dapat dipulihkan. Situasi itu sangat buruk.
Masalahnya adalah programmer ini tidak berusaha mempermudah pengguna. Untuk satu hal, dia gagal untuk mempertimbangkan bahwa beberapa teknisi bukan penutur asli bahasa Inggris, dan bahwa mereka mungkin berjuang dengan kata-kata itu. Yang lebih penting lagi, programmer ini berharap terlalu banyak dari pendengarnya. Dia ingin mengurangi petunjuk ini pada kebutuhan pokok mereka, berpikir itu akan memadai. Dia gagal untuk mempertimbangkan bahwa bahkan pembaca yang cerdas dan hati-hati mungkin tergoda untuk melompati instruksi, atau akan mengabaikan beberapa detail penting. Ini adalah perangkap umum saat waktunya singkat, dan saat pengguna dihadapkan dengan halaman dan halaman teks hambar.
Beberapa gambar yang dipilih dengan cermat, dengan teks yang sesuai, bisa menempuh perjalanan jauh untuk mencegahnya. Ketika saya melihat bahwa programmer junior membuang semua gambar tangkapan layar, saya memperingatkannya untuk tidak melakukannya. "Gambar-gambar ini mungkin tidak benar-benar diperlukan," kataku, "tapi mereka membantu menjelaskan banyak rincian. Untuk satu hal, mereka menunjukkan kepada pengguna tombol mana yang tepat untuk ditekan, atau jendela mana yang akan dipilih. Hal ini membuat instruksi lebih mudah dipahami, dan mengurangi kemungkinan kesalahan manusia. "Sampai hari ini, saya berharap dia telah memperhatikan peringatan saya.
Apakah pengguna cukup cerdas untuk memahami manualnya, seperti yang diklaimnya? Tentu saja - tapi kecerdasan bukanlah jaminan dari kesalahan manusia. Mungkinkah gambar telah ditafsirkan sebagai pembicaraan ke pengguna? Mungkin-tapi menurut pengalaman saya, pengguna yang canggih jarang meresponsnya. Sebaliknya, sebagian besar dari mereka tampaknya memahami nilai yang dibawa oleh gambar-gambar ini ke meja. Mungkin itu karena kebanyakan dari mereka tahu bagaimana rasanya diliputi dan ditekan untuk waktu, dan betapa mudahnya rincian penting dapat hilang dalam teks.
Jadi ingatlah-sebuah gambar melukis seribu kata, dan satu tangkapan layar bisa bernilai lebih dari selusin halaman teks. Ini adalah pelajaran yang patut dipelajari.
0 Response to "Nilai Menambahkan Gambar ke Dokumentasi Teknis"
Posting Komentar