API/SDK Dokümantasyon Çevirisi ve Lokalizasyon Süreçleri

API/SDK Dokümantasyon Çevirisi Nedir?

Örnek Senaryo

Japonya pazarına açılan bir finansal teknoloji (FinTech) şirketi, ödeme geçidi API'sini Japoncaya çevirmektedir.

Çevirmen, amount parametresini ve /v1/payments endpoint'ini çevirmeden bırakır, ancak bu parametrenin "kuruş cinsinden işlem tutarını belirttiği" açıklamasını Japoncaya (developer docs standartlarına uygun olarak) kusursuz şekilde aktarır.

Başlangıç Kontrol Listesi:

  • [ ] Hedef dildeki geliştirici kitlesinin (DevRel) teknik seviyesinin belirlenmesi.
  • [ ] Çevrilecek ve çevrilmeyecek yapıların (Translatability Rules) sisteme tanımlanması.
  • [ ] Orijinal metnin (source text) güncelliğinin teyit edilmesi.

API ve SDK Dokümantasyonları Arasındaki Farklar Nelerdir?

API (Application Programming Interface) dokümantasyonu, sistemlerin birbiriyle nasıl iletişim kuracağını, HTTP isteklerini ve dönen yanıt (response) yapılarını bağımsız bir şekilde açıklar.

SDK (Software Development Kit) dokümantasyonu ise, bu API'leri belirli bir programlama dilinde (örneğin Java, Python) daha kolay kullanmak için sunulan hazır kütüphanelerin, fonksiyonların ve kurulum adımlarının çevirisini kapsar.

API evrensel bir sözleşme iken, SDK o sözleşmeyi uygulamaya koyan dile özgü bir alet çantasıdır.

Mini Karşılaştırma Kutusu (AWS Referanslı Standart Yapı):

Özellik API Dokümantasyonu SDK Dokümantasyonu
Odak İstek/Yanıt formatı, Endpoint, Yetkilendirme Kurulum, Sınıflar (Classes), Metodlar, Hata Yakalama (Exception)
Dil Bağımlılığı Yok (Genellikle HTTP/REST/GraphQL) Yüksek (Python, Node.js, Go vb. özelinde)
Çeviri Riski JSON yapılarının ve parametrelerin bozulması Dile özgü fonksiyon isimlerinin (camelCase vb.) çevrilmesi

API Dokümantasyonu Çevirisinde En Sık Yapılan 10 Hata

Teknik çevirilerde en sık karşılaşılan hatalar genellikle eksik terminoloji yönetimi ve kod yapılarının ayrıştırılamamasından (parsing) kaynaklanır.

Endpoint'lerin çevrilmesi, JSON anahtarlarının lokalize edilmesi veya kod içi string değerlerinin değiştirilmesi, API'nin çalışmamasına (entegrasyon kırılmalarına) yol açar.

Bu hataların önüne geçmek için önceden tanımlanmış kurallara dayalı "korumalı etiket (protected tag)" sistemleri kullanılmalıdır.

Hata Analizi ve Doğru Yaklaşım:

Hata Etkisi (Risk) Doğru Yaklaşım Mini Örnek
1. Endpoint'lerin çevrilmesi 404 Not Found hatası. İstek hedefe ulaşmaz. Path'ler dokunulmaz kabul edilir. /kullanici-getir YANLIŞ, /get-user DOĞRU.
2. JSON Key çevirisi Payload parse edilemez. Sadece value (değer) çevrilebilir (eğer literal değilse). "renk": "mavi" YANLIŞ, "color": "mavi" DOĞRU.
3. Parametre isimlerinin çevrilmesi 400 Bad Request hatası. Query veya Body parametreleri korunur. siralama=desc YANLIŞ, sort=desc DOĞRU.
4. Enum değerlerinin çevrilmesi Veritabanı kayıt veya validasyon hatası. API'nin beklediği sabit değerler çevrilmez. Durum: BEKLEYEN YANLIŞ, Durum: PENDING DOĞRU.
5. Header tanımlarının çevrilmesi Yetkilendirme veya içerik tipi hatası. Standart ve custom header'lar orijinal bırakılır. İçerik-Tipi: ... YANLIŞ, Content-Type: ... DOĞRU.
6. Placeholder bozulması Kodun çalışma zamanında değişkeni bulamaması. Değişken formatı ({id}, %s) korunmalıdır. Merhaba %s DOĞRU, Merhaba % s YANLIŞ.
7. Kod bloklarının lokalize edilmesi Copy-paste ile çalışan örneklerin kırılması. <code> veya markdown blokları izole edilir. İstek gövdesi tamamen orijinal dilde bırakılır.
8. Boolean değerlerin çevrilmesi Mantıksal (logic) hatalar. true/false literal olarak kalmalıdır. is_active: dogru YANLIŞ, is_active: true DOĞRU.
9. Yorum satırlarında kod referanslarının çevrilmesi Geliştiricinin referans edilen fonksiyonu bulamaması. Yorum çevrilse de metod isimleri korunur. createOrder fonksiyonunu çağırır. DOĞRU.
10. Aşırı resmi/edebi dil kullanımı Anlaşılırlığın düşmesi (Kötü DX). Direkt, etken (aktif) ve teknik bir üslup kullanılır. "Veri sağlanmaktadır" YANLIŞ, "Veriyi döndürür" DOĞRU.
Hatalı kod bloğu ve başarıyla çevrilmiş API dokümantasyonu karşılaştırması

