Penulisan teknis mengkomunikasikan informasi teknis tentang keterampilan atau produk kepada pembaca. Ini biasanya digunakan di bidang teknis dan pekerjaan. Sebagai penulis teknis, Anda sering menulis dokumen seperti panduan pengguna, dokumentasi antarmuka pemrograman aplikasi (API), dan manual perbaikan dan produk.
Seperti ceruk tulisan lainnya, penulisan teknis memiliki pedoman khusus ceruk. Mengikuti pedoman ini akan membantu Anda menulis dokumen yang terstruktur dengan baik dan mengoptimalkan cara pembaca memahami pekerjaan Anda. Berikut adalah beberapa aturan yang harus diikuti untuk menjadi penulis teknis yang baik.
1. Tentukan Audiens Anda
Analisis audiens adalah faktor yang sangat diperlukan dalam dokumen teknis yang baik. Mengetahui audiens Anda membantu Anda menentukan jenis informasi untuk ditulis, bagaimana Anda harus menyusunnya, dan teknis bahasa Anda. Ada empat khalayak utama untuk penulisan teknis: eksekutif, pakar, teknisi, dan non-spesialis.
Eksekutif adalah individu yang mendanai produk dan membuat keputusan politik, administratif, dan ekonomi yang mengaturnya. Teknisi adalah orang yang membangun, mengoperasikan, dan memperbaiki produk ini. Pakar merancang, menguji, dan mengetahui segalanya tentang produk, sedangkan non-spesialis adalah pengguna akhir produk. Anda harus mempertimbangkan audiens Anda untuk menentukan nada dan gaya penulisan terbaik untuk digunakan.
2. Identifikasi Kebutuhan Audiens Anda
Selain mengetahui dan menentukan audiens Anda, penting bagi Anda untuk memahami tujuan, minat, dan kebutuhan mereka. Menyelesaikan analisis audiens Anda adalah kunci dalam persiapan dokumen, karena Anda cenderung menulis tanpa cegukan dan mengetahui kebutuhan audiens Anda dengan baik.
Untuk melakukan analisis audiens yang menyeluruh, Anda harus mempertimbangkan latar belakang audiens Anda, pengetahuan yang ada produk, pengalaman, kebutuhan, minat, karakteristik demografis, preferensi budaya dan komunikasi, dan sasaran. Informasi ini akan membantu Anda dalam mempresentasikan ide-ide Anda secara paling efektif dan efisien.
3. Ketahui Batas Pengetahuan Audiens Anda
Sebagai teknik analisis audiens, Anda dapat memanfaatkan survei dan kuesioner untuk mengetahui batas pengetahuan audiens Anda. Anda juga dapat mencari pendapat dan stereotip populer, pengalaman pribadi, curah pendapat, dan umpan balik audiens, dari departemen pemasaran.
Jika Anda menggunakan alat yang tercantum di atas dengan benar, Anda akan tahu seberapa banyak audiens target Anda memahami informasi yang ingin Anda sampaikan. Informasi ini akan sangat menentukan struktur, batasan, dan ruang lingkup dokumen Anda, memberi Anda arah.
4. Jaga Bahasa Anda Sederhana
Penulisan teknis seharusnya menyajikan subjek yang terlalu rumit. Ini dilakukan dengan menggunakan panduan gaya penulisan langsung. Anda harus memastikan bahwa rata-rata pembaca dapat dengan mudah memahami tulisan Anda.
Namun, Anda harus mencatat bahwa memahami audiens Anda juga merupakan kunci gaya bahasa yang Anda pilih. Misalnya, jargon profesional dalam dokumen tentang antarmuka pemrograman aplikasi (API) mungkin sesuai untuk teknisi tetapi tidak untuk pengguna akhir. Konsekuensinya, Anda harus menggunakan bahasa yang mudah dipahami untuk membantu pemahaman audiens. Anda mungkin juga ingin belajar cara menggunakan alat seperti Microsoft Editor untuk memeriksa pekerjaan Anda dan memastikan bahwa tulisan itu tepat sasaran.
5. Gunakan Outline
Garis besar memberi pembaca Anda gambaran tentang apa yang diharapkan dalam dokumen. Sebuah dokumen tanpa garis besar membuat pembaca kewalahan, karena memaksa mereka untuk membaca keseluruhan teks ketika mereka hanya tertarik untuk memperoleh pengetahuan tertentu.
Sebagai penulis teknis, menguraikan dokumen Anda juga memberi Anda arah saat menulis. Itu membuat Anda tetap pada jalur dan memastikan bahwa Anda tidak melewatkan atau kurang menghargai poin yang relevan. Selain itu, ini menyempurnakan struktur dokumen Anda dan berfungsi sebagai umpan balik tentang apa yang ingin Anda liput.
6. Gunakan Grafik Jika Diperlukan
Sebagian besar perhatian pembaca secara alami tertarik pada grafik dibandingkan dengan teks. Dalam dokumen teknis, grafik yang sesuai dapat meningkatkan pemahaman pembaca terhadap teks dengan menyajikan informasi secara jelas dan tegas.
Namun, sebagai penulis teknis, Anda harus berhati-hati untuk tidak menggunakan grafik untuk menghiasi dokumen. Tabel, grafik, bagan, foto, dan ilustrasi adalah grafik yang umum digunakan, dan dapat meningkatkan keseluruhan struktur dokumen dan menarik bagi pembaca. Yang mengatakan, jika Anda baru di Google Docs, inilah cara membuat dan mengedit tabel di Google Docs.
7. Libatkan Pembaca Anda
Meskipun Anda mungkin mencoba menyampaikan informasi teknis kepada pembaca Anda, penting bagi Anda untuk melibatkan mereka juga. Setiap dokumen teknis berpusat pada pembaca dan harus ditulis sesuai selera pembaca dan bukan penulis. Keingintahuan intelektual pembaca Anda harus dipenuhi agar dokumen Anda bermanfaat.
Anda dapat secara aktif melibatkan pembaca Anda dengan menulis untuk mengungkapkan, bukan mengesankan, dan langsung ke intinya. Hindari singkatan dan jargon, gunakan banyak ruang putih untuk menyempurnakan presentasi visual, dan gunakan tajuk utama untuk memandu pembaca Anda.
8. Jangan Merujuk Informasi yang Sensitif Terhadap Waktu
Menghindari referensi ke informasi sensitif waktu, terutama periode yang sebanding, selalu lebih baik. Lebih aman dan bijaksana untuk menggunakan analisis yang telah bertahan dalam ujian waktu, yang menjadikannya selalu hijau dan cocok bagi mereka yang akan membaca dokumen Anda di masa mendatang.
Anda juga harus mencatat bahwa melampirkan tahun tertentu, seperti "2019", untuk menekankan poin Anda dapat mengurangi kegunaan dokumen Anda dari waktu ke waktu, kecuali dalam kasus tertentu. Anda dapat mencegah hal ini dengan menggunakan kerangka waktu yang lebih luas seperti, "Dalam tujuh tahun terakhir", sehingga memberikan tingkat kredibilitas pada pekerjaan Anda.
9. Gunakan Contoh yang Relevan
Saat menulis dokumen teknis, gunakan contoh langsung untuk menekankan poin Anda. Karena audiens Anda membaca tulisan Anda untuk memperoleh keterampilan, memecahkan masalah, atau mempelajari beberapa pedoman, Anda harus memberi mereka contoh yang praktis dan dapat diterima.
Contoh-contoh ini meningkatkan keterbacaan karya Anda dan mengomunikasikan informasi kompleks kepada pembaca Anda, memberikan konteks pada produk dan proses. Dengan cara ini, mereka cenderung menggunakan produk dengan sengaja dan aman.
10. Dapatkan Tinjauan Pihak Ketiga Sebelum Menerbitkan
Sebuah dokumen teknis harus selalu melewati proses kolaboratif yang melibatkan penulis dan reviewer. Tinjauan pihak ketiga membantu menghasilkan dokumen yang berfokus pada audiens, bebas kesalahan, dan berdampak.
Sebagai penulis asli dokumen, Anda mungkin telah menulis banyak draf sebelum membuat dokumen final. Namun demikian, tidak peduli seberapa bagus tampilan dokumen Anda, jangan bergantung pada kecerdasan Anda saja.
Menjadi Penulis Teknis Profesional Hari Ini
Memahami aturan penting yang memandu penulisan teknis akan membuat Anda lebih mahir dan sangat dicari. Banyak organisasi tahu betapa pentingnya produk atau layanan mereka dipasarkan dengan baik kepada pengguna akhir, dan membantu mereka mencapai ini adalah tujuan Anda sebagai penulis teknis.