AI ile Dokümantasyon Yazımı

AI ile Dokümantasyon Yazımı Prompt Şablonları

Bu rehber, teknik dokümantasyon süreçlerinizi yapay zeka ile güçlendirmek için tasarlanmış kapsamlı prompt şablonlarını içermektedir. API dokümantasyonundan kullanıcı kılavuzlarına, README dosyalarından kod yorumlarına kadar geniş bir yelpazede kullanabileceğiniz şablonlar sunulmaktadır. Her şablon, dokümantasyon best practice kurallarına ve okunabilirlik prensiplerine uygun olarak hazırlanmıştır.

📝 Kullanım Notu: Şablonlardaki [KÖŞELİ PARANTEZ] içindeki alanları kendi projenize göre doldurun. Dokümantasyonu hedef kitlenize uygun dilde ve detay seviyesinde yazın. Güncelliği korumak için versiyon kontrolü uygulayın.

README ve Proje Dokümantasyonu

Kapsamlı README Dosyası

Açık kaynak veya internal projeler için README.

[PROJE ADI] için kapsamlı README dosyası oluştur.



PROJE BİLGİLERİ:

- Proje adı: [...]

- Proje türü: [Library / Framework / CLI tool / Web app / API / ...]

- Programlama dili: [...]

- Hedef kitle: [Geliştiriciler / Son kullanıcılar / Her ikisi]

- Lisans: [MIT / Apache / GPL / Proprietary / ...]



PROJE AÇIKLAMASI:

[Projenin ne yaptığını kısaca açıkla]



README YAPISI:



# [Proje Adı]



[Kısa ve etkileyici tek satırlık açıklama]



[Badges - build status, version, license, downloads]



## Hakkında



[2-3 paragraf proje açıklaması]



### Temel Özellikler



- [Özellik 1]

- [Özellik 2]

- [Özellik 3]

- [Özellik 4]



### Neden Bu Proje?



[Problem ve çözüm - motivasyon]



## Demo / Ekran Görüntüleri



[Görsel veya GIF]



## Hızlı Başlangıç



### Gereksinimler



- [Gereksinim 1] (versiyon)

- [Gereksinim 2] (versiyon)



### Kurulum



npm ile:

npm install [paket-adi]



veya yarn ile:

yarn add [paket-adi]



veya pip ile:

pip install [paket-adi]



### Temel Kullanım



[Minimal çalışan örnek kod]



## Dokümantasyon



Detaylı dokümantasyon için [docs klasörü / wiki / website] adresini ziyaret edin.



### API Referansı



[Temel API metodlarının kısa özeti]



### Örnekler



[examples/ klasörü veya örnek linkler]



## Konfigürasyon



[Konfigürasyon örneği]



| Parametre | Tip | Varsayılan | Açıklama |

|-----------|-----|------------|----------|

| [param1] | string | null | [açıklama] |

| [param2] | number | 10 | [açıklama] |



## Katkıda Bulunma



Katkılarınızı memnuniyetle karşılıyoruz! Lütfen CONTRIBUTING.md dosyasını inceleyin.



1. Fork edin

2. Feature branch oluşturun (git checkout -b feature/amazing-feature)

3. Commit edin (git commit -m Add amazing feature)

4. Push edin (git push origin feature/amazing-feature)

5. Pull Request açın



## Yol Haritası



- [x] [Tamamlanan özellik]

- [ ] [Planlanan özellik 1]

- [ ] [Planlanan özellik 2]



## Lisans



Bu proje [LİSANS] lisansı altında dağıtılmaktadır. Detaylar için LICENSE dosyasına bakın.



## İletişim



- Maintainer: [İsim] - [email]

- Proje Linki: [GitHub URL]



## Teşekkürler



- [Katkıda bulunanlar]

- [İlham alınan projeler]

- [Kullanılan kaynaklar]

CONTRIBUTING.md Dosyası

Açık kaynak projeler için katkı rehberi.

[PROJE ADI] için CONTRIBUTING.md dosyası oluştur.



PROJE: [...]

PROJE TÜRÜ: [...]

KOD STANDARTLARI: [...]



CONTRIBUTING.md:



# Katkıda Bulunma Rehberi



[Proje] projesine katkıda bulunmak istediğiniz için teşekkür ederiz!



## Davranış Kuralları



Bu projeye katılarak Code of Conduct kurallarını kabul etmiş olursunuz.



## Nasıl Katkıda Bulunabilirim?



### Hata Bildirimi



1. Önce mevcut issue listesini kontrol edin

2. Yeni issue açarken şu bilgileri ekleyin:

   - Hata açıklaması

   - Tekrarlama adımları

   - Beklenen davranış

   - Gerçekleşen davranış

   - Ortam bilgileri (OS, versiyon, vb.)



### Özellik Önerisi



1. Önce tartışma açın (Discussions)

2. Önerinizi detaylı açıklayın

3. Kullanım senaryoları verin



### Kod Katkısı



#### Geliştirme Ortamı Kurulumu



# Repository klonlama

git clone [repo-url]

cd [proje-adi]



# Bağımlılıkları yükleme

[paket yöneticisi] install



# Test çalıştırma

[test komutu]



#### Branch Stratejisi



- main - Production-ready kod

- develop - Geliştirme branch

- feature/* - Yeni özellikler

- bugfix/* - Hata düzeltmeleri

- hotfix/* - Acil düzeltmeler



#### Commit Mesajları



Conventional Commits formatını kullanıyoruz:



type(scope): description



[optional body]



[optional footer]



Tipler:

- feat: Yeni özellik

- fix: Hata düzeltme

- docs: Dokümantasyon

- style: Kod formatı

- refactor: Refactoring

- test: Test ekleme

- chore: Maintenance



#### Kod Standartları



- [Linter] kullanıyoruz

- [Formatter] ile formatlanmalı

- Test coverage minimum %[X]

- Tüm public API dokümante edilmeli



#### Pull Request Süreci



1. Fork ve clone

2. Branch oluştur

3. Değişikliklerini yap

4. Test ekle/güncelle

5. Lint ve test geç

6. PR aç



PR Checklist:

- [ ] Testler eklendi/güncellendi

- [ ] Dokümantasyon güncellendi

- [ ] Lint hatasız

- [ ] Commit mesajları kurallara uygun



#### Code Review



- En az 1 onay gerekli

- CI kontrolleri geçmeli

- Merge conflict çözülmeli



## Sorular?



[Tartışma platformu / Discord / Slack] üzerinden sorabilirsiniz.



Tekrar teşekkürler!