คู่มือ CLAUDE.md

เขียน CLAUDE.md ที่สมบูรณ์แบบ

CLAUDE.md คือไฟล์เดียวที่กำหนดว่า Claude เข้าใจโครงการของคุณอย่างไร การเขียนที่ดีหมายถึงการแก้ไขน้อยลง โค้ดที่ดีกว่า และเอเจนต์ที่รู้ว่าพวกเขากำลังทำงานอะไรจริงๆ

คู่มือนี้จะพาคุณผ่านทุกส่วนของไฟล์ CLAUDE.md ตั้งแต่การประกาศเทคสแต็กไปจนถึงคำแนะนำเฉพาะสำหรับเอเจนต์ ติดตามและสร้างของคุณทีละขั้นตอน

CLAUDE.md คืออะไร?

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

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

การลงทุน 10 นาทีใน CLAUDE.md ช่วยประหยัดเวลาหลายชั่วโมงในการแก้ไขโค้ดที่สร้างโดย AI ซึ่งไม่ตรงกับรูปแบบของโครงการของคุณ

สังเกตเห็นได้จากโครงการ Claude Code หลายร้อยโครงการ

CLAUDE.md ที่ไม่ดี vs. ดี

โครงสร้างและความเฉพาะเจาะจงของ CLAUDE.md ของคุณมีผลโดยตรงต่อประสิทธิภาพของ Claude ในฐานข้อมูลโค้ดของคุณ

CLAUDE.md ที่อ่อนแอ

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

CLAUDE.md ที่แข็งแกร่ง

  • เทคสแต็กที่ชัดเจนพร้อมเวอร์ชัน: React 19, Vite 6, Zustand 5, Tailwind 4
  • แผนที่ไฟล์ที่ชัดเจนแสดงไดเรกทอรีหลักและวัตถุประสงค์ของพวกเขา
  • รูปแบบการตั้งชื่อที่บันทึกไว้ การจัดการข้อผิดพลาด และความชอบด้านสไตล์
  • คำสั่งการสร้าง ทดสอบ และพัฒนาพร้อมให้คัดลอกและรัน

6 ส่วนที่จำเป็น

CLAUDE.md ที่มีโครงสร้างดีครอบคลุมพื้นที่ทั้งหกนี้ แต่ละส่วนให้ข้อมูลที่ชัดเจนแก่ Claude ที่สามารถดำเนินการได้ทันที

การประกาศเทคสแต็ก

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

แผนที่โครงสร้างไฟล์

อธิบายไดเรกทอรีหลักของคุณและสิ่งที่อยู่ในแต่ละไดเรกทอรี ส่วนประกอบ, สโตร์, บริการ, เส้นทาง API, ประเภท ไดอะแกรมต้นไม้สั้น ๆ พร้อมคำอธิบายหนึ่งบรรทัดต่อโฟลเดอร์ทำงานได้ดี

แนวทางการเขียนโค้ด

บันทึกแพทเทิร์นการตั้งชื่อของคุณ (camelCase สำหรับไฟล์, PascalCase สำหรับส่วนประกอบ), วิธีการจัดการข้อผิดพลาด, การจัดลำดับการนำเข้า, และกฎเฉพาะของโปรเจกต์ใด ๆ สิ่งนี้จะทำให้ผลลัพธ์ของ Claude สอดคล้องกับโค้ดที่มีอยู่ของคุณ

คำสั่งสร้างและทดสอบ

รวมคำสั่งพัฒนา, สร้าง, ทดสอบ, และลินต์ของคุณ เมื่อ Claude ต้องการตรวจสอบว่าสิ่งใดทำงานได้หรือแนะนำสคริปต์ มันจะใช้คำสั่งที่โปรเจกต์ของคุณคาดหวังอย่างแม่นยำ

คำแนะนำบทบาทตัวแทน

หากคุณใช้ตัวแทนหลายตัว (QA, frontend, backend, DevOps) ให้เพิ่มส่วนที่อธิบายว่าบทบาทแต่ละบทควรให้ความสำคัญกับอะไร สิ่งนี้มีประโยชน์โดยเฉพาะกับการตั้งค่าหลายตัวแทนของ AgentsRoom

หลีกเลี่ยงพื้นที่

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

สร้าง CLAUDE.md ของคุณใน 4 ขั้นตอน

คุณไม่จำเป็นต้องเขียนทุกอย่างในครั้งเดียว เริ่มต้นด้วยพื้นฐานและขยายเมื่อคุณค้นพบสิ่งที่ Claude ต้องรู้

