CLAUDE.md-യുടെ ശരിയായ ഉപയോഗരീതി

CLAUDE.md എന്നത് നിങ്ങളുടെ പ്രോജക്റ്റിനെക്കുറിച്ചുള്ള പ്രധാന വിവരങ്ങൾ AI അസിസ്റ്റന്റിന് (Claude പോലുള്ളവ) നൽകുന്നതിന് വേണ്ടി പ്രോജക്റ്റിന്റെ റൂട്ട് ഡയറക്ടറിയിൽ വെക്കുന്ന ഒരു പ്രത്യേക ഫയലാണ്. ഈ ഫയൽ നന്നായി എഴുതിയാൽ, AI-ക്ക് നിങ്ങളുടെ പ്രോജക്റ്റ് നന്നായി മനസ്സിലാക്കാനും നിങ്ങളെ സഹായിക്കാനും കഴിയും.

CLAUDE.md എന്തിനാണ്?

നിങ്ങളുടെ ടീമിലേക്ക് ഒരു പുതിയ അംഗം വരുമ്പോൾ, നിങ്ങളുടെ പ്രോജക്റ്റ് മനസ്സിലാക്കാൻ എത്ര സമയം എടുക്കുമെന്ന് ഒന്ന് ചിന്തിച്ചു നോക്കൂ. CLAUDE.md എന്നത് AI-യെ പെട്ടെന്ന് കാര്യങ്ങൾ ഗ്രഹിക്കാൻ സഹായിക്കുന്ന ഒരു "പ്രോജക്റ്റ് മാനുവൽ" പോലെയാണ്.

CLAUDE.md-യിലെ അഞ്ച് പ്രധാന കാര്യങ്ങൾ

1. പ്രോജക്റ്റ് അവലോകനം

ഈ പ്രോജക്റ്റ് എന്താണ് ചെയ്യുന്നത്, എന്ത് പ്രശ്നമാണ് പരിഹരിക്കുന്നത്, ആർക്കുവേണ്ടിയാണ് ഇത് ഉണ്ടാക്കിയിരിക്കുന്നത് എന്നതിനെക്കുറിച്ച് ലളിതമായി വിവരിക്കുക.

# പ്രോജക്റ്റ് അവലോകനം ഇതൊരു ഇ-കൊമേഴ്സ് ബാക്കെൻഡ് മാനേജ്മെന്റ് സിസ്റ്റമാണ്. ഇത് ഉൽപ്പന്നങ്ങൾ, ഓർഡറുകൾ, ഉപയോക്താക്കൾ എന്നിവ കൈകാര്യം ചെയ്യാൻ ഉപയോഗിക്കുന്നു.

2. സാങ്കേതിക സ്റ്റാക്ക്

പ്രോജക്റ്റിൽ ഉപയോഗിച്ചിരിക്കുന്ന പ്രധാന സാങ്കേതികവിദ്യകളും ചട്ടക്കൂടുകളും (Frameworks) ലിസ്റ്റ് ചെയ്യുക.

`# സാങ്കേതിക സ്റ്റാക്ക്

• ഫ്രണ്ട്എൻഡ്: 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 - ഇഷ്ടമുള്ള Hook-കൾ /types - TypeScript ടൈപ്പ് നിർവചനങ്ങൾ /utils - യൂട്ടിലിറ്റി ഫംഗ്ഷനുകൾ

സാധാരണയായി ഉപയോഗിക്കുന്ന കമാൻഡുകൾ

• npm run dev: ഡെവലപ്മെന്റ് സെർവർ ആരംഭിക്കുക
• npm run build: പ്രൊഡക്ഷൻ പതിപ്പ് നിർമ്മിക്കുക
• npm run lint: കോഡ് പരിശോധന

കോഡിംഗ് രീതി

• ഫങ്ഷണൽ രീതിയിൽ കോമ്പോണന്റുകൾ എഴുതുക
• Tailwind CSS ഉപയോഗിച്ച് സ്റ്റൈൽ ചെയ്യുക
• ഓരോ കോമ്പോണന്റും പ്രത്യേകം ഫോൾഡറുകളിൽ വെക്കുക`

ചെറിയ ടിപ്പുകൾ

• ലളിതമായി എഴുതുക: ഒരുപാട് എഴുതി വലുതാക്കരുത്, AI-ക്ക് മടുപ്പ് വരും.
• പതിവായി പുതുക്കുക: പ്രോജക്റ്റിൽ മാറ്റങ്ങൾ വരുമ്പോൾ CLAUDE.md അപ്ഡേറ്റ് ചെയ്യാൻ ഓർക്കുക.
• ഉദാഹരണങ്ങൾക്ക് മുൻഗണന നൽകുക:abstract ആയി വിവരിക്കുന്നതിനേക്കാൾ നല്ലത് code ഉദാഹരണങ്ങൾ നൽകുന്നതാണ്.
• പ്രശ്നങ്ങളെക്കുറിച്ച് ശ്രദ്ധിക്കുക: തെറ്റുകൾ വരാൻ സാധ്യതയുള്ള കാര്യങ്ങൾ എടുത്തുപറയുക.

നന്നായി CLAUDE.md എഴുതി AI-യെ നിങ്ങളുടെ നല്ലൊരു സഹായി ആക്കുക!