Swagger/OpenAPI Dokümantasyonlarında Çeviri Yaklaşımı

OpenAPI (eski adıyla Swagger) dokümantasyonları, makine tarafından okunabilen JSON veya YAML formatındaki yapılandırılmış dosyalardır.

Bu dosyaların çevirisinde "single source of truth" (tek doğruluk kaynağı) prensibi esastır; dosyanın teknik iskeleti asla değiştirilmez.

Yalnızca insanların okuması için tasarlanmış summary, description ve uyarı mesajı (error message) alanları CAT (Bilgisayar Destekli Çeviri) araçları yardımıyla güvenli bir şekilde filtrelenip çevrilir.

OpenAPI Çeviri Döngüsü (En İyi Uygulamalar)
  1. Ayrıştırma (Parsing): YAML/JSON dosyası, çeviri sistemine aktarılırken components, paths, schemas gibi yapısal anahtarlar gizlenir.
  2. Lokalizasyon: Yalnızca description ve örnek açıklamaları hedeflenir.
  3. Yeniden İnşa (Reconstruction): Çevrilen metinler orijinal YAML/JSON hiyerarşisine enjekte edilir.
  4. Doğrulama (Validation): Ortaya çıkan dosya, OpenAPI linter (örn: Spectral) araçlarından geçirilerek syntax hatası olup olmadığı teyit edilir.

Yazılım Lokalizasyonu: Bağlam, Sahte Yerelleştirme ve String Testleri

Kritik Kavramlar ve Test Süreçleri
  • Bağlam (Context) Sağlama: Metin anahtarının nerede kullanıldığını gösteren ekran görüntüleri (screenshot) veya metadata eklenmesi. btn_book anahtarının "Kitap" mı yoksa "Rezervasyon yap" mı olduğunu netleştirir.
  • Pseudolocalization: İngilizce bir metnin, hedef dildeki ortalama uzama oranına (genellikle %20-%30) göre yapay karakterlerle uzatılması işlemidir. (Örn: Account -> [!!! Àççôûñţ !!!]). Bu, butonların taşıp taşmadığını test eder.
  • String Genişlemesi (Expansion) Riski: Özellikle mobil SDK dokümantasyonlarında ve mobil UI ekranlarında, kısa İngilizce kelimelerin Almanca veya Rusça gibi dillerde 2-3 kat uzaması ekran tasarımlarını bozabilir.

Glossary ve Style Guide ile Tutarlılık

Teknik çeviri projelerinde terimce (glossary) ve stil rehberi (style guide) kullanımı, marka sesinin ve teknik doğruluğun korunması için vazgeçilmezdir.

Style guide; aktif/pasif ses kullanımını, tarih/saat formatlarını ve hitap şeklini belirlerken; glossary, ürüne özgü fonksiyon adlarının veya sektörel terimlerin dilden dile nasıl aktarılacağını standartlaştırır.

Bu araçlar, geliştirici kitlesinin bilişsel yükünü azaltır.

Glossary & Kural Seti:

İngilizce Terim Hedef Türkçe Terim Kural / Not (Style Guide)
Deploy Dağıtmak (veya Deploy etmek) Şirket tercihine göre belirlenir, metin boyunca sabit kalır.
Fetch Getirmek "Çekmek" kullanılmamalıdır, veri okuma işlemi kast edilir.
Dashboard Kontrol Paneli Arayüz çevirisi ile tutarlı olmalıdır.
Token Token Çevrilmez, olduğu gibi bırakılır ("Jeton" kullanılmaz).

