Jujur aja, sebagai engineer, hal apa yang paling males kalian lakuin? Kalau jawaban saya: Update Dokumentasi. Sering banget kita sudah capek-capek refactoring kode atau nambahin fitur baru di server, tapi file README.md masih pakai instruksi dari dua tahun lalu. Akhirnya, pas ada rekan setim (atau diri kita sendiri di masa depan) yang baca, malah jadi bingung sendiri karena instruksinya sudah nggak relevan alias outdated.
Nah, di sini Claude Code masuk sebagai penyelamat. Kita bisa suruh Claude buat jadi “Technical Writer” pribadi yang baca kode kita dan nulis dokumentasinya secara otomatis.
Mengapa Dokumentasi Sering “Gagal”?
Biasanya dokumentasi jadi basi karena:
- Context Switch: Kita terlalu fokus benerin bug, sampai lupa buka file
.md. - Manual Effort: Harus ngetik ulang struktur folder atau variabel yang baru diubah.
- Mager: Ya, sesimpel itu.
Cara Pakai Claude Code buat Update Dokumentasi
Dengan Claude Code, kalian nggak perlu pindah jendela. Cukup kasih instruksi langsung di terminal tempat kalian koding.
1. Generate README dari Nol
Kalau project kalian belum ada penjelasannya, tinggal suruh Claude buat “membedah” seluruh isi folder. Prompt:
“Claude, tolong baca seluruh struktur project ini. Buatkan file README.md yang mencakup cara install, cara jalanin script, dan penjelasan singkat tiap folder.”
2. Update Dokumentasi Spesifik (Refactoring)
Misal kalian baru saja mengubah flow pengiriman email di script Python atau Bash kalian. Prompt:
“Saya baru saja update fungsi SMTP Relay di
mailer.py. Tolong update bagian ‘Usage’ di dokumentasi agar sesuai dengan parameter yang baru.”
Pro-Tip: Sinkronisasi Kode & Dokumen (Biar Nggak Outdated!)
Ini trik rahasia biar dokumentasi kalian selalu up-to-date: Jadikan update dokumentasi sebagai bagian dari “Definition of Done”.
Kalian bisa kasih instruksi permanen via /init atau CLAUDE.md seperti ini:
“Setiap kali Anda melakukan perubahan logika pada kode, Anda wajib memeriksa apakah perubahan tersebut berdampak pada README.md atau file di folder /docs. Jika iya, tawarkan draft perubahan dokumentasi sebelum saya melakukan commit.”
Dengan begini, Claude Code bakal jadi “polisi” dokumentasi yang bakal ngingetin kalian kalau ada yang belum tercatat.
Kesimpulan
Dokumentasi nggak harus jadi beban lagi. Dengan memanfaatkan kemampuan context-awareness dari Claude Code, file README.md kalian bakal selalu sinkron dengan kode yang kalian tulis. Kerja jadi lebih profesional, dan rekan setim nggak akan lagi komplain soal instruksi yang “basi”.
Kalian punya tips lain buat jaga dokumentasi tetap rapi? Atau punya pengalaman lucu gara-gara dokumentasi yang salah? Tulis di kolom komentar ya!