1

ตรวจสอบโปรเจกต์ของคุณ

เปิด package.json ของคุณและระบุกรอบงาน, ไลบรารี, และเครื่องมือทุกตัวที่โปรเจกต์ของคุณใช้ ระบุเวอร์ชัน ตรวจสอบความต้องการในการทำงานของคุณ (เวอร์ชัน Node, เวอร์ชัน Python, ฐานข้อมูล) สิ่งนี้จะกลายเป็นส่วนเทคสแต็กของคุณ

package.json + เวอร์ชันการทำงาน + ฐานข้อมูล

2

แมพต้นไม้ไฟล์ของคุณ

รันต้นไม้ด่วนของไดเรกทอรี src ของคุณ ระบุโฟลเดอร์ระดับสูงสุดและเขียนคำอธิบายหนึ่งบรรทัดของแต่ละโฟลเดอร์ มุ่งเน้นไปที่ที่ส่วนประกอบ, สโตร์, บริการ, ประเภท, และเส้นทาง API ตั้งอยู่

src/ ต้นไม้พร้อมคำอธิบายวัตถุประสงค์

3

บันทึกแนวทางของคุณ

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

การตั้งชื่อ, การนำเข้า, การจัดการข้อผิดพลาด, การส่งออก

4

เพิ่มส่วนเฉพาะตัวแทน

หากคุณทำงานกับตัวแทนเฉพาะ ให้เพิ่มพื้นที่โฟกัสสำหรับแต่ละบทบาท ตัวแทน frontend ควรรู้จักไลบรารีส่วนประกอบของคุณ ตัวแทน DevOps ควรรู้จักท่อการปรับใช้ของคุณ ตัวแทน QA ควรรู้จักกรอบการทดสอบของคุณ

พื้นที่โฟกัสตามบทบาท + พื้นที่หลีกเลี่ยง

ทำไม AgentsRoom สำหรับ CLAUDE.md?

AgentsRoom ถูกสร้างขึ้นรอบ ๆ CLAUDE.md ในฐานะแนวคิดระดับหนึ่ง ไม่ใช่สิ่งที่คิดขึ้นภายหลัง

ตัวแก้ไข CLAUDE.md ในตัว

แก้ไข CLAUDE.md ของคุณโดยตรงภายใน AgentsRoom พร้อมการเน้นไวยากรณ์และการบันทึกแบบสด ไม่ต้องสลับไปยังโปรแกรมแก้ไขข้อความหรือ IDE ของคุณ

การแสดงตัวอย่างสดต่อแต่ละตัวแทน

ดูว่าตัวแทนแต่ละตัวตีความ CLAUDE.md ของคุณอย่างไรในเวลาจริง ดูผลลัพธ์ในเทอร์มินัลเพื่อตรวจสอบว่าตัวแทนปฏิบัติตามแนวทางของคุณและเคารพพื้นที่หลีกเลี่ยงของคุณ

บริบทต่อโปรเจกต์

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

การรวมบทบาทเอเจนต์

14 บทบาทเอเจนต์ของ AgentsRoom เชื่อมโยงโดยตรงกับส่วนต่างๆ ของ CLAUDE.md กำหนดพื้นที่ที่มุ่งเน้นและหลีกเลี่ยงพื้นที่ตามบทบาท และแต่ละเอเจนต์จะรับคำแนะนำที่เหมาะสมสำหรับมันโดยเฉพาะ

Watch what your CLAUDE.md does to Claude Code token usage

CLAUDE.md is prepended to every Claude turn. A bloated CLAUDE.md silently inflates Claude Code token usage on every message. AgentsRoom puts a per-session token meter on each agent so you can see exactly how much your CLAUDE.md is costing you, with a live cache hit rate to confirm it stays cached.

See the Claude Code token usage tracker

คำถามที่พบบ่อยเกี่ยวกับ CLAUDE.md

