Seni Menyunting - Cara Menulis Dokumen Teknis bagi Developer

• Penyuntingan: saat menulis, meninjau berulang kali lalu memperbaiki dan merapikannya. Atau proses tersebut

• Alasan mengapa penyuntingan diperlukan

• Tips penyuntingan

→ Membuat tulisan sendiri terasa asing: membacanya dengan suara keras, membacanya lagi setelah beberapa waktu, mencetaknya di kertas lalu membacanya

→ Peer review

→ Memanfaatkan checklist

→ Tips merevisi kalimat untuk meningkatkan keterbacaan

① Merapikan dan merevisi menjadi kalimat-kalimat pendek

② Menghapus ungkapan yang tidak perlu

③ Mengubahnya menjadi tulisan yang logis

[budlebee]

Ini mengingatkan saya pada prinsip menulis Stephen King. Karena ini novel, tentu ada perbedaan dengan technical writing, tetapi kalau saya tulis yang teringat:

• Gunakan kalimat yang pendek dan sederhana.

• Saya menulis draf pertama, lalu menyimpannya di laci, dan enam bulan kemudian mengeluarkannya lagi untuk dibaca ulang.

• Versi revisi memangkas 10% dari draf pertama.

• Membacakan tulisan dengan lantang bisa membantu menemukan bagian kalimat yang terasa janggal.

• Tentukan dengan spesifik siapa pembaca tulisan itu sebelum menulis. Dalam kasus saya, itu adalah istri saya.

[xguru]

Akhir-akhir ini tim technical writing Kakao Enterprise sering menulis banyak artikel bagus. Saya merekomendasikan untuk berlangganan blognya!