API dokümantasyonu tercümesi yalnızca metinleri bir dilden başka bir dile aktarmaktan ibaret değildir. Dokümanda yer alan ekran görüntüleri, akış şemaları, tablo başlıkları, veri modelleri, hata kodları ve kod örnekleri de çevrilen içeriğin ayrılmaz parçalarıdır. Bu nedenle görsel ve teknik unsurların ayrı bir kontrol sürecinden geçirilmesi gerekir.
Başarılı bir kontrolde temel amaç; çevrilmiş metnin kaynak dokümandaki anlamı koruması, görsellerle metin arasında çelişki oluşmaması ve geliştiricinin gerekli bilgiyi hızlı biçimde bulabilmesidir. Antalya merkezli Pura Tercüme, yazılı tercüme süreçlerinde bu tür teknik içeriklerin metin, biçim ve dosya bütünlüğü açısından değerlendirilmesine yardımcı olabilir.
API dokümantasyonu tercümesinde görsel kontrolü neden önemlidir?#
API dokümanlarında görseller çoğu zaman açıklama metnini destekler. Bir ekran görüntüsündeki menü adı, bir diyagramdaki servis etiketi veya bir tabloda kullanılan alan adı çevrilmezse ya da yanlış çevrilirse kullanıcı ile doküman arasında uyumsuzluk oluşabilir. Metin doğru olsa bile görseldeki bilgi farklı kaldığında okuyucu hangi adımı uygulayacağını kestiremeyebilir.
Görsel kontrolü, yalnızca yazıların çevrilip çevrilmediğine bakmakla sınırlı değildir. Aşağıdaki unsurlar birlikte incelenmelidir:
- Görselde yer alan ekran, menü ve düğme adlarının metinle uyumu
- Ok, numara, renk ve sembollerin açıklama metniyle tutarlılığı
- Görsel üzerindeki küçük metinlerin okunabilirliği
- Kaynak ve hedef dilde yön, sıra veya işlem adımı farkı oluşup oluşmadığı
- Görselin çevrilmiş dokümanda doğru bölümün altında bulunması
- Görsel açıklaması, alt metin veya başlığın içerikle eşleşmesi
Örneğin bir API çağrısının kullanıcı arayüzündeki karşılığı ekran görüntüsüyle anlatılıyorsa, görseldeki alan isimleriyle açıklama metnindeki alan isimleri aynı terminolojiyle kullanılmalıdır. Bu kontrol yapılmadan yalnızca paragraf çevirisinin incelenmesi eksik bir kalite değerlendirmesi oluşturur.
Şema ve akış diyagramlarında hangi noktalar incelenir?#
Şemalar, API dokümantasyonunda veri akışını veya sistem bileşenleri arasındaki ilişkiyi özetler. Bir akış diyagramında tek bir terimin yanlış aktarılması bile sürecin nasıl çalıştığına ilişkin yanlış bir izlenim yaratabilir. Bu nedenle şema kontrolü, teknik terminoloji kontrolüyle birlikte yürütülmelidir.
Şema etiketleri ve bağlantılar#
İlk olarak kutu, düğüm, ok ve bağlantı etiketleri incelenir. Bir kutunun içindeki ifade ile aynı bileşeni anlatan paragraf farklı çevrilmemelidir. “İstek”, “yanıt”, “kimlik doğrulama”, “veri tabanı” veya “istemci” gibi ifadelerin dokümanın tamamında aynı anlamı taşıması beklenir.
Okların yönü de ayrıca kontrol edilmelidir. Çeviri sırasında metin kutuları yeniden düzenlenmişse okların hangi bileşenden hangi bileşene gittiği görsel olarak yeniden değerlendirilmelidir. Bazı dosya türlerinde metin kutusunun taşınması, bağlantı çizgisinin yanlış nesneye bağlanmasına neden olabilir.
Şema ile açıklama metni arasındaki uyum#
Şemanın hemen altında veya üstünde yer alan açıklama, görseldeki sıralamayı takip etmelidir. Metin “önce istemci, ardından ağ geçidi ve son olarak servis” diyorsa görseldeki akışın da bunu göstermesi gerekir. Çeviri sonrasında cümle yapısı değiştiğinde sıra ifadeleri tekrar kontrol edilmelidir.
Birden fazla şema kullanılan uzun dokümanlarda bölüm numarası, şekil başlığı ve metin içi atıflar da önem taşır. “Şekil 3’te görüldüğü gibi” ifadesi başka bir görsele yöneliyorsa numaralandırma korunmalı veya dosyanın yeni düzenine göre tutarlı biçimde güncellenmelidir.
Tabloların tercümesinde teknik ve görsel bütünlük#
API dokümanlarında tablolar genellikle parametreleri, veri türlerini, zorunluluk durumunu, varsayılan değerleri ve hata kodlarını gösterir. Bu nedenle tablo tercümesi, normal paragraf çevirisinden daha yoğun bir kontrol gerektirir. Bir sütun başlığının yanlış anlaşılması, tablonun tamamının kullanım amacını değiştirebilir.
| Kontrol alanı | İncelenecek nokta | Olası sorun |
|---|---|---|
| Sütun başlıkları | Başlıkların teknik anlamı ve diğer bölümlerle uyumu | Aynı kavramın farklı ifadelerle kullanılması |
| Parametre adları | Kodla ilişkili adların korunması | Değişken adının yanlışlıkla çevrilmesi |
| Veri türleri | String, integer, boolean gibi değerlerin doğru açıklanması | Geliştiricinin veri formatını yanlış yorumlaması |
| Zorunluluk bilgisi | Gerekli, isteğe bağlı ve koşullu alanların ayrımı | İsteğe bağlı alanın zorunlu sanılması |
| Hata kodları | Kod, açıklama ve çözüm önerisinin eşleşmesi | Hatanın yanlış teşhis edilmesi |
Tablo hücrelerinde metin uzadığında satır yüksekliği ve sütun genişliği de kontrol edilmelidir. Uzun çeviri ifadeleri hücre içinde taşabilir, başlıkları kapatabilir veya sayfa düzenini bozabilir. Bu durum yalnızca estetik bir problem değildir; satırların hangi parametreye ait olduğu anlaşılmayabilir.
Parametre adları, endpoint yolları, alan adları ve örnek değerler çoğu projede değişken niteliği taşıyabilir. Çeviri ekibi, çevrilmesi gereken açıklama ile aynen korunması gereken teknik dizeyi ayırmalıdır. Bu ayrım yapılmadan tablo içinde otomatik veya manuel değişiklik uygulanması, kod ile dokümantasyonun birbirinden kopmasına yol açabilir.
Finansal veya ticari dokümanlarda kullanılan tablo kontrol yaklaşımına ilişkin daha genel bir örnek için bilanço çevirisinde tablo ve dipnot düzeni rehberine göz atabilirsiniz. API tablolarında konu farklı olsa da hücre yapısını ve referansları koruma ilkesi benzerdir.
Kod örnekleri, ekran görüntüleri ve metin ayrımı#
API dokümanlarının en hassas bölümlerinden biri kod örnekleridir. Kod bloğundaki endpoint, değişken, parametre, JSON anahtarı, komut ve dosya yolu çoğu zaman aynen korunmalıdır. Buna karşılık kod bloğunun önündeki açıklama, koddan sonraki not veya ekran görüntüsü başlığı hedef dile çevrilebilir.
Kod bloklarında korunması gerekenler#
- Endpoint adresleri ve HTTP yöntemleri
- JSON, XML veya benzeri veri yapılarındaki anahtar adları
- Değişken, fonksiyon ve sınıf adları
- Kimlik doğrulama alanları ve örnek parametre isimleri
- Hata kodları, sürüm numaraları ve teknik semboller
- Kod içindeki kaçış karakterleri, noktalama işaretleri ve girintiler
Bununla birlikte kod içindeki açıklama satırlarının çevrilip çevrilmeyeceği proje tercihine bağlı olabilir. Bu konuda dokümanın tamamında aynı yaklaşım kullanılmalıdır. Bir örnekteki yorum satırı çevrilirken diğer örneklerde kaynak dilde bırakılması, okuyucunun doküman politikasını anlamasını zorlaştırır.
Ekran görüntülerinde kod ile arayüz metni aynı anda bulunuyorsa iki katman ayrı incelenmelidir. Kod alanındaki karakterler korunurken menü ve buton adlarının hedef dildeki karşılıklarıyla açıklama metninin uyumu kontrol edilir. Görselin yeniden hazırlanması mümkün değilse, hangi ifadelerin kaynak dilde bırakıldığı açık ve tutarlı biçimde yönetilmelidir.
Görsel, şema ve tablo kontrolü için uygulanabilir süreç#
Teknik bir dokümanın kontrolünü rastgele yapmak yerine aşamalı bir kontrol listesiyle yürütmek daha sağlıklıdır. Aşağıdaki süreç, farklı dosya biçimlerine uyarlanabilecek pratik bir çerçeve sunar.
- Kaynak dosyayı tanıma: Dokümandaki görseller, tablolar, şemalar, kod blokları ve ekler listelenir. Bu liste, teslim öncesi karşılaştırmada temel alınır.
- Terminoloji listesi oluşturma: Ürün adları, API bileşenleri, endpoint açıklamaları, veri türleri ve kullanıcı arayüzü ifadeleri belirlenir. Aynı kavramın farklı bölümlerde farklı çevrilmesi önlenir.
- Metin-görsel eşleştirmesi: Her görselin hangi paragraf, tablo veya başlıkla ilişkili olduğu kontrol edilir. Görselin yanlış bölüme taşınmadığından emin olunur.
- Teknik dize kontrolü: Kod, parametre, sürüm, hata kodu ve dosya yolu gibi unsurlar kaynak dosyayla karşılaştırılır.
- Düzen kontrolü: Sayfa kırılmaları, tablo taşmaları, okunabilirlik, başlık hiyerarşisi ve şekil numaraları incelenir.
- İkinci okuma: Teknik bağlamı bilen bir göz, özellikle akış sırası, zorunluluk ifadeleri ve hata açıklamalarını yeniden değerlendirir.
- Son karşılaştırma: Çevrilmiş dosya kaynak dosyayla bölüm bölüm karşılaştırılır ve tespit edilen değişiklikler kayıt altına alınır.
Bu süreçte yalnızca dil bilgisi hatalarını aramak yeterli değildir. Örneğin bir tablo başlığı dil açısından doğru olabilir; ancak sütundaki değerlerle eşleşmiyorsa teknik açıdan hâlâ sorun vardır. Bu nedenle dilsel kontrol ile işlevsel görünüm kontrolü birlikte düşünülmelidir.
Dosya tesliminden önce kontrol listesi#
Son okuma sırasında kullanılabilecek kısa bir kontrol listesi aşağıdaki gibidir:
- Kaynak dokümandaki tüm görseller çevrilmiş dosyada mevcut mu?
- Şema, ok ve numaralandırmaların anlamı korunuyor mu?
- Görsel başlıkları ve metin içi atıflar birbiriyle uyumlu mu?
- Tablo başlıkları, hücreleri ve satır sıraları doğru mu?
- Parametre adları ile açıklamaları birbirine karşılık geliyor mu?
- Kod örneklerinde çevrilmemesi gereken dizeler değiştirilmiş mi?
- Uzun çeviri ifadeleri sayfa düzenini veya tablo okunabilirliğini bozuyor mu?
- Hata kodu, hata açıklaması ve çözüm adımı arasında çelişki var mı?
- Dosya içindeki bağlantılar, bölüm numaraları ve ek referansları çalışıyor veya doğru yeri gösteriyor mu?
Bu kontrol listesinin proje ekibi tarafından önceden paylaşılması da yararlı olabilir. Böylece tercüme sırasında hangi ifadelerin çevrileceği, hangi teknik dizelerin korunacağı ve görsellerin yeniden düzenlenip düzenlenmeyeceği netleşir.
Noter onayı veya apostil gerekli olur mu?#
API dokümantasyonu çoğunlukla teknik ve ticari kullanım amacı taşıdığı için her dosya için noter onayı ya da apostil gerekeceği söylenemez. Belgenin hangi amaçla kullanılacağı ve teslim edilecek kurumun veya karşı tarafın talebi belirleyici olabilir. Bu nedenle tercüme öncesinde hedef kurumun belge, onay ve teslim formatı beklentileri sorulmalıdır.
Resmî nitelikte bir kullanım söz konusuysa çevirinin yeminli yazılı tercüme olarak hazırlanması, noter onay süreci desteği veya apostil süreci desteği gündeme gelebilir. Ancak bu işlemlerin gerekip gerekmediği somut dosyaya göre değerlendirilmelidir. Pura Tercüme, Antalya merkezli hizmet kapsamında yeminli yazılı tercüme, noter onay süreci desteği, apostil süreci desteği ve dijital/kargo teslim seçenekleri sunar.
Teknik dosyanın biçimi, görsel sayısı, tablo yoğunluğu, kaynak dosyanın düzenlenebilir olup olmaması ve istenen teslim şekli çalışma kapsamını etkileyebilir. Bu nedenle fiyat veya teslim planı oluşturulmadan önce dosyanın incelenmesi gerekir. Antalya, Kepez, Muratpaşa, Konyaaltı, Lara veya çevre ilçelerden iletilen dosyalarda da aynı şekilde ön inceleme yapılması sağlıklı olur.
Antalya’da API dokümantasyonu tercümesi için dosya hazırlığı#
Antalya ve ilçelerinde faaliyet gösteren yazılım ekipleri, teknoloji girişimleri veya uluslararası iş yapan işletmeler teknik dokümanlarını tercümeye göndermeden önce bazı hazırlıkları tamamlayabilir. Kaynak dosyanın son sürümünü paylaşmak, varsa ekran görüntülerinin yüksek çözünürlüklü kopyalarını eklemek ve kod bloklarının düzenlenebilir biçimini korumak kontrol sürecini kolaylaştırır.
Ayrıca ürün adları, çevrilmemesi gereken terimler, tercih edilen Türkçe karşılıklar ve hedef okuyucu hakkında kısa bir not hazırlanabilir. API dokümanı geliştiricilere, teknik destek ekiplerine veya son kullanıcılara yönelik olabilir. Hedef kitle değiştikçe açıklama düzeyi ve terminoloji tercihleri de değişebilir.
Dokümanda finansal rapor, teklif tablosu veya ticari veri örnekleri de bulunuyorsa teklif dosyası tercümesinde finansal terim standardizasyonu yaklaşımı yardımcı bir referans olabilir. Kod ve tablo içeren niyet mektupları için de tablo, kod ve dipnot düzeni üzerine hazırlanan rehber incelenebilir.
Sonuç: API dokümantasyonu tercümesinde bütünsel kontrol#
API dokümantasyonu tercümesi tamamlandığında yalnızca cümlelerin doğru olup olmadığına bakmak yeterli değildir. Görseller, şemalar, tablolar, kod blokları, numaralandırmalar ve metin içi referanslar birlikte değerlendirilmelidir. Özellikle teknik dizelerin korunması, tablo yapısının bozulmaması ve şemadaki akışın metinle örtüşmesi dokümanın kullanılabilirliği açısından önem taşır.
Dosyanızın kapsamını, hedef dilini, görsel ve tablo yoğunluğunu belirterek Pura Tercüme ile iletişime geçebilirsiniz. Antalya merkezli ekipten bilgi almak için 0552 740 19 23 numarasını kullanabilir; dosyanın dijital veya kargo teslim seçeneklerini de görüşebilirsiniz.
Sık Sorulan Sorular#
API dokümantasyonundaki tüm görseller çevrilmeli mi?#
Her görselin çevrilmesi gerekmez. Ancak görseldeki metin anlam taşıyor veya açıklama metnini destekliyorsa hedef dille uyumu kontrol edilmelidir. Kod ve teknik dizeler ise çoğu durumda korunur.
Tablolarda parametre adları Türkçeye çevrilebilir mi?#
Parametre, JSON anahtarı, endpoint ve değişken adları genellikle aynen korunur. Açıklama, sütun başlığı ve kullanım notları ise proje terminolojisine uygun biçimde çevrilebilir.
API dokümantasyonu tercümesinde noter onayı veya apostil zorunlu mudur?#
Her teknik doküman için zorunlu değildir. Gereklilik, belgenin kullanım amacına ve teslim edilecek kurumun veya karşı tarafın talebine göre değerlendirilmelidir.
Tercüme öncesinde hangi dosyalar paylaşılmalı?#
Kaynak dokümanın son sürümü, düzenlenebilir dosyalar, görseller, kod örnekleri, terminoloji tercihleri ve çevrilmemesi gereken teknik ifadeler paylaşılmalıdır.
Çeviri ve onay sürecinizi birlikte planlayalım.
Belgenizi, hedef dili ve kullanılacağı kurumu gönderin; gerekli tercüme ve noter sürecini netleştirelim.