CLAUDE.md యొక్క సరైన మార్గం

CLAUDE.md అనేది ప్రాజెక్ట్ యొక్క రూట్ డైరెక్టరీలో ఉంచబడిన ఒక ప్రత్యేక ఫైల్, ఇది మీ ప్రాజెక్ట్ గురించి AI సహాయకులకు (క్లాడ్ వంటివి) కీలక సమాచారాన్ని తెలియజేస్తుంది. ఈ ఫైల్‌ను సరిగ్గా వ్రాయడం ద్వారా, AI మీ ప్రాజెక్ట్‌ను బాగా అర్థం చేసుకుని మీకు సహాయపడుతుంది.

CLAUDE.md ఎందుకు అవసరం?

మీరు కొత్తగా ఒక సహోద్యోగిని నియమించుకున్నారని ఊహించుకోండి, మీ ప్రాజెక్ట్‌ను అర్థం చేసుకోవడానికి అతనికి ఎంత సమయం పడుతుంది? CLAUDE.md అనేది ఆ "ప్రాజెక్ట్ వివరణ పత్రం", ఇది AI త్వరగా పని ప్రారంభించడానికి సహాయపడుతుంది.

CLAUDE.md యొక్క ఐదు ముఖ్యమైన అంశాలు

1. ప్రాజెక్ట్ అవలోకనం

ఈ ప్రాజెక్ట్ ఏమి చేస్తుంది, ఏ సమస్యను పరిష్కరిస్తుంది మరియు ఎవరి కోసం ఉద్దేశించబడింది అనే దాని గురించి ఒక సాధారణ వివరణ.

# ప్రాజెక్ట్ అవలోకనం ఇది ఒక ఇ-కామర్స్ బ్యాకెండ్ మేనేజ్‌మెంట్ సిస్టమ్, ఇది ఉత్పత్తులు, ఆర్డర్‌లు మరియు వినియోగదారులను నిర్వహించడానికి ఉపయోగించబడుతుంది.

2. సాంకేతిక స్టాక్

ప్రాజెక్ట్ ఉపయోగించే ప్రధాన సాంకేతికతలు మరియు ఫ్రేమ్‌వర్క్‌లను జాబితా చేయండి.

`# సాంకేతిక స్టాక్

ఫ్రంటెండ్: 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 ఉపయోగించండి`

ఒక పూర్తి ఉదాహరణ

`# ప్రాజెక్ట్ పేరు: టాస్క్ మేనేజర్

ప్రాజెక్ట్ అవలోకనం

ఒక సాధారణ టాస్క్ మేనేజ్‌మెంట్ అప్లికేషన్, ఇది టాస్క్‌లను సృష్టించడం, సవరించడం, తొలగించడం మరియు వర్గీకరించడానికి మద్దతు ఇస్తుంది.

సాంకేతిక స్టాక్

React 18
TypeScript
Tailwind CSS
Vite

ఫైల్ నిర్మాణం

/src /components - UI కాంపోనెంట్స్ /hooks - కస్టమ్ హుక్స్ /types - TypeScript రకాల నిర్వచనాలు /utils - యుటిలిటీ ఫంక్షన్స్

సాధారణ ఆదేశాలు

npm run dev: అభివృద్ధి సర్వర్‌ను ప్రారంభించండి
npm run build: ఉత్పత్తి వెర్షన్‌ను నిర్మించండి
npm run lint: కోడ్ తనిఖీ

కోడింగ్ ప్రమాణాలు

కాంపోనెంట్‌లను ఫంక్షనల్ శైలిలో ఉపయోగించండి
స్టైలింగ్ కోసం Tailwind CSS ఉపయోగించండి
ప్రతి కాంపోనెంట్‌ను ప్రత్యేక ఫోల్డర్‌లో ఉంచండి`

చిట్కాలు

సంక్షిప్తంగా ఉంచండి: చాలా ఎక్కువ వ్రాయవద్దు, AI కూడా "విసిగిపోతుంది"
క్రమం తప్పకుండా నవీకరించండి: ప్రాజెక్ట్ మారినప్పుడు CLAUDE.mdని నవీకరించాలని గుర్తుంచుకోండి
ఉదాహరణలకు ప్రాధాన్యత ఇవ్వండి: నైరూప్య వివరణల కంటే నిర్దిష్ట కోడ్ ఉదాహరణలు మరింత ప్రభావవంతంగా ఉంటాయి
నొప్పి పాయింట్లపై దృష్టి పెట్టండి: సులభంగా తప్పులు జరిగే ప్రదేశాలను ప్రత్యేకంగా వివరించండి

CLAUDE.mdని సరిగ్గా వ్రాయండి, AIని మీ నమ్మకమైన సహాయకుడిగా చేసుకోండి!