MATERI 20 / 20
Dokumentasi dan AI coding: tinggalkan jejak yang bisa dilanjutkan
Kode yang bisa berjalan hari ini perlu dapat dipahami lagi besok. Dokumentasi yang baik membantu orang atau asisten berikutnya memahami tujuan, keputusan dan bukti tanpa bergantung pada satu percakapan.
Catat cara menjalankan dan batas perilaku
README perlu menjelaskan prasyarat, perintah, konfigurasi yang dibutuhkan serta cara memeriksa hasil. Gunakan contoh data palsu dan jangan salin secret. Bedakan fitur yang sudah bekerja, simulasi dan rencana. Seseorang yang baru membuka repositori harus tahu bagian mana yang masih membutuhkan layanan atau keputusan pemilik.
Simpan alasan keputusan
Komentar yang hanya mengulang setiap baris kode cepat menjadi gangguan. Catat alasan untuk keputusan yang tidak jelas, batas sistem dan tradeoff yang memengaruhi perubahan berikutnya. Handoff singkat dapat memuat tujuan, berkas penting, pengujian aktual dan langkah selanjutnya. Perbarui ketika keadaan berubah, bukan menumpuk catatan yang saling bertentangan.
Nilai hasil AI dengan bukti yang sama
Prompt yang spesifik menyebut tujuan pengguna, cakupan, batasan dan kriteria selesai. Sesudah AI mengubah kode, periksa diff, jalankan pemeriksaan yang relevan dan coba alur pengguna. Penjelasan yang meyakinkan bukan bukti perilaku. Minta alasan serta ketidakpastian, lalu cocokkan klaim dengan hasil yang dapat diamati.
Tujuan: pencarian tetap benar saat respons datang terbalik Batas: jangan ubah kontrak API atau desain utama Lulus: hasil query terbaru tetap tampil; input dan fokus terjaga Bukti: diff diperiksa, skenario respons terbalik dicoba Handoff: perubahan, hasil pemeriksaan, keterbatasan, langkah berikutnya
Giliran kamu.
Tulis README singkat untuk proyek latihan dan satu brief perubahan untuk AI. Minta orang lain membaca instruksi, lalu catat informasi yang masih mereka butuhkan.
- Perintah dapat dijalankan dari catatan
- Fitur, simulasi dan rencana dibedakan
- Klaim AI dicocokkan dengan bukti