รับช่วงโปรเจกต์เก่าที่ไม่มีเอกสาร? วิธีให้ Claude Code ช่วยทำความเข้าใจโค้ด

เมื่อรับช่วงโปรเจกต์เก่าที่ไม่มีเอกสาร การเริ่มแก้โค้ดทันทีอาจทำให้พลาดความสัมพันธ์ระหว่างไฟล์หรือพฤติกรรมที่ระบบต้องรักษาไว้ ผู้ใช้ ComSiam สามารถให้ Claude Code สำรวจ Repository ก่อน โดยขอให้สรุปสิ่งที่พบพร้อมระบุไฟล์และหลักฐาน แทนการคาดเดาจากชื่อไฟล์เพียงอย่างเดียว

เริ่มสำรวจโปรเจกต์อย่างเป็นขั้นตอน

① ตรวจสถานะและขอบเขตโปรเจกต์
เปิด Claude Code จากโฟลเดอร์โปรเจกต์ที่ถูกต้อง ตรวจสถานะ Git และดูว่ามีไฟล์ที่แก้ค้างอยู่หรือไม่ เพื่อไม่ให้เข้าใจผิดว่างานเดิมเป็นการเปลี่ยนแปลงใหม่

② ให้ตรวจไฟล์ตั้งต้นและการตั้งค่า
ขอให้สำรวจไฟล์ที่บอกวิธีติดตั้งหรือรันโปรเจกต์ เช่น README ไฟล์ Manifest ของแพ็กเกจ ไฟล์ตั้งค่า และไฟล์กำหนดคำสั่งทดสอบ หากไฟล์เหล่านี้ไม่มีหรือไม่ครบ ให้ระบุว่าไม่พบ

③ หาจุดเริ่มทำงานของระบบ
ให้ค้นหาว่าแอปเริ่มทำงานจากไฟล์ใด เช่น จุดเริ่มต้นของเว็บ เซิร์ฟเวอร์ คำสั่ง CLI หรือ Worker แล้วติดตามการเรียกใช้ไปยังส่วนสำคัญ

④ ติดตามเส้นทางข้อมูล
เลือกฟังก์ชันหรือหน้าจอหลักหนึ่งส่วน แล้วให้ Claude Code อธิบายว่าข้อมูลมาจากไหน ผ่านไฟล์หรือฟังก์ชันใด และถูกแสดงหรือบันทึกอย่างไร วิธีนี้ช่วยให้เข้าใจความสัมพันธ์ของโค้ดจากตัวอย่างจริง

⑤ ตรวจวิธีทดสอบและการทำงานเดิม
ให้หาไฟล์ทดสอบ คำสั่งรันทดสอบ และวิธีรันโปรเจกต์ หากยังไม่มีการทดสอบ ให้ Claude Code ระบุข้อจำกัดแทนการสรุปว่าระบบทำงานถูกต้องแล้ว

⑥ ขอแผนผังและสรุปที่มีแหล่งอ้างอิงในโค้ด
ขอให้สรุปโฟลเดอร์สำคัญ หน้าที่ของแต่ละส่วน และไฟล์ที่ควรอ่านต่อ พร้อมอ้างชื่อไฟล์หรือฟังก์ชันเพื่อให้เปิดตรวจเองได้

Prompt สำหรับสำรวจโปรเจกต์ที่ไม่มีเอกสาร

ช่วยทำความเข้าใจ Repository นี้ก่อนเริ่มแก้โค้ด

ตอนนี้ยังไม่ต้องแก้ไขไฟล์หรือรันคำสั่งที่เปลี่ยนแปลงโปรเจกต์

ช่วยสำรวจและสรุป:
① ไฟล์ตั้งต้นและวิธีรันโปรเจกต์ที่พบ
② โฟลเดอร์และไฟล์สำคัญ พร้อมหน้าที่
③ เส้นทางการทำงานของ [ระบุฟีเจอร์หรือส่วนที่สนใจ]
④ จุดที่อ่านข้อมูล บันทึกข้อมูล หรือเรียกบริการภายนอก
⑤ วิธีทดสอบที่มีอยู่และข้อจำกัด

ทุกข้อสรุปเกี่ยวกับโค้ดให้ระบุไฟล์หรือฟังก์ชันที่ใช้ยืนยัน
อย่าคาดเดาส่วนที่ยังตรวจไม่พบ ให้แยกเป็น “ยืนยันจากโค้ดแล้ว” กับ “ยังไม่ทราบ”
ปิดท้ายด้วยรายการไฟล์ที่ควรอ่านต่อ หากฉันต้องการแก้ [งานที่วางแผนไว้]

วิธีตรวจว่าสรุปจาก Claude Code น่าเชื่อถือหรือไม่

คำอธิบายที่ดีควรพาไปยังไฟล์หรือฟังก์ชันที่ตรวจสอบได้ ลองเปิดไฟล์ที่อ้างถึงแล้วเทียบกับคำอธิบาย และถามต่อเฉพาะจุดที่ยังไม่ชัด เช่น “เส้นทางนี้เริ่มจากฟังก์ชันใด” หรือ “ส่วนใดเรียกใช้ข้อมูลนี้อีกบ้าง”

หากโปรเจกต์มีระบบภายนอก เช่น ฐานข้อมูล บริการชำระเงิน หรือ API ภายใน ข้อมูลบางส่วนอาจไม่ได้ปรากฏในโค้ดที่เปิดอยู่ ผู้ใช้ ComSiam ควรให้ Claude Code ระบุสิ่งที่เห็นจากไฟล์กับสิ่งที่ต้องตรวจจากระบบอื่นแยกจากกัน

หลังเข้าใจโครงสร้างแล้ว ควรทำอะไรต่อ

ก่อนเริ่มแก้ ให้บันทึกสรุปสั้น ๆ ของโครงสร้าง วิธีรัน คำสั่งทดสอบ และข้อควรระวังไว้ในเอกสารของทีม หากต้องการให้ Claude Code ใช้แนวทางโปรเจกต์ซ้ำในอนาคต สามารถจัดทำไฟล์คำแนะนำของโปรเจกต์ เช่น CLAUDE.md โดยใส่เฉพาะข้อมูลที่ตรวจสอบแล้วและเป็นประโยชน์ต่อการทำงาน

อย่าใส่รหัสผ่าน API Key หรือข้อมูลลับลงในเอกสารคำแนะนำ และควรตรวจสถานะ Git ก่อนทำการเปลี่ยนแปลงจริงทุกครั้ง

สรุป

การใช้ Claude Code ทำความเข้าใจโปรเจกต์เก่าควรเริ่มจากสำรวจไฟล์ตั้งต้น จุดเริ่มทำงาน เส้นทางข้อมูล และชุดทดสอบ แล้วขอให้สรุปพร้อมชื่อไฟล์หรือฟังก์ชันที่ตรวจสอบได้ การแยกข้อเท็จจริงออกจากสิ่งที่ยังไม่ทราบช่วยลดการคาดเดา และทำให้วางแผนแก้ไขโค้ดได้รอบคอบขึ้น ผู้ใช้ ComSiam ควรตรวจคำอธิบายกับโค้ดจริงก่อนนำไปใช้เป็นเอกสารอ้างอิง