Bagaimana Anda menggunakan AI untuk menulis dokumentasi teknis, changelog, dan pesan commit?

Question

Accepted Answer

Kunci adalah **memberikan bahan baku kepada AI** — diff atau kode sebenarnya — dan minta format yang spesifik dan konvensional. AI bagus dalam mengubah perubahan menjadi prosa yang jelas, tetapi hanya jika dapat melihat apa yang berubah.

## Alur kerja yang baik

- **Berikan diff-nya**, bukan deskripsi yang samar: `git diff --staged | <your AI tool>`.
- **Minta konvensi yang diketahui** — Conventional Commits (`feat:`, `fix:`, `docs:`), atau gaya changelog Anda.
- **Pertahankan akurat dan ringkas** — baris subjek di bawah ~50 karakter, isi yang menjelaskan *mengapa*.
- **Verifikasi cocok dengan diff.** AI dapat membuat perubahan yang tidak ada; Anda harus memeriksa.

## Sebelum / Sesudah

Pesan commit yang malas:

```text
fixed stuff
```

Setelah memberikan diff dan meminta gaya Conventional Commit:

```text
fix(auth): reject expired tokens in session middleware

The middleware only checked token signature, not expiry, so expired
sessions stayed valid. Added an `exp` claim check that returns 401.
```

Versi kedua memberi tahu reviewer *apa* yang berubah dan *mengapa* — jauh lebih berguna di `git log` enam bulan kemudian.

## Apa yang AI bagus di sini

- **Docstring dan README** — ringkas tujuan dan penggunaan modul.
- **Changelog** — kelompokkan commit ke dalam bagian Added / Fixed / Changed.
- **Pesan commit** — ubah diff menjadi pesan yang bersih dan konvensional.

Selalu **baca hasil terhadap perubahan sebenarnya**. AI tidak mengetahui niat Anda — hanya kode yang ditunjukkan kepadanya — jadi dapat salah memberi label `fix` sebagai `feat` atau mengklaim efek samping yang tidak nyata.

## Mengapa ini penting

Pesan commit dan dokumentasi yang baik adalah cara Anda dan rekan kerja memahami di masa depan *mengapa* kode ada. AI menghilangkan gesekan menulis dengan baik, tetapi akurasi ada di tangan Anda: changelog yang salah dengan percaya diri lebih buruk daripada tidak ada. Berikan input nyata, tuntut konvensi nyata, dan verifikasi sebelum Anda commit.