Panduan CLAUDE.md

Tulis CLAUDE.md yang Sempurna

CLAUDE.md adalah satu file yang membentuk cara Claude memahami proyek Anda. Yang ditulis dengan baik berarti lebih sedikit koreksi, kode yang lebih baik, dan agen yang benar-benar tahu apa yang mereka kerjakan.

Panduan ini memandu Anda melalui setiap bagian file CLAUDE.md, dari deklarasi tech stack hingga petunjuk khusus agen. Ikuti dan bangun milik Anda langkah demi langkah.

Apa Itu CLAUDE.md?

CLAUDE.md adalah file markdown yang Anda tempatkan di root proyek Anda. Ketika Claude Code memulai sesi, ia membaca file ini terlebih dahulu. Semua yang ada di dalamnya menjadi bagian dari konteks Claude: tech stack Anda, struktur file Anda, konvensi tim Anda, dan instruksi spesifik yang Anda inginkan agar diikuti setiap agen.

Anggap ini sebagai dokumen briefing. Tanpanya, Claude harus menebak bagaimana proyek Anda diorganisir. Dengan yang baik, Claude sudah tahu di mana hal-hal berada, pola mana yang diikuti, dan apa yang harus dihindari. Perbedaan kualitas output cukup signifikan.

โ€œInvestasi 10 menit di CLAUDE.md menghemat jam-jam untuk mengoreksi kode yang dihasilkan AI yang tidak cocok dengan pola proyek Anda.โ€

Diamati di ratusan proyek Claude Code

CLAUDE.md Buruk vs. Baik

Struktur dan kekhususan CLAUDE.md Anda secara langsung memengaruhi seberapa baik Claude bekerja di codebase Anda.

CLAUDE.md yang Lemah

  • โœ—Instruksi samar seperti "gunakan praktik terbaik" tanpa kekhususan
  • โœ—Tidak ada peta struktur file, sehingga Claude menebak di mana meletakkan kode baru
  • โœ—Konvensi coding yang hilang; gaya output bervariasi antara sesi
  • โœ—Tidak ada perintah build atau test yang terdaftar, mengakibatkan saran yang rusak

CLAUDE.md yang Kuat

  • โœ“Tech stack eksplisit dengan versi: React 19, Vite 6, Zustand 5, Tailwind 4
  • โœ“Peta file yang jelas menampilkan direktori kunci dan tujuannya
  • โœ“Pola penamaan, penanganan error, dan preferensi gaya yang terdokumentasi
  • โœ“Perintah build, test, dan dev yang siap disalin dan dijalankan

6 Bagian Penting

CLAUDE.md yang terstruktur dengan baik mencakup enam area ini. Setiap satu memberi Claude informasi konkret yang dapat langsung ditindaklanjuti.

Deklarasi Tech Stack

Daftarkan framework, library, dan versinya secara eksplisit. Sertakan package manager, versi Node, dan persyaratan runtime apa pun. Claude menggunakan ini untuk menghasilkan kode yang kompatibel tanpa menebak.

Peta Struktur File

Deskripsikan direktori kunci dan apa yang ada di masing-masing. Komponen, store, service, rute API, tipe. Diagram tree singkat dengan deskripsi satu baris per folder bekerja dengan baik.

Konvensi Coding

Dokumentasikan pola penamaan (camelCase untuk file, PascalCase untuk komponen), pendekatan penanganan error, urutan impor, dan aturan khusus proyek apa pun. Ini menjaga output Claude konsisten dengan kode yang sudah ada.

Perintah Build dan Test

Sertakan perintah dev, build, test, dan lint Anda. Saat Claude perlu memverifikasi sesuatu berfungsi atau menyarankan skrip, ia akan menggunakan perintah yang tepat yang diharapkan proyek Anda.

Petunjuk Peran Agen

Jika Anda menggunakan beberapa agen (QA, frontend, backend, DevOps), tambahkan bagian yang mendeskripsikan apa yang harus difokuskan setiap peran. Ini sangat berguna dengan pengaturan multi-agen AgentsRoom.

Area yang Harus Dihindari

Beri tahu Claude apa yang TIDAK harus dilakukan. Jangan modifikasi file konfigurasi, jangan ubah sistem auth, jangan refaktor lapisan database. Batasan eksplisit mencegah agen melakukan perubahan yang tidak diinginkan.

Bangun CLAUDE.md dalam 4 Langkah

Anda tidak perlu menulis segalanya sekaligus. Mulai dengan dasar-dasar dan perluas seiring Anda menemukan apa yang perlu diketahui Claude.

1

Audit Proyek Anda

Buka package.json dan daftarkan setiap framework, library, dan alat yang digunakan proyek Anda. Catat versinya. Periksa persyaratan runtime (versi Node, versi Python, database). Ini menjadi bagian tech stack Anda.

package.json + versi runtime + database

2

Petakan File Tree Anda

