AI untuk Dokumentasi

Dokumentasi: Tugas yang Semua Orang Tunda

Hampir semua developer menunda menulis dokumentasi: "nanti saja, kodenya sudah jelas kok." Tiga bulan kemudian, mereka sendiri bingung membaca kodenya. AI mengubah persamaan ini: yang tadinya butuh 2 jam menulis README sekarang butuh 10 menit (5 menit generate, 5 menit koreksi). Hambatan terbesar dokumentasi bukan kemampuan menulis, tapi kemalasan memulai, dan AI menghilangkan hambatan itu.

Tapi dokumentasi buatan AI punya penyakit khas: terlalu panjang, terlalu umum, dan basi. Modul ini mengajarkan cara meminta dokumentasi yang ringkas, spesifik, dan tetap akurat.

Contoh 1: Membuat README yang Bagus (Langkah Bertahap)

Kamu punya proyek kecil dan butuh README.

Langkah 1, beri AI bahan mentah yang cukup:

Buatkan README.md untuk proyekku. Konteks:

• Nama: kasir-sederhana. Aplikasi kasir berbasis web, satu file HTML + JavaScript.
• Fitur: tambah barang, hitung total, cetak struk (print browser).
• Cara jalan: buka index.html di browser, tidak perlu install.
• Struktur: index.html (semua kode), README.md (file ini). Aturan: maksimal 60 baris, bahasa Indonesia santai, sertakan bagian "Cara Pakai" dengan 3 langkah dan "Batasan" (apa yang belum bisa dilakukan aplikasi ini).

Langkah 2, koreksi bagian "Batasan". AI cenderung mengarang fitur atau menyembunyikan kekurangan. Baca dan pastikan batasannya jujur. Dokumentasi yang jujur tentang kekurangan jauh lebih berguna daripada yang memoles.

Langkah 3, minta versi Inggris (opsional). "Terjemahkan ke bahasa Inggris natural, bukan terjemahan kata per kata." Sekali jalan dapat dua versi.

Pola "konteks + aturan panjang + bagian wajib" ini berlaku untuk semua jenis dokumentasi. Tanpa aturan panjang, AI menulis esai. Tanpa bagian wajib, AI melewatkan hal penting.

Contoh 2: Dokumentasi Kode dan API (Praktik)

Komentar kode: jangan minta AI mengomentari SEMUA baris (itu noise). Minta selektif:

Tambahkan komentar HANYA untuk: (1) fungsi yang logikanya tidak obvious dari namanya, (2) angka/konstanta misterius, (3) workaround/hack dengan alasan. Jangan komentari kode yang sudah jelas. Pakai bahasa Indonesia singkat.

Dokumentasi API: kalau kamu punya endpoint atau fungsi library:

Buatkan dokumentasi untuk fungsi-fungsi di src/api.js dengan format: nama fungsi, 1 kalimat tujuan, daftar parameter (nama, tipe, wajib/tidak, contoh nilai), contoh pemanggilan lengkap, dan kemungkinan error. Jangan dokumentasikan fungsi internal (yang diawali underscore).

Setelah AI generate, verifikasi akurasinya dengan cara brutal tapi efektif: baca dokumentasinya sambil membayangkan kamu orang baru yang belum pernah lihat kode ini. Bisakah kamu memakai fungsinya hanya dari dokumentasi? Kalau ada yang ambigu, perbaiki (atau suruh AI perbaiki dengan feedback spesifik).

Catatan teknis: Dokumentasi yang baik mengikuti prinsip "docs as code": disimpan di repo yang sama, di-review seperti kode, dan diperbarui bersama kode. Masalah klasik dokumentasi AI: ia dibuat sekali dari snapshot kode, lalu kode berubah dan dokumentasi basi. Solusi praktis: (1) cantumkan tanggal/versi di dokumentasi ("dokumentasi ini sesuai kode per commit X"), (2) jadikan regenerasi dokumentasi bagian dari workflow (misal: tiap selesai fitur besar, minta AI perbarui README), (3) untuk API publik, pertimbangkan format yang bisa di-generate otomatis dari kode (JSDoc, OpenAPI) sehingga dokumentasi dan kode tidak pernah berpisah jauh.

Kesalahan Umum

1. Menerima dokumentasi tanpa verifikasi akurasi. AI bisa salah mendeskripsikan apa yang kode lakukan (terutama kode yang kompleks). Baca ulang dengan mata kritis, terutama contoh kode di dokumentasi: jalankan contohnya, pastikan benar-benar jalan.
2. Dokumentasi terlalu panjang. Dokumentasi 300 baris untuk proyek 200 baris = tidak ada yang baca. Minta ringkas, prioritaskan "cara pakai" di atas "penjelasan arsitektur".
3. Tidak pernah diperbarui. Dokumentasi basi lebih buruk daripada tidak ada dokumentasi: ia menyesatkan. Jadwalkan update tiap perubahan besar, atau tulis dokumentasi yang tahan lama (fokus ke konsep dan cara pakai, bukan detail yang cepat berubah).
4. Mendokumentasikan yang tidak perlu. Tidak semua kode butuh dokumentasi. Kode yang namanya jelas dan pendek = dokumentasi terbaiknya adalah kode itu sendiri. Minta AI fokus ke bagian yang benar-benar membingungkan.

Rangkuman

AI menghilangkan alasan "malas menulis dokumentasi". Polanya: beri konteks cukup + aturan panjang + bagian wajib > koreksi kejujuran (terutama batasan) > verifikasi contoh kode > jadwalkan update. Dokumentasi yang baik itu ringkas, akurat, dan hidup (diperbarui). Dengan AI, tidak ada lagi alasan untuk tidak punya.