Membaca Dokumentasi Teknis Bahasa Inggris
Tantangan Membaca Dokumentasi Bahasa Inggris
Section titled “Tantangan Membaca Dokumentasi Bahasa Inggris”Masalah umum developer non-penutur asli saat membaca dokumentasi teknis bahasa Inggris:
- Seluruh paragraf tidak dipahami, perlu menerjemahkan kalimat per kalimat
- Menemukan ekspresi asing dan harus mencari kata, mengganggu alur kerja
- Setelah selesai membaca sudah lupa, atau ingat ekspresi tapi tidak bisa menggunakannya
- Contoh kalimat dalam dokumentasi ditulis dengan baik tapi tidak bisa dipelajari (tidak ada tempat menyimpan)
Tiga Alur Kerja
Section titled “Tiga Alur Kerja”Alur Kerja 1: Pencarian Kata Cepat (Tanpa Mengganggu Pekerjaan)
Section titled “Alur Kerja 1: Pencarian Kata Cepat (Tanpa Mengganggu Pekerjaan)”Anda menemukan frasa asing saat membaca dokumentasi, perlu memahami dengan cepat tanpa mau terputus.
Langkah:
- Pilih kata tersebut
- Tekan ⌘⇧D (pintasan global)
- Jendela mengambang DevGlish muncul, menampilkan definisi dan pengucapan
- Baca sekilas, tutup (Esc)
- Lanjutkan membaca dokumentasi
Alur Kerja 2: Mode Paragraf (Pemahaman Mendalam)
Section titled “Alur Kerja 2: Mode Paragraf (Pemahaman Mendalam)”Anda menemukan seluruh paragraf yang tidak dipahami, perlu mengurai kalimat per kalimat.
Langkah:
- Salin seluruh paragraf
- Buka Mode Paragraf DevGlish (Menu → Paragraph Mode)
- Tempel teks
- Lihat penguraian kalimat per kalimat dari Claude
Alur Kerja 3: Simpan Ekspresi Berkualitas (Bangun Perpustakaan)
Section titled “Alur Kerja 3: Simpan Ekspresi Berkualitas (Bangun Perpustakaan)”Selama membaca dokumentasi, Anda menemukan cara ekspresi yang baik. Simpan untuk digunakan nanti dalam code review atau dokumentasi Anda sendiri.
Langkah:
- Pilih kalimat tersebut
- ⌘⇧D buka DevGlish
- Klik “Simpan” (tombol 📌)
- Tandai dengan tag “technical-writing”
Praktik Terbaik Membaca Dokumentasi
Section titled “Praktik Terbaik Membaca Dokumentasi”1. Pahami Dulu Baru Dalami Kode
Section titled “1. Pahami Dulu Baru Dalami Kode”Saat menemukan konsep kompleks:
- Gunakan Mode Paragraf untuk memahami penjelasan dokumentasi
- Setelah memahami konsep, baru lihat contoh kode
- Jika masih belum jelas, cari video penjelasan di YouTube
2. Perpustakaan Kosakata Aktif (Active Vocabulary)
Section titled “2. Perpustakaan Kosakata Aktif (Active Vocabulary)”Saat menemukan ekspresi, ada tiga pilihan:
| Cara Penanganan | Skenario | Contoh |
|---|---|---|
| Pencarian cepat (tidak disimpan) | Cukup dipahami, tidak akan digunakan dalam waktu dekat | ”parameterize” |
| Simpan tapi tidak diulang | Ekspresi bagus, mungkin berguna nanti | ”achieves decoupling” |
| Simpan + ulang | Sering digunakan, perlu dikuasai secara aktif | ”race condition” |
3. Sesuaikan Strategi Berdasarkan Jenis Dokumentasi
Section titled “3. Sesuaikan Strategi Berdasarkan Jenis Dokumentasi”| Jenis Dokumentasi | Cara Membaca | Kapan Menyimpan |
|---|---|---|
| Dokumentasi API | Scan cepat, cari kata asing | Deskripsi parameter, penggunaan umum |
| Tutorial | Mode Paragraf per kalimat | Kalimat penjelasan yang baik, contoh |
| Dokumen desain | Fokus konsep, abaikan detail | Deskripsi arsitektur, penjelasan pertimbangan desain |
| Artikel blog | Baca seluruh paragraf, gunakan Mode Paragraf untuk yang samar | Ekspresi opini, ungkapan praktik terbaik |
Peningkatan Bertahap Tingkat Kesulitan Membaca
Section titled “Peningkatan Bertahap Tingkat Kesulitan Membaca”Tahap 1: Dokumentasi Sederhana (Pemula)
Section titled “Tahap 1: Dokumentasi Sederhana (Pemula)”- Tutorial pemula Django
- Panduan memulai API resmi
- Artikel blog tingkat menengah
Strategi: Pencarian kata cepat + sesekali Mode Paragraf
Tahap 2: Dokumentasi Tingkat Menengah
Section titled “Tahap 2: Dokumentasi Tingkat Menengah”- Dokumentasi resmi Kubernetes
- Dokumen desain proyek open source besar
- Blog teknis berkualitas tinggi
Strategi: Mode Paragraf untuk kalimat kompleks
Tahap 3: Dokumentasi Tingkat Tinggi
Section titled “Tahap 3: Dokumentasi Tingkat Tinggi”- Makalah akademis (dalam bidang Anda)
- RFC yang kompleks (Request For Comments)
- Analisis teknis mendalam
Strategi: Baca ringkasan atau video penjelasan terlebih dahulu, baru baca teks asli, gunakan Mode Paragraf untuk setiap paragraf
Referensi Cepat: Tiga Tombol
Section titled “Referensi Cepat: Tiga Tombol”| Tombol | Tindakan | Skenario |
|---|---|---|
| Pencarian cepat (⌘⇧D) | Pilih kata → jendela cepat → lihat definisi → tutup | Perlu memahami cepat, lanjut membaca |
| Mode Paragraf | Salin paragraf → tempel → dapatkan penguraian per kalimat | Seluruh paragraf tidak dipahami atau ingin memahami mendalam |
| Simpan (📌) | Pilih ekspresi → saat pencarian klik simpan | Ekspresi bagus, untuk diulang atau digunakan nanti |