Bạn dùng AI để viết tài liệu kỹ thuật, changelog và commit message như thế nào?

Question

Accepted Answer

Mấu chốt là **đưa cho AI nguyên liệu thô** — diff hoặc code thực tế — và yêu cầu một định dạng cụ thể, theo quy ước. AI giỏi biến một thay đổi thành văn xuôi rõ ràng, nhưng chỉ khi nó thấy được cái gì đã đổi.

## Một quy trình tốt

- **Đưa nó diff**, đừng mô tả mơ hồ: `git diff --staged | <công cụ AI của bạn>`.
- **Yêu cầu một quy ước đã biết** — Conventional Commits (`feat:`, `fix:`, `docs:`), hoặc văn phong changelog của bạn.
- **Giữ chính xác và ngắn gọn** — dòng tiêu đề dưới ~50 ký tự, phần thân giải thích *vì sao*.
- **Kiểm chứng nó khớp với diff.** AI có thể bịa ra các thay đổi không có ở đó; bạn phải kiểm tra.

## Trước / sau

Một commit message lười biếng:

```text
fixed stuff
```

Sau khi đưa diff và yêu cầu văn phong 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.
```

Phiên bản thứ hai cho người review biết *cái gì* đã đổi và *vì sao* — hữu ích hơn nhiều trong `git log` sáu tháng sau.

## AI giỏi ở những việc gì tại đây

- **Docstring và README** — tóm tắt mục đích và cách dùng của một module.
- **Changelog** — nhóm các commit thành các mục Added / Fixed / Changed.
- **Commit message** — biến một diff thành một message sạch, theo quy ước.

Luôn **đọc kết quả đối chiếu với thay đổi thực tế**. AI không biết ý định của bạn — chỉ biết code nó được cho xem — nên nó có thể gán nhầm một `fix` thành `feat` hoặc khẳng định một side effect không có thật.

## Tại sao điều này quan trọng

Commit message và tài liệu tốt là cách mà bản thân bạn trong tương lai và đồng đội hiểu được *vì sao* code tồn tại. AI loại bỏ sự ngần ngại khi viết chúng cho tốt, nhưng tính chính xác là trách nhiệm của bạn: một changelog sai một cách tự tin còn tệ hơn không có. Đưa nó input thật, đòi hỏi một quy ước thật, và kiểm chứng trước khi commit.