README და დოკუმენტაციის პრომპტი

კარგი README პროექტს გამოსაყენებელს ხდის სხვებისთვისაც და მომავალში თქვენთვისაც. ეს პრომპტი გიმზადებთ სტრუქტურირებულ დოკუმენტაციას თქვენი კოდისა და აღწერის საფუძველზე.

პრომპტი
დამიწერე README.md ფაილი ჩემი პროექტისთვის.

პროექტის სახელი: [სახელი]
რას აკეთებს: [აღწერა]
ვისთვისაა: [მომხმარებლები / დეველოპერები]
ტექნოლოგიები: [ენა, ფრეიმვორკი, დამოკიდებულებები]
როგორ ინსტალირდება: [ბრძანებები, თუ იცით]
როგორ გამოიყენება: [მაგალითები]
კონფიგურაცია: [გარემოს ცვლადები, პარამეტრები]

პროექტის სტრუქტურა ან მთავარი ფაილები (არასავალდებულო):
```
[ჩასვი ფაილების ხე ან მთავარი კოდი]
```

სტრუქტურა:
1. სახელი და მოკლე აღწერა (1–2 წინადადება);
2. მთავარი შესაძლებლობები;
3. მოთხოვნები;
4. ინსტალაცია (ნაბიჯ-ნაბიჯ, ბრძანებებით);
5. გამოყენება (მაგალითებით);
6. კონფიგურაცია;
7. პროექტის სტრუქტურა;
8. ლიცენზია.

ენა: [ქართული / ინგლისური]. ფორმატი: Markdown.

როგორ გამოვიყენოთ

  1. დააკოპირეთ პრომპტი ღილაკით „კოპირება“.
  2. ჩასვით ChatGPT-ში, Claude-ში ან Gemini-ში.
  3. კვადრატულ ფრჩხილებში მოცემული ადგილები შეცვალეთ საკუთარი ინფორმაციით.
  4. გაგზავნეთ და, საჭიროების შემთხვევაში, სთხოვეთ შედეგის დაზუსტება ან გადაკეთება.

რჩევები უკეთესი შედეგისთვის

ხშირად დასმული კითხვები

რა არის Markdown?

Markdown არის მარტივი ფორმატირების ენა, რომლითაც ტექსტს სათაურებს, სიებს, ბმულებსა და კოდის ბლოკებს უმატებთ. GitHub და სხვა პლატფორმები README.md ფაილს ავტომატურად ფორმატირებულად აჩვენებს.

მსგავსი პრომპტები