Kursus Menulis Teknis Google - Bagian Dua

Ini adalah ringkasan dari Kursus Menulis Teknis Google bagian dua.

Mengedit mandiri

• Gunakan panduan gaya.
• Berpikirlah seperti audiens.
• Baca dokumen dengan suara keras (untuk diri sendiri).
• Kembali ke dokumen setelah menulis drafnya.
• Temukan editor rekan (peer) yang baik.

Mengorganisasi dokumen berukuran besar

• Buat garis besar dokumen. Alternatifnya, tulis formulir bebas lalu atur.
• Perkenalkan ruang lingkup dokumen dan prasyarat apa pun.
• Lebih baik judul berbasis tugas.
• Mengungkapkan informasi secara progresif (dalam beberapa situasi).

Membuat ilustrasi

• Pertimbangkan untuk menulis keterangan sebelum membuat ilustrasi.
• Batasi jumlah informasi dalam satu gambar.
• Fokuskan perhatian pembaca pada bagian yang relevan dari sebuah gambar atau diagram dengan menjelaskan maksudnya dalam keterangan atau dengan menambahkan isyarat visual pada gambar.

Membuat contoh kode

• Buat contoh kode ringkas yang mudah dimengerti.
• Jaga agar komentar kode tetap singkat, tetapi tetap mengutamakan kejelasan daripada singkatnya.
• Hindari menulis komentar tentang kode yang jelas.
• Fokuskan energi komentar Anda pada hal-hal yang tidak intuitif dalam kode.
• Berikan tidak hanya contoh yang benar tetapi juga contoh yang salah.
• Berikan contoh kode yang menunjukkan berbagai kompleksitas.

Revisi

• Biasakan melakukan revisi terus menerus.
• Sediakan jenis dokumentasi yang berbeda untuk berbagai kategori pengguna.
• Bandingkan dan kontraskan dengan sesuatu yang sudah familiar bagi pembaca.
• Dalam tutorial, perkuat konsep dengan contoh.
• Dalam tutorial, perhatikan masalah yang mungkin dihadapi pembaca.