Elemen Dasar Penulisan Teknis

[ad_1]

Penulisan teknis adalah bentuk tulisan khusus.

Tujuannya adalah membantu pembaca menggunakan teknologi atau memahami proses, produk, atau konsep. Seringkali proses, produk atau konsep ini rumit, tetapi perlu diekspresikan dalam bentuk yang lebih sederhana dan ramah pembaca.

Jadi dalam genre penulisan teknis, Anda akan menemukan: laporan teknis, instalasi dan manual pemeliharaan, proposal, kertas putih, bantuan online, standar proses, instruksi dan prosedur kerja.

Sementara masing-masing disiplin memiliki persyaratan khusus, beberapa elemen dasar adalah umum. Tetapi sebelum melihat hal-hal tersebut, hal terpenting yang harus dipertimbangkan oleh seorang penulis teknis adalah audiensi.

Hadirin:

  • Seberapa akrab pembaca dengan subjek dan dengan istilah dan singkatan khusus yang perlu Anda gunakan?
  • Apa cara terbaik untuk menjelaskan istilah-istilah atau bentuk-bentuk singkat – catatan kaki, catatan akhir, daftar istilah, tabel singkatan, lampiran, tautan?
  • Apakah Anda perlu mengakomodasi pembaca sekunder (mis. Pengelola atau pemodal yang akan membuat keputusan tentang proposal), dan bagaimana Anda akan melakukannya?

Sekarang untuk elemen-elemen yang sangat penting ini:

  1. Kejelasan – Aliran logis dari dokumen akan membantu pembaca memahami konten. Akan sangat berguna untuk bertanya kepada seseorang yang tidak akrab dengan topik untuk meninjau tulisan Anda sebelum Anda menyelesaikannya. Menggunakan judul, ilustrasi, grafik, atau tabel dapat berguna – tujuan Anda adalah untuk membuatnya semudah mungkin bagi pembaca Anda untuk memahami apa yang telah Anda tulis. Pertimbangkan bagaimana cara teks berada di halaman atau layar – petunjuk lain untuk memaksimalkan kejelasan bagi pembaca Anda.
  2. Ketepatan – Informasi dan interpretasi data yang Anda berikan harus akurat. Jika tidak, pembaca Anda akan mempertanyakan kredibilitas konten. Hati-hati untuk membedakan secara jelas antara fakta dan opini, dan secara akurat mengutip referensi ke karya lain.
  3. Keringkasan – Berusaha mencari keseimbangan antara jumlah informasi yang disajikan dan waktu yang diperlukan untuk membaca dokumen. Ingat bahwa Anda dapat menggunakan apendiks atau tautan untuk memberikan informasi tambahan atau informasi latar belakang. Pertimbangkan untuk menggunakan ilustrasi, tabel atau grafik daripada kata-kata untuk menjelaskan suatu konsep – tetapi ingat, jika Anda menggunakan 'visual', jangan berikan penjelasan panjang tertulis.
  4. Panjang kalimat – Umumnya, konsep yang kompleks atau tidak dikenal paling baik disajikan dalam kalimat yang lebih pendek. Ini akan memberi pembaca waktu untuk mencerna informasi-informasi kecil sebelum berpindah ke yang berikutnya. Meskipun ini sulit untuk dicapai, cobalah untuk menargetkan sekitar 25 kata per kalimat. Jika Anda menemukan Anda telah menulis serangkaian kalimat panjang, carilah kata 'dan', 'tetapi', 'bagaimanapun' dan kata-kata serupa di mana Anda dapat melanggar kalimat.
  5. Paragraf – Aturan lama tentang satu topik per paragraf adalah panduan yang berguna. Itu tidak berarti bahwa Anda hanya dapat memiliki satu paragraf untuk setiap topik, tetapi itu berarti bahwa hanya memiliki satu topik dalam setiap paragraf yang membuat penulisan yang jelas dan logis.
  6. Pustaka-sentrisitas – Anda menulis untuk pembaca Anda. Jadikan semudah mungkin bagi mereka untuk memahami pekerjaan Anda.

Simpan elemen-elemen dasar ini dan prinsip-prinsip lain dalam pikiran saat Anda melakukan tugas-tugas penulisan teknis Anda.

[ad_2]

Leave a Reply

Your email address will not be published. Required fields are marked *