Hal-hal yang saya pikirkan saat mengedit (2019)

Hal-hal yang dipikirkan saat mengedit tulisan

• Sampaikan tulisan dengan akurat

  • Sebelum menulis, Anda harus menentukan apa yang ingin disampaikan.
  • Perjelas tujuan tulisan dengan mempertimbangkan topik, pembaca sasaran, dan sebagainya, lalu catat tujuan ini di bagian atas dokumen.
  • Dalam proses menulis dan mengedit, bandingkan dengan tujuan ini untuk menjaga konsistensi.

• Ulangi dalam batas yang wajar

  • Tinjau kembali topik di awal dan akhir tulisan agar pembaca dapat memahaminya.
  • Demi kejelasan, mengulang dengan memakai nomina alih-alih verba dapat membantu.

• Sederhanakan

  • Hapus kata-kata yang tidak perlu dan buat kalimat lebih ringkas.
  • Ganti ungkapan seperti "Anda" atau "yang dapat Anda lakukan" dengan kalimat perintah yang singkat.
  • Pecah kalimat panjang menjadi lebih pendek, dan gunakan koma dengan tepat untuk membantu pemahaman pembaca.

• Hilangkan bentuk pasif

  • Bentuk pasif membuat pelaku tindakan menjadi kabur sehingga kalimat menjadi kurang jelas.
  • Jika diubah ke bentuk aktif, kalimat menjadi lebih jelas dan lebih mudah dipahami.

• Jangan gunakan adverbia

  • Alih-alih adverbia, gunakan verba yang lebih spesifik atau tambahkan penjelasan.
  • Adverbia sering kali gagal menyampaikan makna yang tepat kepada pembaca dan menyisakan ambiguitas.

• Jangan mengasumsikan pengetahuan

  • Berikan penjelasan latar belakang yang memadai untuk informasi yang mungkin tidak diketahui pembaca.
  • Saat pertama kali menggunakan singkatan, tulis bentuk lengkapnya dan tambahkan penjelasan.

• Sadari nada tulisan

  • Nada tulisan harus konsisten, dan jangan mencampur nada akrab dengan nada formal.

• Hindari jargon dan klise

  • Gunakan ungkapan yang tepat agar mudah dipahami pembaca.
  • Jargon bisa sulit dipahami jika pembaca tidak termasuk dalam kelompok tertentu.

• Manfaatkan ruang kosong

  • Pecah paragraf panjang, dan gunakan subjudul, daftar, tabel, dan sebagainya untuk meningkatkan keterbacaan.
  • Tekankan isi penting dengan huruf tebal agar pembaca tidak melewatkan poin utama.

Kesimpulan

• Prinsip dasar mengedit tulisan adalah menyampaikan makna dengan jelas dan menghapus kata-kata yang tidak perlu.
• Sambil mengikuti prinsip-prinsip ini, Anda dapat mengembangkan gaya dan preferensi Anda sendiri.
• Tujuan pengeditan adalah memikirkan penggunaan bahasa dan membuat pilihan yang tepat untuk menyampaikan pesan.

Opini GN⁺

• Menjaga tujuan dan konsistensi tulisan selama proses pengeditan adalah prinsip penting dalam semua jenis penulisan.
• Penggunaan bentuk pasif adalah gaya yang khususnya perlu dihindari dalam dokumentasi teknis, dan beralih ke bentuk aktif membantu meningkatkan kejelasan.
• Menghindari penggunaan adverbia dan memakai ungkapan yang konkret efektif bukan hanya untuk dokumentasi teknis, tetapi juga untuk semua jenis penulisan.
• Penjelasan latar belakang untuk informasi yang mungkin tidak diketahui pembaca sangat penting terutama dalam dokumentasi teknis; ini meningkatkan pemahaman pembaca dan memperbaiki aksesibilitas dokumen.
• Menggunakan ruang kosong dan pemisahan visual merupakan elemen penting untuk meningkatkan keterbacaan konten online.

[GN⁺]

Pendapat Hacker News

• Ringkasan komentar pertama:

  • Penulis mengatakan merasa terhormat karena tulisannya mendapat resonansi dari banyak orang.
  • Ia menjadi insinyur perangkat lunak karena mengikuti rasa ingin tahu, dan setelah bekerja selama beberapa tahun, ia merindukan peran yang berpusat pada menulis.
  • Ia sedang mencari peran yang menggabungkan keterampilan teknis dan kemampuan komunikasi, dan dapat dihubungi melalui situs web serta LinkedIn.

• Ringkasan komentar kedua:

  • Menggunakan singkatan dalam dokumentasi teknis tanpa memperkenalkannya terlebih dahulu terasa menyulitkan.
  • Hal ini berulang dalam dokumentasi proyek, dan ketika anggota tim berganti, bisa jadi tidak ada lagi yang tahu arti singkatan tersebut.
  • Terkadang satu-satunya solusi adalah memperlakukan singkatan itu seperti nama diri dan terus menggunakannya.

• Ringkasan komentar ketiga:

  • Sebagai peninjau dokumentasi teknis, ia telah menggunakan banyak pedoman.
  • Ia juga menyarankan untuk tidak menyebut hal yang sama dengan nama yang berbeda.
  • Jika ada banyak penulis, istilah yang berbeda dapat membingungkan pembaca.

• Ringkasan komentar keempat:

  • Ia tidak setuju dengan saran "hindari bentuk pasif".
  • Bentuk pasif adalah alat yang dapat mengubah sudut pandang terhadap suatu tindakan.
  • Dengan menggunakan bentuk pasif, kita dapat memilih apakah akan menyebutkan sumber tindakan tersebut atau tidak.

• Ringkasan komentar kelima:

  • Menentukan untuk siapa sebuah tulisan dibuat adalah hal yang sulit.
  • Perlu mempertimbangkan beragam pembaca seperti pembaca teknis, pembaca umum, dan pembaca nonteknis.
  • Ia merasa bimbang antara upaya membuat tulisan lebih mudah diakses oleh lebih banyak pembaca dan keinginan untuk mengurangi panjang tulisan.

• Ringkasan komentar keenam:

  • Ia mengungkapkan antusiasme terhadap peningkatan kemampuan menulis.
  • Ia memberi saran tentang pentingnya penggunaan daftar dan cara memakainya dengan tepat.

• Ringkasan komentar ketujuh:

  • Ia menyarankan untuk menghindari penggunaan kata "just".
  • Kata "just" menyiratkan kesederhanaan, padahal kenyataannya belum tentu demikian.

• Ringkasan komentar kedelapan:

  • Ia menekankan pentingnya ruang kosong tidak hanya dalam dokumentasi teknis, tetapi juga di blog, email, dan lainnya.
  • Paragraf yang panjang sulit dibaca dan membuat orang mudah kehilangan perhatian.

• Ringkasan komentar kesembilan:

  • Ia pernah bekerja di MSP dan menyadari pentingnya panduan produksi yang ditulis dengan baik.
  • Mengacu pada pengalaman yang diperoleh dari surat kabar, ia berusaha mencari pedoman yang dapat membantu penulisan dokumentasi.

• Ringkasan komentar kesepuluh:

  • Ia menyarankan untuk menghindari penggunaan bentuk waktu masa depan.
  • Dalam dokumentasi, lebih baik menulis "jika melakukan ini, hasilnya adalah ~" daripada "jika melakukan ini, maka akan ~".