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!

CHANGELOG Yazımı

Versiyon değişikliklerini belgelemek için.

[PROJE] için CHANGELOG oluştur.



MEVCUT VERSİYON: [...]

DEĞİŞİKLİKLER: [Liste halinde değişiklikler]

TARİH: [...]



CHANGELOG FORMAT:



# Changelog



Bu dosya Keep a Changelog formatını takip eder ve Semantic Versioning kullanır.



## [Unreleased]



### Eklenenler

- [Yeni özellik açıklaması]



### Değişenler

- [Değişiklik açıklaması]



### Düzeltilenler

- [Düzeltme açıklaması]



---



## [X.Y.Z] - YYYY-MM-DD



### Eklenenler

- Yeni [özellik] eklendi (#issue-no)

- [Başka özellik] desteği eklendi



### Değişenler

- [Mevcut özellik] davranışı değiştirildi

- Performans iyileştirmeleri yapıldı



### Düzeltilenler

- [Hata] düzeltildi (#issue-no)

- [Başka hata] giderildi



### Kaldırılanlar

- [Deprecated özellik] kaldırıldı



### Güvenlik

- [Güvenlik açığı] giderildi (CVE-XXXX-XXXXX)



### Deprecated

- [Özellik] deprecated olarak işaretlendi, [alternatif] kullanın



---



## [1.0.0] - YYYY-MM-DD



### İlk Sürüm

- Temel özellikler

API Dokümantasyonu Şablonları

REST API Dokümantasyonu

REST API endpoint dokümantasyonu için.

[API ADI] için REST API dokümantasyonu oluştur.



API BİLGİLERİ:

- API adı: [...]

- Base URL: [...]

- Versiyon: [...]

- Auth yöntemi: [API Key / OAuth2 / JWT / Basic]



ENDPOINT BİLGİLERİ:

- Endpoint: [...]

- Method: [GET / POST / PUT / PATCH / DELETE]

- Açıklama: [...]



API DOKÜMANTASYONU:



# [API Adı] API Dokümantasyonu



## Genel Bakış



[API hakkında kısa açıklama]



Base URL: https://api.example.com/v1



## Kimlik Doğrulama



### API Key



Authorization: Bearer YOUR_API_KEY



### OAuth 2.0



[OAuth akışı açıklaması]



## Rate Limiting



- Limit: [X] istek / [dakika/saat]

- Header: X-RateLimit-Remaining



## Hata Kodları



| Kod | Açıklama |

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

| 400 | Bad Request - Geçersiz parametre |

| 401 | Unauthorized - Kimlik doğrulama gerekli |

| 403 | Forbidden - Erişim yetkisi yok |

| 404 | Not Found - Kaynak bulunamadı |

| 429 | Too Many Requests - Rate limit aşıldı |

| 500 | Internal Server Error - Sunucu hatası |



## Endpoints



---



### [Endpoint Adı]



[Endpoint açıklaması]



Endpoint: [METHOD] /resource/{id}



Kimlik Doğrulama: Gerekli



#### Path Parameters



| Parametre | Tip | Zorunlu | Açıklama |

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

| id | string | Evet | Kaynak ID |



#### Query Parameters



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

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

| page | integer | Hayır | 1 | Sayfa numarası |

| limit | integer | Hayır | 20 | Sayfa başına kayıt |

| sort | string | Hayır | created_at | Sıralama alanı |

| order | string | Hayır | desc | asc veya desc |



#### Request Headers



| Header | Değer | Zorunlu |

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

| Authorization | Bearer {token} | Evet |

| Content-Type | application/json | Evet |

| Accept | application/json | Hayır |



#### Request Body



{

  "field1": "string (required) - Açıklama",

  "field2": "integer (optional) - Açıklama",

  "nested": {

    "subfield": "string"

  }

}



#### Response



Success (200 OK)



{

  "success": true,

  "data": {

    "id": "abc123",

    "field1": "value",

    "field2": 42,

    "created_at": "2024-01-15T10:30:00Z",

    "updated_at": "2024-01-15T10:30:00Z"

  },

  "meta": {

    "page": 1,

    "limit": 20,

    "total": 100

  }

}



Error (400 Bad Request)



{

  "success": false,

  "error": {

    "code": "VALIDATION_ERROR",

    "message": "Validation failed",

    "details": [

      {

        "field": "field1",

        "message": "Field1 is required"

      }

    ]

  }

}



#### Örnek



cURL:

curl -X POST https://api.example.com/v1/resource -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{...}"



JavaScript:

const response = await fetch(url, {

  method: "POST",

  headers: {

    "Authorization": "Bearer YOUR_API_KEY",

    "Content-Type": "application/json"

  },

  body: JSON.stringify({ field1: "value" })

});



Python:

import requests

response = requests.post(url, headers=headers, json=data)

SDK/Library Dokümantasyonu

Yazılım kütüphanesi dokümantasyonu için.

[LIBRARY ADI] için SDK dokümantasyonu oluştur.



LIBRARY: [...]

DİL: [...]

VERSİYON: [...]



SDK DOKÜMANTASYONU:



# [Library Adı] SDK



[Kısa açıklama]



## Kurulum



npm install [paket-adi]

# veya

yarn add [paket-adi]



## Hızlı Başlangıç



import { Client } from "[paket-adi]";



const client = new Client({

  apiKey: "YOUR_API_KEY"

});



// Temel kullanım örneği

const result = await client.resource.list();



## Konfigürasyon



const client = new Client({

  apiKey: "YOUR_API_KEY",      // Zorunlu

  baseUrl: "https://...",      // Opsiyonel

  timeout: 30000,              // Opsiyonel

  retries: 3,                  // Opsiyonel

  debug: false                 // Opsiyonel

});



## API Referansı



### Client



Ana client sınıfı.



#### Constructor



new Client(options: ClientOptions)



Parametreler:



| Parametre | Tip | Zorunlu | Açıklama |

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

| options.apiKey | string | Evet | API anahtarı |

| options.baseUrl | string | Hayır | Base URL |

| options.timeout | number | Hayır | Timeout (ms) |



---



### Resources



#### list(options?)



Kaynakları listeler.



const resources = await client.resources.list({

  page: 1,

  limit: 20,

  filter: { status: "active" }

});



Parametreler:



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

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

| page | number | 1 | Sayfa |

| limit | number | 20 | Limit |

| filter | object | {} | Filtreler |



Dönüş: Promise<ResourceList>



---



#### get(id)



Tek kaynak getirir.



const resource = await client.resources.get("res_123");



Parametreler:



| Parametre | Tip | Açıklama |

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

| id | string | Kaynak ID |



Dönüş: Promise<Resource>



Hatalar:

- NotFoundError - Kaynak bulunamadı



---



#### create(data)



Yeni kaynak oluşturur.



const resource = await client.resources.create({

  name: "My Resource",

  type: "standard"

});



## Hata Yönetimi



import { ApiError, NotFoundError, ValidationError } from "[paket-adi]";



try {

  await client.resources.get("invalid_id");

} catch (error) {

  if (error instanceof NotFoundError) {

    console.log("Kaynak bulunamadı");

  } else if (error instanceof ValidationError) {

    console.log("Validasyon hatası:", error.details);

  } else if (error instanceof ApiError) {

    console.log("API hatası:", error.message);

  }

}



## Troubleshooting



### Yaygın Hatalar



Connection Timeout:

Çözüm: timeout değerini artırın veya network bağlantısını kontrol edin



Rate Limit Exceeded:

Çözüm: İstek sıklığını azaltın veya retry logic ekleyin



## Destek



- GitHub Issues

- Discord

- Email: support@example.com

Kullanıcı Dokümantasyonu Şablonları

Kullanıcı Kılavuzu

Son kullanıcılar için ürün kılavuzu.

[ÜRÜN ADI] için kullanıcı kılavuzu oluştur.



ÜRÜN: [...]

HEDEF KİTLE: [Teknik olmayan kullanıcılar / Uzman kullanıcılar / Her ikisi]

PLATFORM: [Web / Mobil / Desktop / ...]



KULLANICI KILAVUZU:



# [Ürün Adı] Kullanıcı Kılavuzu



## Hoş Geldiniz



[Ürün adı] ile [ana fayda]. Bu kılavuz, [ürün] ile başlamanız ve tüm özelliklerinden yararlanmanız için ihtiyacınız olan her şeyi içerir.



## Bu Kılavuzda



1. Başlarken

2. Temel Özellikler

3. Gelişmiş Özellikler

4. Hesap Yönetimi

5. Sorun Giderme

6. SSS



---



## Başlarken



### Hesap Oluşturma



1. [website] adresine gidin

2. Kayıt Ol butonuna tıklayın

3. E-posta adresinizi girin

4. Güçlü bir şifre oluşturun

5. E-postanıza gelen doğrulama linkine tıklayın



[Ekran görüntüsü]



### İlk Giriş



1. [website] adresine gidin

2. E-posta ve şifrenizi girin

3. Giriş Yap butonuna tıklayın



İpucu: Beni hatırla seçeneğini işaretlerseniz bir sonraki girişinizde otomatik olarak giriş yapılır.



### Hızlı Tur



İlk girişinizde size ürünü tanıtan kısa bir tur sunulacaktır. Bu turu istediğiniz zaman Ayarlar - Yardım - Ürün Turu menüsünden tekrar izleyebilirsiniz.



---



## Temel Özellikler



### [Özellik 1 Adı]



[Özellik açıklaması - ne işe yarar]



Nasıl Kullanılır:



1. [Adım 1]

2. [Adım 2]

3. [Adım 3]



[Ekran görüntüsü veya GIF]



Dikkat: [Varsa uyarı]



İpuçları:

- [İpucu 1]

- [İpucu 2]



---



### [Özellik 2 Adı]



[Aynı yapıda devam]



---



## Hesap Yönetimi



### Profil Düzenleme



1. Sağ üst köşedeki profil ikonuna tıklayın

2. Profil Ayarları seçin

3. İstediğiniz bilgileri güncelleyin

4. Kaydet butonuna tıklayın



### Şifre Değiştirme



1. Ayarlar - Güvenlik menüsüne gidin

2. Şifre Değiştir butonuna tıklayın

3. Mevcut şifrenizi girin

4. Yeni şifrenizi iki kez girin

5. Güncelle butonuna tıklayın



---



## Sorun Giderme



### Giriş Yapamıyorum



Olası Nedenler:

- Yanlış e-posta veya şifre

- Hesap henüz doğrulanmamış

- Hesap askıya alınmış



Çözümler:

1. E-posta adresinizi kontrol edin

2. Şifremi Unuttum linkini kullanın

3. Spam klasörünüzde doğrulama e-postasını arayın

4. Destek ekibiyle iletişime geçin



---



## SSS



S: [Sık sorulan soru 1]?

C: [Cevap]



---



S: [Sık sorulan soru 2]?

C: [Cevap]



---



## Destek



Yardıma mı ihtiyacınız var?



- E-posta: support@example.com

- Canlı Destek: [website]/chat

- Telefon: +90 XXX XXX XX XX (Hafta içi 09:00-18:00)

- Yardım Merkezi: [website]/help

Hızlı Başlangıç Kılavuzu (Quick Start)

Kullanıcıları hızlıca başlatmak için.

[ÜRÜN] için quick start kılavuzu oluştur.



ÜRÜN: [...]

HEDEF SÜRE: [5 dakika / 10 dakika / ...]

EN ÖNEMLİ ÖZELLİK: [...]



QUICK START:



# [Ürün] Hızlı Başlangıç



5 dakikada [ürün] ile [ana fayda] elde edin.



## Adım 1: Kurulum (1 dk)



[kurulum komutu veya indirme linki]



## Adım 2: Hesap Oluşturma (1 dk)



1. Uygulamayı açın

2. Başla butonuna tıklayın

3. E-posta ile kayıt olun



## Adım 3: İlk [Nesne] Oluşturma (2 dk)



1. Yeni [Nesne] butonuna tıklayın

2. [Alan 1] girin

3. [Alan 2] seçin

4. Oluştur butonuna tıklayın



Tebrikler! İlk [nesne] oluşturuldu.



## Adım 4: [Ana Aksiyon] (1 dk)



1. [Nesne] üzerine tıklayın

2. [Aksiyon] butonuna basın

3. Sonucu görün



## Sonraki Adımlar



- Tam dokümantasyon

- Video eğitimler

- Topluluk



## Yardım Gerekli mi?



[Destek kanalları]

Kod Dokümantasyonu Şablonları

Kod Yorumları ve Docstring

Kod içi dokümantasyon standartları için.

[KOD] için dokümantasyon/yorumlar ekle.



PROGRAMLAMA DİLİ: [Python / JavaScript / Java / C# / Go / ...]

DOKÜMANTASYON STİLİ: [JSDoc / Docstring / Javadoc / XML Doc / GoDoc]



KOD:

[Dokümante edilecek kod]



DOKÜMANTASYON:



---



PYTHON (Docstring - Google Style):



def calculate_discount(price: float, discount_percent: float, max_discount: float = None) -> float:

    """Fiyata indirim uygular ve indirimli fiyatı döndürür.



    Verilen yüzde oranında indirim uygular. Opsiyonel olarak maksimum

    indirim tutarı belirlenebilir.



    Args:

        price: Orijinal fiyat (pozitif sayı olmalı).

        discount_percent: İndirim yüzdesi (0-100 arası).

        max_discount: Maksimum indirim tutarı. None ise sınır yok.



    Returns:

        İndirimli fiyat.



    Raises:

        ValueError: price negatif ise veya discount_percent 0-100 arasında değilse.



    Examples:

        >>> calculate_discount(100, 20)

        80.0

        >>> calculate_discount(100, 50, max_discount=30)

        70.0

    """

    if price < 0:

        raise ValueError("Price must be positive")

    if not 0 <= discount_percent <= 100:

        raise ValueError("Discount percent must be between 0 and 100")



    discount = price * (discount_percent / 100)

    if max_discount is not None:

        discount = min(discount, max_discount)

    

    return price - discount



---



JAVASCRIPT (JSDoc):



/**

 * Fiyata indirim uygular ve indirimli fiyatı döndürür.

 *

 * @param {number} price - Orijinal fiyat (pozitif sayı olmalı)

 * @param {number} discountPercent - İndirim yüzdesi (0-100 arası)

 * @param {Object} [options] - Opsiyonel ayarlar

 * @param {number} [options.maxDiscount] - Maksimum indirim tutarı

 * @param {boolean} [options.roundResult=true] - Sonucu yuvarla

 * @returns {number} İndirimli fiyat

 * @throws {Error} price negatif ise

 * @throws {RangeError} discountPercent 0-100 arasında değilse

 *

 * @example

 * // Basit kullanım

 * calculateDiscount(100, 20);

 * // Returns: 80

 *

 * @example

 * // Maksimum indirim ile

 * calculateDiscount(100, 50, { maxDiscount: 30 });

 * // Returns: 70

 */

function calculateDiscount(price, discountPercent, options = {}) {

  // Implementation

}



---



CLASS DOKÜMANTASYONU (Python):



class ShoppingCart:

    """Alışveriş sepeti yönetimi için sınıf.



    Bu sınıf ürün ekleme, çıkarma, toplam hesaplama ve

    indirim uygulama işlemlerini yönetir.



    Attributes:

        items: Sepetteki ürünlerin listesi.

        user_id: Sepet sahibinin kullanıcı ID si.

        created_at: Sepetin oluşturulma zamanı.



    Example:

        >>> cart = ShoppingCart(user_id="user_123")

        >>> cart.add_item(product_id="prod_1", quantity=2)

        >>> cart.get_total()

        199.98

    """



    def __init__(self, user_id: str) -> None:

        """ShoppingCart instance oluşturur.



        Args:

            user_id: Sepet sahibinin kullanıcı ID si.

        """

        self.items = []

        self.user_id = user_id

Architecture Decision Record (ADR)

Mimari kararları belgelemek için.

[KARAR KONUSU] için ADR oluştur.



KARAR: [...]

TARİH: [...]

DURUM: [Proposed / Accepted / Deprecated / Superseded]



ADR FORMAT:



# ADR [Numara]: [Başlık]



## Durum



[Proposed | Accepted | Deprecated | Superseded by ADR-XXX]



## Bağlam



[Kararın alınmasını gerektiren durum ve koşullar]



- Mevcut durum nedir?

- Hangi problemi çözmeye çalışıyoruz?

- Hangi kısıtlamalar var?

- Hangi gereksinimler karşılanmalı?



## Karar



[Alınan karar ve detayları]



[Seçilen çözüm] kullanacağız.



## Gerekçe



Neden bu karar alındı:



- [Gerekçe 1]

- [Gerekçe 2]

- [Gerekçe 3]



### Değerlendirilen Alternatifler



Alternatif 1: [İsim]

- Artıları: [...]

- Eksileri: [...]

- Neden seçilmedi: [...]



Alternatif 2: [İsim]

- Artıları: [...]

- Eksileri: [...]

- Neden seçilmedi: [...]



## Sonuçlar



### Olumlu



- [Olumlu sonuç 1]

- [Olumlu sonuç 2]



### Olumsuz



- [Olumsuz sonuç / trade-off 1]

- [Olumsuz sonuç / trade-off 2]



### Riskler



- [Risk 1]: [Mitigasyon]

- [Risk 2]: [Mitigasyon]



## Uygulama Notları



[Kararın nasıl uygulanacağına dair notlar]



## İlişkili Kararlar



- ADR-XXX: [İlişkili karar]



## Referanslar



- [Referans 1]

- [Referans 2]



---



Karar Tarihi: [YYYY-MM-DD]

Karar Veren: [İsim/Ekip]

Son Güncelleme: [YYYY-MM-DD]

Süreç Dokümantasyonu Şablonları

Runbook / Operasyon Kılavuzu

Operasyonel prosedürler için.

[SİSTEM/SÜREÇ] için runbook oluştur.



SİSTEM: [...]

HEDEF KİTLE: [DevOps / SRE / On-call engineer]

KRİTİKLİK: [Kritik / Yüksek / Orta / Düşük]



RUNBOOK:



# [Sistem/Süreç] Runbook



## Genel Bakış



Sistem: [Sistem adı]

Sahip: [Ekip/Kişi]

Son Güncelleme: [Tarih]

Kritiklik: [Seviye]



### Sistem Hakkında



[Sistemin ne yaptığı, önemi]



### Bağımlılıklar



- [Bağımlılık 1]: [Açıklama]

- [Bağımlılık 2]: [Açıklama]



### İletişim



| Rol | İsim | İletişim |

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

| Primary On-call | [İsim] | [Telefon/Slack] |

| Secondary | [İsim] | [Telefon/Slack] |

| Manager | [İsim] | [Telefon/Slack] |



---



## Alert Playbook



### [ALERT-001] [Alert Adı]



Severity: [Critical/Warning/Info]

Threshold: [Eşik değeri]



#### Bu Ne Anlama Geliyor?



[Alert in anlamı]



#### Etki



[Kullanıcı/sistem etkisi]



#### Hızlı Tanı



# Log kontrol

kubectl logs -n [namespace] [pod-name] --tail=100



# Metrik kontrol

curl http://[prometheus]/api/v1/query?query=[metric_name]



#### Çözüm Adımları



1. İlk değerlendirme (2 dk)

   - [ ] Dashboard kontrol et: [link]

   - [ ] Son deployment var mı kontrol et

   - [ ] Bağımlı servislerin durumunu kontrol et



2. Yaygın nedenler ve çözümler



   Neden A: [Neden]

   Tanı komutu: [komut]

   Çözüm: [çözüm komutu]



   Neden B: [Neden]

   Tanı komutu: [komut]

   Çözüm: [çözüm komutu]



3. Eskalasyon (15 dk sonra çözülmediyse)

   - [Kime] eskalasyon yap

   - [Kanal] üzerinden bilgilendir



#### Rollback Prosedürü



# Son stable versiyona rollback

kubectl rollout undo deployment/[name] -n [namespace]



# Belirli versiyona rollback

kubectl rollout undo deployment/[name] --to-revision=[X]



---



## Rutin İşlemler



### Günlük Kontroller



- [ ] Dashboard kontrol

- [ ] Error rate normal seviyede

- [ ] Disk kullanımı yüzde [X] altında

- [ ] Backup başarılı



### Haftalık İşlemler



- [ ] Log rotation kontrolü

- [ ] Sertifika süreleri kontrolü

- [ ] Kapasite planlama review



---



## Disaster Recovery



### RTO/RPO



- RTO (Recovery Time Objective): [X saat]

- RPO (Recovery Point Objective): [X saat]



### Backup Lokasyonları



| Veri | Lokasyon | Sıklık | Retention |

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

| Database | [S3/GCS path] | Saatlik | 30 gün |

| Config | [Git repo] | Her commit | Forever |



### Recovery Prosedürü



[Adım adım recovery prosedürü]



---



## Faydalı Komutlar



# Pod durumu

kubectl get pods -n [namespace]



# Loglar

kubectl logs -f [pod] -n [namespace]



# Restart

kubectl rollout restart deployment/[name] -n [namespace]



# Scale

kubectl scale deployment/[name] --replicas=[X] -n [namespace]



## Faydalı Linkler



- Dashboard: [link]

- Metrics: [link]

- Logs: [link]

- Wiki: [link]

Onboarding Dokümantasyonu

Yeni ekip üyeleri için teknik onboarding.

[EKİP/PROJE] için developer onboarding dokümantasyonu oluştur.



EKİP: [...]

PROJE: [...]

TEKNOLOJİ STACK: [...]



ONBOARDING:



# [Ekip/Proje] Developer Onboarding



Hoş geldin! Bu doküman seni hızlıca ekibe katılmana yardımcı olacak.



## İlk Gün



### Erişim ve Hesaplar



| Sistem | Nasıl Erişilir | Kimin Vermesi Gerekiyor |

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

| GitHub | [link] - IT ticket | IT |

| AWS Console | [link] - Manager onayı | DevOps |

| Slack | [link] | Otomatik |

| Jira | [link] | Manager |



### Geliştirme Ortamı Kurulumu



#### Gereksinimler



- OS: [macOS / Linux / Windows + WSL2]

- RAM: Minimum 16GB

- Disk: Minimum 50GB boş alan



#### Kurulum Adımları



# 1. Homebrew (macOS)

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"



# 2. Gerekli araçlar

brew install git node python docker



# 3. Repo klonlama

git clone [repo-url]

cd [repo-name]



# 4. Dependencies

npm install  # veya yarn, pip, vb.



# 5. Environment setup

cp .env.example .env

# .env dosyasını düzenle



# 6. Database setup

docker-compose up -d db

npm run db:migrate

npm run db:seed



# 7. Uygulamayı başlat

npm run dev



#### IDE Kurulumu



VS Code Önerilen Extension lar:

- [Extension 1]

- [Extension 2]

- [Extension 3]



### Test Etme



# Unit testler

npm test



# Integration testler

npm run test:integration



# Tüm testler

npm run test:all



---



## İlk Hafta



### Mimariyi Tanı



- [ ] Architecture dokümanı oku

- [ ] Sistem diyagramı incele

- [ ] ADR lar gözden geçir



### Kod Tabanını Tanı



- [ ] Klasör yapısını anla

- [ ] Temel modülleri incele

- [ ] Test yapısını incele



### İlk Görev



İlk hafta için good first issue etiketli bir issue seç.



### Pair Programming



[Mentor ismi] ile pair programming seansı ayarla.



---



## İlk Ay



### Öğrenilecekler



- [ ] CI/CD pipeline

- [ ] Deployment süreci

- [ ] Monitoring ve alerting

- [ ] On-call prosedürleri



### Okunacak Dokümanlar



1. Coding standartları

2. Code review guidelines

3. Git workflow

4. Security practices



### Tanışılacak Kişiler



| Kişi | Rol | Konu |

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

| [İsim] | Tech Lead | Mimari sorular |

| [İsim] | Senior Dev | Kod soruları |

| [İsim] | DevOps | Infra soruları |

| [İsim] | Product | Ürün soruları |



---



## Referanslar



### Slack Kanalları



- #[team]-general: Genel tartışmalar

- #[team]-dev: Teknik tartışmalar

- #[team]-alerts: Sistem alertleri



### Faydalı Linkler



- Wiki: [link]

- Jira Board: [link]

- Confluence: [link]

- Runbook: [link]



### Düzenli Toplantılar



| Toplantı | Gün/Saat | Link |

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

| Daily Standup | Her gün 10:00 | [link] |

| Sprint Planning | Pazartesi 14:00 | [link] |

| Retro | Cuma 16:00 | [link] |



---



## Sorular?



Mentor: [İsim] - [Slack handle]



Herhangi bir sorun olursa çekinme!

Dokümantasyon İpuçları

Genel İlkeler:

• Hedef kitlenizi tanıyın ve onlara göre yazın
• Basit ve anlaşılır dil kullanın
• Örneklerle destekleyin
• Güncel tutun - stale docs zararlıdır
• Aranabilir ve navigasyonu kolay olsun

README Yazarken:

• 5 dakikada projeyi anlat
• Copy-paste yapılabilir örnekler ver
• Kurulum adımları net olsun
• Katkı kurallarını belirt
• Lisans ve iletişim bilgisi ekle

API Dokümantasyonu:

• Her endpoint dokümante edilmeli
• Request/Response örnekleri şart
• Hata kodlarını açıkla
• Authentication detaylı anlatılmalı
• Rate limiting bilgisi ver

Kod Dokümantasyonu:

• Public API mutlaka dokümante edilmeli
• Neden yapıldığını açıkla (ne değil)
• Karmaşık algoritmalarda detay ver
• Edge case uyarıları ekle
• Örnekler faydalıdır

AI Kullanırken:

• AI ile taslak oluştur, sonra düzenle
• Teknik doğruluğu mutlaka kontrol et
• Proje context ini ver
• Stil ve ton tutarlılığını koru
• Hassas bilgileri paylaşma