Kursus Menulis Teknis Google - Bagian Satu

Ini adalah ringkasan dari Kursus Menulis Teknis Google bagian satu.

Every engineer is also a writer.

Memilih kata

• Definisikan istilah-istilah baru atau asing.
• Gunakan akronim dengan benar.
• Gunakan istilah secara konsisten.
• Hindari kata ganti yang ambigu.

Gunakan kalimat aktif

• Pilih kalimat aktif dibanding kalimat pasif.
• Kata kerja imperatif biasanya akan membuat kalimat aktif.

Menyusun kalimat yang jelas

• Pilih kata kerja yang spesifik daripada kata kerja yang tidak jelas (terlalu umum).

Buat kalimat yang singkat

• Fokuskan setiap kalimat pada satu ide.
• Ubah beberapa kalimat panjang menjadi sebuah daftar (ordered/unordered list).
• Hilangkan kata-kata yang tidak diperlukan.

Membuat daftar dan tabel

• Gunakan daftar bernomor (ordered list) bila pengurutan penting dan daftar berpoin (bulleted list) bila pengurutan tidak relevan.
• Jaga agar item dalam daftar tetap paralel (berhubungan/lingkup topik yang sama).
• Mulailah item daftar bernomor dengan kata-kata penting.
• Perkenalkan daftar dan tabel dengan tepat.

Menyusun sebuah paragraf

• Buat kalimat pembuka yang bagus yang menetapkan titik sentral paragraf.
• Fokuskan setiap paragraf pada satu topik.
• Jangan membuat paragraf terlalu panjang atau terlalu pendek.
• Usahakan sebuah paragraf menjawab pertanyaan apa, mengapa dan bagaimana.

Audiens

• Tentukan apa yang perlu dipelajari audiens Anda.
• Sesuaikan dokumentasi dengan audiens Anda.

Menyusun dokumen

• Nyatakan cakupan dokumen Anda.
• Nyatakan audiens dokumen Anda.
• Tetapkan poin-poin penting dokumen Anda di awal dokumen.
• Tulislah dokumen untuk memenuhi kebutuhan audiens Anda.