From a6a41f0ea6f479fa2eff6239dab2e2fb44ae8109 Mon Sep 17 00:00:00 2001 From: mmdmthr Date: Sat, 2 Mar 2024 09:59:37 +0700 Subject: [PATCH] add article: kursus menulis teknis bagian 2 --- ...ursus-menulis-teknis-google-bagian-satu.md | 2 +- ...ursus-menulis-teknis-google-bagian-satu.md | 40 +++++++++++++++++++ 2 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md diff --git a/content/blog/2024/02/kursus-menulis-teknis-google-bagian-satu.md b/content/blog/2024/02/kursus-menulis-teknis-google-bagian-satu.md index 03ecd427..8c2bb79c 100644 --- a/content/blog/2024/02/kursus-menulis-teknis-google-bagian-satu.md +++ b/content/blog/2024/02/kursus-menulis-teknis-google-bagian-satu.md @@ -4,7 +4,7 @@ date: 2024-02-25 category: 'notes' --- -Ini adalah ringkasan dari [Kursus Menulis Teknis Google](https://developers.google.com/tech-writing) bagian satu. +Ini adalah ringkasan dari [Kursus Menulis Teknis Google](https://developers.google.com/tech-writing/one) bagian satu. > Every engineer is also a writer. diff --git a/content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md b/content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md new file mode 100644 index 00000000..0915e7a0 --- /dev/null +++ b/content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md @@ -0,0 +1,40 @@ +--- +title: 'Kursus Menulis Teknis Google - Bagian Dua' +date: 2024-03-02 +category: 'notes' +--- + +Ini adalah ringkasan dari [Kursus Menulis Teknis Google](https://developers.google.com/tech-writing/two) 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. \ No newline at end of file