Skip to content

Commit

Permalink
Merge pull request #72 from mmdmthr/64-good-tech-doc
Browse files Browse the repository at this point in the history
add article: kursus menulis teknis bagian 2
  • Loading branch information
mmdmthr committed Mar 2, 2024
2 parents ecc3446 + a6a41f0 commit 773c140
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
40 changes: 40 additions & 0 deletions content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 773c140

Please sign in to comment.