Cara Menulis Artikel Yang Benar

Dokumentasi pengguna terlalu sering ditulis oleh programmer untuk programmer. Itu cenderung berfokus pada fitur-fitur produk, daripada tugas-tugas pengguna. Umumnya, programmer tidak dalam posisi ideal untuk menulis dokumentasi pengguna. Mereka terlalu dekat dengan bit dan byte, dan mereka terlalu jauh dari pengguna. Bagi mereka, apa yang dapat dilakukan produk cenderung jauh lebih penting daripada apa yang dapat dilakukan pengguna dengan produk tersebut. kunjungi juga blog kami di harewosgarut.com yang menyajikan informasi terupdate seputar Pendidikan dan juga Teknologi.

Cara Menulis Artikel Yang Benar

Ini perbedaan yang halus – tapi vital -. Penelitian menunjukkan bahwa kunci dokumentasi pengguna yang efektif adalah menulis bantuan berorientasi tugas. Bahkan lebih baik, tulislah bantuan Anda sesuai dengan teori minimalis. Dalam dunia dokumentasi, “minimalis” adalah kata yang bagus untuk praktik akal sehat. Dalam istilah dasar, ini berarti menulis kepada pembaca Anda dan membuatnya sederhana.

Teorinya sendiri memiliki banyak tikungan dan putaran. Jika Anda ingin membaca buku yang bagus – tetapi sedikit bertele-tele tentang masalah ini, lihat buku “Minimalism Beyond the Nurnberg Funnel”, 1998, diedit oleh John Carroll.

Sementara itu, jika Anda dapat mencentang setiap item dalam daftar periksa berikut, Anda akan segera menuju bantuan daring yang dapat digunakan yang akan berterima kasih kepada pembaca dan manajer Anda.

Daftar Periksa Bantuan yang Bermanfaat

1. Basis bantuan pada tugas nyata (atau contoh realistis)

2. Struktur bantuan berdasarkan urutan tugas – Judul bab harus menjadi tujuan dan topik harus menjadi tugas

3. Hormati aktivitas pembaca – ini umumnya lebih tentang apa yang tidak Anda lakukan daripada apa yang Anda lakukan. Jangan buang waktu pembaca dengan menyelam ke singgung

4. Manfaatkan pengetahuan dan pengalaman sebelumnya – Tarik perhatian pembaca ke tugas, pengalaman, keberhasilan, dan kegagalan sebelumnya

5. Mencegah kesalahan – “Pastikan Anda melakukan x sebelum melakukan y”

6. Deteksi dan identifikasi kesalahan – “Jika ini gagal, Anda mungkin salah memasukkan jalur”

7. Perbaiki kesalahan – “Masukkan ulang jalan”

8. Berikan info kesalahan di akhir tugas jika perlu (aturan praktis, satu catatan info kesalahan per tiga tugas adalah rata-rata yang baik)

9. Jangan putus instruksi dengan catatan, hati-hati, peringatan, dan kasus luar biasa – Letakkan hal-hal ini di akhir instruksi, sedapat mungkin

10. Bersikap singkat, jangan menguraikan semuanya, terutama hal-hal yang bisa diterima begitu saja

11. Hapus informasi konseptual dan catat jika memungkinkan, atau tautkan ke sana. Mungkin memberikan informasi ekspansi di akhir topik, ditambah mungkin catatan bahwa ada cara lain untuk melakukan tugas / tujuan, tetapi ini adalah yang termudah

12. Bagian harus terlihat pendek dan dibaca pendek

13. Berikan penutupan untuk bagian (mis., Kembali ke layar / gol asli)

14. Berikan peluang segera untuk bertindak dan mendorong eksplorasi dan inovasi (gunakan undangan aktif untuk bertindak, seperti, “Lihat sendiri …” atau “Coba ini …” daripada undangan pasif seperti, “Anda bisa. .. “)

15. Dapatkan pengguna mulai dengan cepat

16. Memungkinkan untuk membaca dalam urutan apa pun – buat setiap bagian modular, terutama tujuan, tetapi mungkin tugas (pasti jika mereka dapat dilakukan dalam urutan yang berbeda)

17. Sorot hal-hal yang tidak tipikal

18. Gunakan suara aktif daripada suara pasif

19. Cobalah untuk memperhitungkan lingkungan pengguna dalam tulisan Anda

20. Sebelum menulis apa pun, tanyakan pada diri sendiri, “Apakah ini akan membantu pembaca saya?”

Dengan membangun praktik-praktik ini ke dalam proses dokumentasi Anda, Anda akan menemukan bahwa bantuan online Anda menjadi lebih mudah untuk ditulis, lebih pendek, dan jauh lebih bermanfaat bagi pembaca Anda. Terlebih lagi, bos Anda akan mencintai Anda!

 

Leave a Comment

Your email address will not be published.