ฉันควรวางไฟล์ CLAUDE.md ของฉันที่ไหน?+
วางไว้ที่รากของไดเรกทอรีโปรเจกต์ของคุณ ถัดจากไฟล์ package.json หรือไฟล์คอนฟิกที่เทียบเท่า Claude Code จะอ่านไฟล์นี้โดยอัตโนมัติเมื่อเริ่มเซสชันในไดเรกทอรีนั้น คุณยังสามารถมีไฟล์ CLAUDE.md ที่ซ้อนกันในไดเรกทอรีย่อยสำหรับบริบทที่เฉพาะเจาะจงมากขึ้นได้
ไฟล์ CLAUDE.md ควรยาวแค่ไหน?+
ไม่มีขีดจำกัดที่เข้มงวด แต่ควรตั้งเป้าไว้ที่ 50 ถึง 300 บรรทัด ครอบคลุมสิ่งที่จำเป็น: สแต็กเทคโนโลยี โครงสร้างไฟล์ ข้อกำหนด และคำสั่ง ถ้าสั้นเกินไป Claude จะขาดบริบท ถ้ายาวเกินไปคุณอาจเสี่ยงที่จะทำให้ส่วนสำคัญถูกกลบด้วยเสียงรบกวน
CLAUDE.md ใช้งานได้กับโมเดล Claude ทุกตัวหรือไม่?+
ใช่ CLAUDE.md จะถูกอ่านโดย Claude Code ไม่ว่าจะเลือกโมเดลไหน (Opus, Sonnet, หรือ Haiku) โมเดลทั้งหมดจะได้รับประโยชน์จากบริบทโปรเจกต์ที่ชัดเจน แม้ว่าโมเดลที่ใหญ่กว่าอย่าง Opus จะสามารถดูดซับและใช้คำแนะนำที่ละเอียดมากขึ้นได้
ฉันควรบันทึก CLAUDE.md ในการควบคุมเวอร์ชันหรือไม่?+
ใช่ สำหรับคำแนะนำโปรเจกต์ที่แชร์ ทีมของคุณจะได้รับประโยชน์จากพฤติกรรม AI ที่สอดคล้องกันในหมู่ผู้พัฒนาทุกคน สำหรับความชอบส่วนบุคคล AgentsRoom รองรับการกำหนดค่าของเอเจนต์ส่วนบุคคลที่ถูก gitignored โดยอัตโนมัติ
ฉันสามารถใช้ CLAUDE.md กับการตั้งค่าแบบหลายเอเจนต์ได้หรือไม่?+
แน่นอน ใน AgentsRoom เอเจนต์แต่ละตัวในโปรเจกต์ของคุณจะอ่านไฟล์ CLAUDE.md เดียวกัน คุณสามารถเพิ่มส่วนเฉพาะบทบาท (เช่น หมายเหตุสำหรับเอเจนต์ QA เทียบกับเอเจนต์ฟรอนต์เอนด์) เพื่อให้แต่ละผู้เชี่ยวชาญได้รับคำแนะนำที่ตรงเป้าหมาย
ฉันควรอัปเดต CLAUDE.md ของฉันบ่อยแค่ไหน?+
อัปเดตเมื่อโครงสร้างหรือข้อกำหนดของโปรเจกต์ของคุณเปลี่ยนแปลง เพิ่มเฟรมเวิร์กใหม่? อัปเดตสแต็กเทคโนโลยี ย้ายไปยังเลย์เอาต์ไดเรกทอรีใหม่? อัปเดตแผนที่ไฟล์ CLAUDE.md ที่ล้าสมัยจะนำไปสู่คำแนะนำที่ล้าสมัย

เริ่มเขียนไฟล์ CLAUDE.md ที่ดีกว่า

ดาวน์โหลด AgentsRoom และใช้ตัวแก้ไข CLAUDE.md ที่มีในตัวเพื่อให้เอเจนต์ของคุณมีบริบทที่พวกเขาต้องการ คำแนะนำที่ดีกว่า โค้ดที่ดีกว่า

ฟรีดาวน์โหลด AgentsRoom

แอปคู่หู: ตรวจสอบตัวแทนของคุณได้ทุกที่

นำของคุณเอง: Claude, Codex, Antigravity CLI, หรือผู้ให้บริการ AI อื่น ๆ

รับส่วนขยาย
Chrome Web Store

ส่งข้อบกพร่องและคำขอไปยังแบ็คล็อกสาธารณะของคุณโดยตรง

มองเห็น AgentsRoom ในการทำงาน

หลายโปรเจกต์
ผู้ให้บริการหลายราย
หลาย agents
สถานะสด
ไฟล์ diff & commit
คู่หูมือถือ
ตัวอย่างสด
ทีมตัวแทน
การทำงานอัตโนมัติในเบราว์เซอร์
การพัฒนาที่ขับเคลื่อนด้วย backlog
ห้องสมุดคำสั่ง
ห้องสมุดทักษะ
ดูฟีเจอร์ทั้งหมด