> For the complete documentation index, see [llms.txt](https://developer.konukcrm.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.konukcrm.com/katki/yazim-rehberi.md).

# Yazım Rehberi

## Ton

* **Doğrudan ve emir kipinde yaz.** "Token'ı yenileyin", "Token'ın yenilenmesi gerekmektedir" değil.
* **Okuyucuya sen değil siz** diye hitap et.
* **Pazarlama dili yok.** "güçlü", "sorunsuz", "kolayca" gibi sıfatlar bilgi taşımaz; sil.
* **Belirsizlik varsa yaz.** "{{X}} desteklenmiyor" demek, sessiz kalmaktan iyidir.

## Yapı

* Her sayfa **frontmatter** ile başlar: `description`.
* İlk paragraf sayfanın ne olduğunu söyler; okuyucu doğru yerde mi anlamalı.
* Başlık seviyeleri atlanmaz.
* Bir sayfa **tek bir işi** anlatır. Uzuyorsa böl.

## Rehber, referans değildir

|        | Rehber                  | Referans                    |
| ------ | ----------------------- | --------------------------- |
| Amaç   | Bir işi bitirmek        | Bir gerçeği aramak          |
| Sıra   | Adım adım               | Alfabetik / yapısal         |
| Kapsam | Mutlu yol + tuzaklar    | Tüm alanlar, tüm durumlar   |
| Örnek  | "Webhook nasıl kurulur" | "`POST /webhooks` alanları" |

Bu ikisini aynı sayfada karıştırma.

## Terminoloji

Türkçe kullan; teknik terimi ilk geçişte parantezle ver, sonra kısa formda devam et.

| Kullan                       | Kullanma                     |
| ---------------------------- | ---------------------------- |
| kiracı (tenant)              | müşteri hesabı, organizasyon |
| erişim token'ı               | jeton, anahtar               |
| uç / uç nokta (endpoint)     | servis, metot                |
| istek / yanıt                | request / response           |
| hız limiti (rate limit)      | oran sınırı                  |
| kapanış kategorisi (wrap-up) | sonuçlandırma                |
| misafir                      | müşteri, konuk               |

Ürün adları çevrilmez: **KonukCRM**, **WhatsApp Business**, **Netgsm**, **SIP Trunk**.

## Kod örnekleri

1. **Her örnek çalışmalı.** Yayınlamadan önce gerçekten çalıştır.
2. **Kopyala-yapıştıra hazır olmalı** — eksik import, uydurma değişken bırakma.
3. Doldurulacak yerler `{{süslü}}` ile işaretlenir; gerçekmiş gibi görünen sahte değer verme.
4. Kod bloğunun dil etiketini yaz: `bash`, `json`, `typescript`.
5. Yanıt örneklerini **kısalt** ama zarfı koru — `data` kırpılabilir, `success` ve `traceId` durur.
6. Gerçek kimlik bilgisi, gerçek token, gerçek müşteri adı **asla** örnekte yer almaz.

## Bağlantılar

* Bağlantı metni ne olduğunu söylesin — "buraya tıklayın" değil.
* İç bağlantılarda GitBook'un sayfa seçicisini kullan; elle URL yazma.

## Görseller

* Ekran görüntüsü ancak metin yetmiyorsa; UI değişince ilk bayatlayan şey odur.
* Her görselde `alt` metni zorunlu.
* Akış anlatımında diyagram tercih et — bakımı kolaydır.

## Yasaklar

* Doldurulmamış `{{...}}` ile yayına çıkmak
* Doğrulanmamış endpoint adı veya alan adı
* "Yakında" denip tarih verilmeyen özellik sözü


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.konukcrm.com/katki/yazim-rehberi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.