Sürüm Güncellemelerinde Fark (Diff) Çevirisi (SDLC Entegrasyonu)

Yazılım Geliştirme Yaşam Döngüsünde (SDLC) ürünler sürekli güncellenir.

"Fark (Diff) Çevirisi" (veya teknik adıyla artımlı çeviri), bir API dokümantasyonu veya sürüm notu (release notes) güncellendiğinde, tüm metni baştan çevirmek yerine yalnızca değişen, eklenen veya silinen satırların (diff) tespit edilip çevrilmesi işlemidir.

Bu yöntem, Çeviri Belleği (Translation Memory - TM) kullanılarak maliyetleri düşürür ve pazara çıkış süresini (Time-to-Market) hızlandırır.

Adım Adım Fark (Diff) Çevirisi Süreci
  1. Sürüm Karşılaştırması (Diff Alma): V1.1 ile V1.2 dokümanları arasındaki diff (fark) alınır.
  2. TM Analizi: Yeni veya değişen metinler, mevcut Çeviri Belleği ile karşılaştırılır (Fuzzy matching).
  3. İzole Çeviri: Sadece %100 eşleşmeyen yeni string'ler (metin dizileri) çevirmene iletilir.
  4. Entegrasyon: Çevrilen kısımlar dokümana yamanır ve yeni dil sürümü (V1.2 TR) derlenir.

Repo Üzerinden PR Akışı ile Sürekli Lokalizasyon

Modern DevRel ve dokümantasyon süreçlerinde çeviri yönetimi, yazılım kodunun yönetildiği sistemlerle aynı yerde gerçekleşir.

Sürekli Lokalizasyon (Continuous Localization), dokümantasyon dosyalarının (Markdown, MDX, RST) barındırıldığı Git depolarına (GitHub, GitLab) doğrudan entegre edilen Pull Request (PR) akışlarıyla sağlanır.

Geliştirici ana dilde bir değişiklik commit ettiğinde, lokalizasyon platformunda otomatik bir çeviri görevi tetiklenir ve çeviri bittiğinde otomatik bir PR açılır.

Checklist
  • [ ] CMS/Lokalizasyon aracının Git reposuna (webhook via) bağlanması.
  • [ ] Orijinal dilde (örn: main branch) yapılan commit'lerin izlenmesi.
  • [ ] Çeviri tamamlandığında l10n/tr-update adında otomatik bir branch ve PR oluşturulması.
  • [ ] CI/CD pipelines (örneğin GitHub Actions) ile yapısal geçerlilik (build checks) testlerinin çalıştırılması.

Hizmet Kapsamı ve Teslimatlar

Profesyonel bir API/SDK dokümantasyon çevirisi hizmetinin teslimatı, salt çevrilmiş metin dosyalarından daha fazlasını içermelidir.

BOFU (Bottom of the Funnel) aşamasındaki karar vericiler için hizmet kapsamı; dilsel kalite güvencesi (LQA), teknik bütünlük kontrolleri ve sürekli entegrasyona hazır formatta dosya teslimi sunarak operasyonel riski sıfıra indirmeyi hedefler.

Standart Teslimat Listesi
  1. Yapısı Korunmuş Çıktı Dosyaları: Orijinal formatta (JSON, YAML, Markdown, HTML) parse hatası vermeyen dosyalar.
  2. LQA Raporu: ISO 17100 standartlarına uygun, ikinci bir uzman tarafından yapılmış kalite denetim raporu.
  3. Çeviri Belleği (TM) Dosyası: Gelecek delta çevirilerde kullanılmak üzere oluşturulmuş .TMX formatında veri tabanı.
  4. Proje Sözlüğü (Glossary): Ürün terminolojisini standartlaştıran çok dilli terimce.

FAQ (Sıkça Sorulan Sorular)

S: API dokümantasyonu çevirisinde kod blokları çevrilir mi?

C: Hayır. Kod blokları, geliştiricilerin doğrudan kopyalayıp kullanabilmesi için orijinal dilinde (genellikle İngilizce) ve işlevsel formatında bırakılır. Çevrilmesi durumunda kod çalışmaz (syntax error). Sadece kod içindeki geliştiriciye not bırakan yorum satırları çevrilebilir.

