Cara yang Benar untuk Menggunakan CLAUDE.md
Cara yang Benar untuk Menggunakan CLAUDE.md
CLAUDE.md adalah file khusus yang ditempatkan di direktori root proyek, digunakan untuk memberi tahu asisten AI (seperti Claude) tentang informasi penting mengenai proyek Anda. Menulis file ini dengan baik, memungkinkan AI untuk lebih memahami dan membantu Anda.
Mengapa Membutuhkan CLAUDE.md?
Bayangkan, Anda memiliki rekan kerja baru, berapa lama waktu yang Anda butuhkan agar dia memahami proyek Anda? CLAUDE.md adalah "manual proyek" itu, memungkinkan AI untuk cepat beradaptasi.
Lima Konten Inti CLAUDE.md
1. Ikhtisar Proyek
Deskripsikan secara sederhana apa yang dilakukan proyek ini, masalah apa yang dipecahkan, dan untuk pengguna mana.
# Ikhtisar Proyek Ini adalah sistem manajemen backend e-commerce, digunakan untuk mengelola produk, pesanan, dan pengguna.
2. Tumpukan Teknologi (Tech Stack)
Sebutkan teknologi dan kerangka kerja utama yang digunakan proyek.
`# Tumpukan Teknologi
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Database: PostgreSQL
- Deployment: Docker + Kubernetes`
3. Struktur File
Jelaskan fungsi direktori utama.
# Struktur File /src /components - Komponen UI /pages - Halaman /utils - Fungsi utilitas /api - Panggilan API
4. Perintah Umum
Sebutkan perintah yang umum digunakan dalam pengembangan.
# Perintah Umum npm run dev - Memulai server pengembangan npm run build - Membangun versi produksi npm run test - Menjalankan pengujian
5. Aturan
Definisikan aturan yang harus diikuti AI saat membantu Anda menulis kode.
`# Aturan Pengkodean
- Menggunakan komponen fungsional
- Mengikuti konfigurasi ESLint
- Penamaan komponen menggunakan PascalCase
- Penamaan variabel menggunakan camelCase`
Contoh Lengkap
`# Nama Proyek: Task Manager
Ikhtisar Proyek
Aplikasi manajemen tugas sederhana, mendukung pembuatan, pengeditan, penghapusan, dan kategorisasi tugas.
Tumpukan Teknologi
- React 18
- TypeScript
- Tailwind CSS
- Vite
Struktur File
/src /components - Komponen UI /hooks - Custom Hooks /types - Definisi tipe TypeScript /utils - Fungsi utilitas
Perintah Umum
- npm run dev: Memulai server pengembangan
- npm run build: Membangun versi produksi
- npm run lint: Pemeriksaan kode
Standar Pengkodean
- Komponen menggunakan gaya penulisan fungsional
- Menggunakan Tailwind CSS untuk gaya
- Setiap komponen ditempatkan dalam folder terpisah`
Tips
- Jaga agar tetap ringkas: Jangan menulis terlalu panjang, AI juga akan "lelah membaca"
- Perbarui secara berkala: Ingat untuk memperbarui CLAUDE.md saat proyek berubah
- Utamakan contoh: Memberikan contoh kode konkret lebih efektif daripada deskripsi abstrak
- Fokus pada titik kesulitan: Jelaskan secara rinci area yang rentan terhadap kesalahan
Menulis CLAUDE.md dengan baik, biarkan AI menjadi asisten Anda yang cakap!
