วิธีใช้งาน CLAUDE.md อย่างถูกต้อง

CLAUDE.md เป็นไฟล์พิเศษที่อยู่ในไดเรกทอรีรากของโปรเจ็กต์ ใช้เพื่อบอกผู้ช่วย AI (เช่น Claude) เกี่ยวกับข้อมูลสำคัญของโปรเจ็กต์ของคุณ การเขียนไฟล์นี้ให้ดี จะช่วยให้ AI เข้าใจและช่วยเหลือคุณได้ดีขึ้น

ทำไมต้องมี CLAUDE.md?

ลองจินตนาการว่าคุณมีเพื่อนร่วมงานใหม่ คุณต้องใช้เวลานานแค่ไหนในการทำให้เขาเข้าใจโปรเจ็กต์ของคุณ? CLAUDE.md ก็คือ "คู่มือแนะนำโปรเจ็กต์" ที่ช่วยให้ AI เริ่มต้นได้อย่างรวดเร็ว

5 เนื้อหาหลักของ CLAUDE.md

1. ภาพรวมโครงการ

อธิบายง่ายๆ ว่าโปรเจ็กต์นี้ทำอะไร แก้ปัญหาอะไร และมุ่งเป้าไปที่ผู้ใช้กลุ่มใด

# ภาพรวมโครงการ นี่คือระบบจัดการหลังบ้านสำหรับร้านค้าออนไลน์ ใช้สำหรับจัดการสินค้า คำสั่งซื้อ และผู้ใช้

2. เทคโนโลยีที่ใช้

แสดงรายการเทคโนโลยีและเฟรมเวิร์กหลักที่ใช้ในโปรเจ็กต์

`# เทคโนโลยีที่ใช้

ส่วนหน้า: React + TypeScript
ส่วนหลัง: Node.js + Express
ฐานข้อมูล: PostgreSQL
การปรับใช้: Docker + Kubernetes`

3. โครงสร้างไฟล์

อธิบายหน้าที่ของไดเรกทอรีหลัก

# โครงสร้างไฟล์ /src /components - ส่วนประกอบ UI /pages - หน้า /utils - ฟังก์ชันยูทิลิตี้ /api - การเรียก API

4. คำสั่งที่ใช้บ่อย

แสดงรายการคำสั่งที่ใช้บ่อยในการพัฒนา

# คำสั่งที่ใช้บ่อย npm run dev - เริ่มเซิร์ฟเวอร์พัฒนา npm run build - สร้างเวอร์ชันสำหรับใช้งานจริง npm run test - รันการทดสอบ

5. กฎ

กำหนดกฎที่ AI ควรปฏิบัติตามเมื่อช่วยคุณเขียนโค้ด

`# กฎการเขียนโค้ด

ใช้ส่วนประกอบฟังก์ชัน
ปฏิบัติตามการกำหนดค่า ESLint
ใช้ PascalCase สำหรับการตั้งชื่อส่วนประกอบ
ใช้ camelCase สำหรับการตั้งชื่อตัวแปร`

ตัวอย่างที่สมบูรณ์

`# ชื่อโปรเจ็กต์: Task Manager

ภาพรวมโครงการ

แอปพลิเคชันจัดการงานง่ายๆ ที่รองรับการสร้าง แก้ไข ลบ และจัดหมวดหมู่

เทคโนโลยีที่ใช้

React 18
TypeScript
Tailwind CSS
Vite

โครงสร้างไฟล์

/src /components - ส่วนประกอบ UI /hooks - Custom Hooks /types - คำจำกัดความประเภท TypeScript /utils - ฟังก์ชันยูทิลิตี้

คำสั่งที่ใช้บ่อย

npm run dev: เริ่มเซิร์ฟเวอร์พัฒนา
npm run build: สร้างเวอร์ชันสำหรับใช้งานจริง
npm run lint: ตรวจสอบโค้ด

ข้อกำหนดการเขียนโค้ด

ใช้ฟังก์ชันในการเขียนส่วนประกอบ
ใช้ Tailwind CSS สำหรับสไตล์
วางแต่ละส่วนประกอบในโฟลเดอร์แยกกัน`

เคล็ดลับ

ทำให้กระชับ: อย่าเขียนยาวเกินไป AI ก็ "เหนื่อย" ได้
อัปเดตเป็นประจำ: อย่าลืมอัปเดต CLAUDE.md เมื่อโปรเจ็กต์มีการเปลี่ยนแปลง
ตัวอย่างสำคัญ: การให้ตัวอย่างโค้ดที่เป็นรูปธรรมมีประสิทธิภาพมากกว่าคำอธิบายที่เป็นนามธรรม
มุ่งเน้นที่จุดที่เจ็บปวด: อธิบายจุดที่มักเกิดข้อผิดพลาดอย่างละเอียด

เขียน CLAUDE.md ให้ดี แล้วให้ AI เป็นผู้ช่วยที่ไว้ใจได้ของคุณ!