CLAUDE.md-ის სწორი გახსნის გზა

CLAUDE.md არის სპეციალური ფაილი, რომელიც პროექტის ძირეულ დირექტორიაშია მოთავსებული და ემსახურება AI ასისტენტისთვის (როგორიცაა Claude) პროექტის საკვანძო ინფორმაციის მიწოდებას. ამ ფაილის სწორად შევსება 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-ში`

სრული მაგალითი

`# პროექტის სახელი: Task Manager

პროექტის მიმოხილვა

მარტივი დავალებების მართვის აპლიკაცია, რომელიც მხარს უჭერს დავალებების შექმნას, რედაქტირებას, წაშლას და კლასიფიკაციას.

ტექნოლოგიური სტეკი

• React 18
• TypeScript
• Tailwind CSS
• Vite

ფაილის სტრუქტურა

/src /components - UI კომპონენტები /hooks - მორგებული Hooks /types - TypeScript ტიპების განსაზღვრა /utils - დამხმარე ფუნქციები

ხშირად გამოყენებული ბრძანებები

• npm run dev: განვითარების სერვერის გაშვება
• npm run build: წარმოების ვერსიის აწყობა
• npm run lint: კოდის შემოწმება

კოდირების სტანდარტები

• კომპონენტები გამოიყენეთ ფუნქციური სტილით
• გამოიყენეთ Tailwind CSS სტილისთვის
• თითოეული კომპონენტი მოათავსეთ ცალკე საქაღალდეში`

რჩევები

• შეინარჩუნეთ ლაკონურობა: არ დაწეროთ ძალიან ბევრი, AI-საც „დაეღლება“
• რეგულარულად განაახლეთ: პროექტის ცვლილებისას არ დაგავიწყდეთ CLAUDE.md-ის განახლება
• უპირატესობა მიანიჭეთ მაგალითებს: კონკრეტული კოდის მაგალითები უფრო ეფექტურია, ვიდრე აბსტრაქტული აღწერილობები
• ყურადღება მიაქციეთ პრობლემურ საკითხებს: განსაკუთრებული ყურადღება მიაქციეთ იმ ადგილებს, სადაც შეცდომების დაშვება ადვილია.

დაწერეთ კარგი CLAUDE.md და AI გახდება თქვენი შეუცვლელი დამხმარე!