Jalankan tree cepat dari direktori src Anda. Identifikasi folder level atas dan tulis deskripsi satu baris untuk masing-masing. Fokus pada lokasi komponen, store, service, tipe, dan rute API.

Pohon src/ dengan anotasi tujuan

3

Dokumentasikan Konvensi Anda

Lihat kode yang sudah ada dan catat polanya: cara Anda menamai file, cara menangani error, cara menstrukturkan impor, apakah Anda menggunakan default atau named export. Tuliskan sebagai aturan singkat.

Penamaan, impor, penanganan error, export

4

Tambahkan Bagian Khusus Agen

Jika Anda bekerja dengan agen spesialis, tambahkan area fokus untuk setiap peran. Agen frontend harus mengetahui library komponen Anda. Agen DevOps harus mengetahui pipeline deployment Anda. Agen QA harus mengetahui framework pengujian Anda.

Area fokus per peran + area yang harus dihindari

Mengapa AgentsRoom untuk CLAUDE.md?

AgentsRoom dibangun di sekitar CLAUDE.md sebagai konsep kelas satu, bukan renungan belakangan.

Editor CLAUDE.md Bawaan

Edit CLAUDE.md Anda langsung di dalam AgentsRoom dengan penyorotan sintaksis dan penyimpanan langsung. Tidak perlu beralih ke editor teks atau IDE.

Pratinjau Langsung per Agen

Lihat bagaimana setiap agen menginterpretasikan CLAUDE.md Anda secara real-time. Perhatikan output terminal untuk memverifikasi bahwa agen mengikuti konvensi dan menghormati area yang harus dihindari.

Konteks per Proyek

Setiap proyek di AgentsRoom memiliki CLAUDE.md sendiri. Beralih antara proyek dan setiap agen secara otomatis memuat file konteks yang tepat untuk codebase tersebut.

Integrasi Peran Agen

14 peran agen AgentsRoom dipasangkan langsung dengan bagian-bagian CLAUDE.md. Definisikan area fokus dan area yang harus dihindari per peran, dan setiap agen mengambil instruksi yang dimaksudkan untuknya.

FAQ CLAUDE.md

Di mana saya harus menempatkan file CLAUDE.md?+
Tempatkan di root direktori proyek Anda, di samping package.json atau file konfigurasi setara. Claude Code membacanya secara otomatis saat memulai sesi di direktori tersebut. Anda juga dapat memiliki file CLAUDE.md bersarang di subdirektori untuk konteks yang lebih spesifik.
Seberapa panjang seharusnya file CLAUDE.md?+
Tidak ada batas yang ketat, tetapi usahakan 50 hingga 300 baris. Cakup hal-hal penting: tech stack, struktur file, konvensi, dan perintah. Terlalu pendek dan Claude kekurangan konteks. Terlalu panjang dan Anda berisiko mengencerkan bagian penting dengan kebisingan.
Apakah CLAUDE.md bekerja dengan semua model Claude?+
Ya. CLAUDE.md dibaca oleh Claude Code terlepas dari model yang Anda pilih (Opus, Sonnet, atau Haiku). Semua model mendapat manfaat dari konteks proyek yang eksplisit, meskipun model yang lebih besar seperti Opus dapat menyerap dan menerapkan instruksi yang lebih detail.
Haruskah saya meng-commit CLAUDE.md ke version control?+
Ya, untuk instruksi proyek bersama. Tim Anda mendapat manfaat dari perilaku AI yang konsisten di semua developer. Untuk preferensi pribadi, AgentsRoom mendukung konfigurasi agen personal yang secara otomatis di-gitignore.
Bisakah saya menggunakan CLAUDE.md dengan pengaturan multi-agen?+
Tentu saja. Di AgentsRoom, setiap agen dalam proyek Anda membaca CLAUDE.md yang sama. Anda dapat menambahkan bagian khusus peran (misalnya, catatan untuk agen QA vs. agen frontend) sehingga setiap spesialis mendapat instruksi yang ditargetkan.
Seberapa sering saya harus memperbarui CLAUDE.md?+
Perbarui setiap kali struktur atau konvensi proyek Anda berubah. Menambahkan framework baru? Perbarui tech stack. Pindah ke tata letak direktori baru? Perbarui peta file. CLAUDE.md yang usang menghasilkan saran yang usang.

Mulai Menulis File CLAUDE.md yang Lebih Baik

Unduh AgentsRoom dan gunakan editor CLAUDE.md bawaan untuk memberi agen konteks yang mereka butuhkan. Instruksi yang lebih baik, kode yang lebih baik.

GratisUnduh AgentsRoom

Aplikasi pendamping: pantau agen Anda saat bepergian

Kompatibel dengan Claude, Codex, OpenCode, Gemini CLI, dan Aider

Dapatkan ekstensi
Chrome Web Store

Kirim bug dan permintaan langsung ke backlog publik Anda.

Beberapa proyek
Multi-penyedia
Beberapa agen
Status langsung
File diff & commit
Pendamping mobile
Pratinjau langsung