S: Swagger/OpenAPI spesifikasyonlarını lokalize etmek güvenli midir?

C: Evet, doğru araçlarla yönetildiğinde güvenlidir. OpenAPI dosyalarındaki paths, parameters gibi teknik yapılar izole edilerek, sadece kullanıcıya dönük açıklamalar (description, summary) lokalize edilir. Böylece dosyanın makine tarafından okunabilirliği bozulmaz.

S: Fark (Diff) çevirisi nedir ve sürekli güncellenen SDK'lar için neden gereklidir?

C: Fark (diff) çevirisi, bir dokümanın yeni versiyonu yayınlandığında tüm metni baştan çevirmek yerine sadece değişen veya eklenen kısımların tespit edilerek çevrilmesidir. Sürekli güncellenen SDK'larda Çeviri Belleği (TM) kullanılarak sadece yeni kısımların (artımlı güncellemelerin) çevrilmesi, zaman ve operasyonel maliyet tasarrufu sağlar.

S: Pseudolocalization (sahte lokalizasyon) testlerine neden ihtiyaç duyulur?

C: Çevrilen metinlerin, hedef dildeki ortalama genleşme oranları nedeniyle UI ekranlarında taşıp taşmadığını veya arayüzü bozup bozmadığını görmek için yapılır. Çeviri başlamadan önce potansiyel tasarım hatalarını erken aşamada tespit eder.

S: API/SDK dokümantasyon çevirisi fiyatları nasıl belirlenir?

C: Fiyatlandırma temel olarak kelime sayısına dayanır; ancak tekrar oranları (Çeviri Belleği analizleri), format karmaşıklığı (JSON, YAML, Markdown ayrıştırma işlemleri) ve hedeflenen LQA (dil kalite güvencesi) adımları toplam proje maliyetini etkiler.

S: CI/CD süreçlerine lokalizasyon nasıl entegre edilir?

C: Dokümanların barındırıldığı GitHub/GitLab gibi repolar, lokalizasyon yönetim sistemlerine (TMS) webhook'lar aracılığıyla bağlanır. Kod deposuna yapılan bir değişiklik lokalizasyonu tetikler, çeviri bittiğinde sisteme otomatik bir Pull Request (PR) açılır.

S: Yazılım lokalizasyonunda Glossary (Terimce) neden zorunludur?

C: "Fetch", "Deploy", "Commit" gibi teknik kelimelerin ürün genelinde, hedef dilde hep aynı karşılıklarla (tutarlı) kullanılmasını sağlar. Bu durum, geliştiricilerin dokümanı okurken zihinsel karmaşa yaşamasını engeller.

S: Hatalı API çevirisi ürün entegrasyonlarını nasıl etkiler?

C: Parametre adlarının, endpoint yollarının veya JSON anahtarlarının yanlışlıkla çevrilmesi durumunda API istekleri başarısız olur (örn: 400 veya 404 hataları). Bu, geliştiricilerin ürünü entegre edememesine ve destek maliyetlerinin artmasına yol açar.

Teknik dokümantasyonunuzun global pazarlarda kusursuz bir geliştirici deneyimi sunması için planlı bir lokalizasyon stratejisi şarttır.

Süreci güvenle başlatmak için aşağıdaki 6 maddelik eylem planını uygulayabilirsiniz:

Hemen (İlk Adımlar)
  1. Mevcut API/SDK dokümanlarınızın formatını (Markdown, OpenAPI YAML vb.) ve kelime hacmini analiz edin.
  2. Orijinal dildeki teknik terimleri belirleyerek bir "Glossary (Terimce)" taslağı oluşturun.
  3. Çevrilecek ve kesinlikle dokunulmayacak teknik yapıları (kod, endpoint, parametre) net bir kural setiyle (Style Guide) belirleyin.
Risk Azaltıcı Adımlar
  1. Çeviriye başlamadan önce pseudolocalization testleri uygulayarak arayüzdeki metin genişlemesi (expansion) risklerini haritalandırın.
  2. JSON veya YAML dosyalarını manuel çevirmek yerine, parse yeteneği olan profesyonel CAT araçları kullanan uzman iş ortaklarıyla çalışın.
  3. Lokalize edilmiş dokümantasyonun yayına alınmasının ardından, farklı bölgelerden gelen teknik destek (ticket) oranlarındaki düşüşü ölçümleyin.