-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add article: kursus menulis teknis bagian 2
- Loading branch information
Showing
2 changed files
with
41 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
content/blog/2024/03/kursus-menulis-teknis-google-bagian-satu.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |