Njia Sahihi ya Kutumia CLAUDE.md
Njia Sahihi ya Kutumia CLAUDE.md
CLAUDE.md ni faili maalum iliyowekwa kwenye mizizi ya mradi, inayotumika kumweleza msaidizi wa AI (kama vile Claude) kuhusu taarifa muhimu za mradi wako. Kuandika faili hii vizuri, kunaweza kumsaidia AI kuelewa na kukusaidia vyema.
Kwa nini unahitaji CLAUDE.md?
Wazia, umepata mfanyakazi mpya, utahitaji muda gani kumfanya aelewe mradi wako? CLAUDE.md ni kama "mwongozo wa mradi", unaomsaidia AI kuanza haraka.
Maudhui Makuu Matano ya CLAUDE.md
1. Muhtasari wa Mradi
Eleza kwa ufupi mradi huu unafanya nini, unatatua tatizo gani, na unawalenga watumiaji gani.
# Muhtasari wa Mradi Huu ni mfumo wa usimamizi wa nyuma wa duka la mtandaoni, unaotumika kusimamia bidhaa, maagizo na watumiaji.
2. Mrundiko wa Teknolojia (Tech Stack)
Orodhesha teknolojia na mifumo mikuu inayotumika katika mradi.
`# Mrundiko wa Teknolojia
- Upande wa mbele: React + TypeScript
- Upande wa nyuma: Node.js + Express
- Hifadhidata: PostgreSQL
- Usambazaji: Docker + Kubernetes`
3. Muundo wa Faili
Eleza kazi za saraka kuu.
# Muundo wa Faili /src /components - Vipengele vya UI /pages - Kurasa /utils - Vitendaji vya matumizi /api - Simu za API
4. Amri Zinazotumiwa Mara kwa Mara
Orodhesha amri zinazotumiwa mara kwa mara katika maendeleo.
# Amri Zinazotumiwa Mara kwa Mara npm run dev - Anzisha seva ya maendeleo npm run build - Tengeneza toleo la uzalishaji npm run test - Endesha majaribio
5. Kanuni
Fafanua kanuni ambazo AI inapaswa kufuata wakati inakusaidia kuandika msimbo.
`# Kanuni za Usimbaji
- Tumia vipengele vya kazi
- Fuata usanidi wa ESLint
- Tumia PascalCase kwa majina ya vipengele
- Tumia camelCase kwa majina ya vigezo`
Mfano Kamili
`# Jina la Mradi: Task Manager
Muhtasari wa Mradi
Programu rahisi ya usimamizi wa kazi, inayounga mkono uundaji, uhariri, ufutaji na uainishaji wa kazi.
Mrundiko wa Teknolojia
- React 18
- TypeScript
- Tailwind CSS
- Vite
Muundo wa Faili
/src /components - Vipengele vya UI /hooks - Hooks Maalum /types - Ufafanuzi wa Aina za TypeScript /utils - Vitendaji vya matumizi
Amri Zinazotumiwa Mara kwa Mara
- npm run dev: Anzisha seva ya maendeleo
- npm run build: Tengeneza toleo la uzalishaji
- npm run lint: Angalia msimbo
Kanuni za Usimbaji
- Tumia uandishi wa kazi kwa vipengele
- Tumia Tailwind CSS kwa mitindo
- Weka kila kipengele kwenye folda tofauti`
Vidokezo
- Kuwa mfupi: Usiandike mrefu sana, AI pia "itachoka"
- Sasisha mara kwa mara: Kumbuka kusasisha CLAUDE.md wakati mradi unabadilika
- Tanguliza mifano: Kutoa mifano maalum ya msimbo ni bora kuliko maelezo ya dhahania
- Zingatia maeneo yenye matatizo: Eleza kwa kina maeneo ambayo yana uwezekano wa kukosewa
Andika CLAUDE.md vizuri, na umfanye AI kuwa msaidizi wako mkuu!
