Basic Elements of Technical Writing

Penulisan teknis adalah bentuk tulisan khusus.

Tujuannya adalah membantu pembaca menggunakan teknologi atau memahami proses, produk, atau konsep. Proses, produk, atau konsep ini seringkali rumit, tetapi harus diungkapkan dalam bentuk yang lebih sederhana dan mudah digunakan.

Karena itu Anda akan menemukan dalam genre teknis: laporan teknis, instalasi dan manual pemeliharaan, proposal, kertas putih, bantuan online, standar pemrosesan, instruksi dan prosedur kerja.

Meskipun masing-masing disiplin memiliki persyaratan khusus, beberapa elemen dasar adalah umum. Tetapi sebelum melihat ini, hal yang paling penting yang perlu diperhatikan oleh seorang penulis teknis adalah audiens.

Audiens:

  • Sejauh mana pembaca akrab dengan subjek dan istilah dan singkatan khusus yang harus Anda gunakan?
  • Apa cara terbaik untuk menjelaskan istilah-istilah ini atau bentuk yang disingkat – catatan kaki, catatan akhir, daftar istilah, tabel singkatan, lampiran, tautan?
  • Apakah Anda perlu mengakomodasi pembaca sekunder (misalnya, manajer atau ahli keuangan yang akan membuat keputusan tentang proposal), dan bagaimana Anda akan melanjutkan?

Beralih sekarang ke elemen-elemen penting ini:

  1. Kejelasan – Aliran logis dari dokumen akan membantu pembaca untuk memahami konten. Mungkin ada gunanya meminta seseorang yang tidak akrab dengan subjek untuk membaca kembali tulisan Anda sebelum menyelesaikannya. Penggunaan judul, ilustrasi, bagan atau tabel dapat terbukti bermanfaat. Tujuan Anda adalah membuat pembaca Anda memahami semudah mungkin apa yang telah Anda tulis. Pikirkan tentang bagaimana teks ditempatkan pada halaman atau di layar – petunjuk lain untuk mengoptimalkan kejelasan pembaca Anda.
  2. Akurasi – Informasi dan interpretasi data yang Anda berikan harus akurat. Jika ini tidak terjadi, pembaca Anda akan meragukan kredibilitas konten. Pastikan untuk membedakan antara fakta dan opini dan mengutip referensi ke karya lain secara akurat.
  3. Brévité – Berusahalah mencari keseimbangan antara jumlah informasi yang disajikan dan waktu yang diperlukan untuk membaca dokumen. Jangan lupa bahwa Anda dapat menggunakan apendiks atau tautan untuk memberikan informasi tambahan atau tambahan. Pikirkan menggunakan ilustrasi, bagan atau grafik daripada kata-kata untuk menjelaskan konsep – tetapi ingat, jika Anda menggunakan "visual", jangan berikan penjelasan tertulis panjang.
  4. Panjang Kalimat – Umumnya terbaik untuk menyajikan konsep yang kompleks atau tidak dikenal dalam kalimat yang lebih pendek. Ini akan memberi pembaca waktu untuk mencerna sedikit informasi sebelum berpindah ke yang berikutnya. Meskipun ini mungkin sulit dicapai, cobalah membidik sekitar 25 kata per kalimat. Jika Anda menemukan bahwa Anda telah menulis serangkaian kalimat panjang, carilah "dan", tetapi "#," tetapi #; dan kata-kata serupa di mana Anda dapat melanggar kalimat.
  5. Paragraf – Aturan sekuler dari satu subjek per paragraf adalah panduan yang berguna. Ini tidak berarti bahwa Anda hanya dapat memiliki satu paragraf untuk setiap subjek, tetapi hanya memiliki satu subjek di setiap paragraf memungkinkan penulisan yang jelas dan logis.
  6. Pembaca-Berpusat – Anda menulis untuk pembaca Anda. Jadikan semudah mungkin bagi mereka untuk memahami pekerjaan Anda.

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



Source by Desolie Page

Leave a Reply

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