คุณจะใช้ AI เขียนเอกสารทางเทคนิค changelog และ commit message ได้อย่างไร?

Question

Accepted Answer

กุญแจสำคัญคือ **ให้วัตถุดิบกับ AI** ตัว diff หรือโค้ดจริง และขอ format ที่เฉพาะเจาะจงตามแบบแผน AI เก่งในการเปลี่ยนการเปลี่ยนแปลงให้เป็นร้อยแก้วที่ชัดเจน แต่ก็ต่อเมื่อมันมองเห็นสิ่งที่เปลี่ยนไปได้เท่านั้น

## workflow ที่ดี

- **ป้อน diff ให้มัน** ไม่ใช่คำอธิบายที่คลุมเครือ: `git diff --staged | <your AI tool>`
- **ขอแบบแผนที่รู้จัก** Conventional Commits (`feat:`, `fix:`, `docs:`) หรือสไตล์ changelog ของคุณ
- **ให้แม่นยำและกระชับ** บรรทัดหัวข้อยาวไม่เกิน ~50 ตัวอักษร เนื้อหาอธิบายว่า *ทำไม*
- **ตรวจสอบว่ามันตรงกับ diff** AI สามารถกุการเปลี่ยนแปลงที่ไม่มีอยู่จริงขึ้นมาได้ คุณต้องตรวจสอบ

## ก่อน / หลัง

commit message ที่ขี้เกียจ:

```text
fixed stuff
```

หลังป้อน diff และขอสไตล์ 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.
```

เวอร์ชันที่สองบอกผู้ review ว่า *อะไร* เปลี่ยนไปและ *ทำไม* มีประโยชน์กว่ามากใน `git log` หกเดือนต่อมา

## AI เก่งอะไรในเรื่องนี้

- **Docstring และ README** สรุปวัตถุประสงค์และการใช้งานของ module
- **Changelog** จัดกลุ่ม commit เป็นส่วน Added / Fixed / Changed
- **Commit message** เปลี่ยน diff ให้เป็นข้อความที่สะอาดตามแบบแผน

**อ่านผลลัพธ์เทียบกับการเปลี่ยนแปลงจริงเสมอ** AI ไม่รู้เจตนาของคุณ รู้แค่โค้ดที่ถูกแสดงให้ดู ดังนั้นมันอาจติดป้าย `fix` ผิดเป็น `feat` หรืออ้าง side effect ที่ไม่มีอยู่จริงได้

## ทำไมจึงสำคัญ

commit message และเอกสารที่ดีคือวิธีที่ตัวคุณในอนาคตและเพื่อนร่วมทีมเข้าใจ *ทำไม* โค้ดถึงมีอยู่ AI ขจัดความฝืดของการเขียนสิ่งเหล่านี้ให้ดี แต่ความแม่นยำเป็นความรับผิดชอบของคุณ changelog ที่ผิดอย่างมั่นใจแย่กว่าการไม่มีเลย ป้อน input จริงให้มัน เรียกร้องแบบแผนจริง และตรวจสอบก่อนที่คุณจะ commit