API dokümantasyonu deneyimim bir panikle başladı. Şirkete yeni katılmıştım, elime 200 sayfalık kod çıktısı verildi ve 'bunun dökümanını yaz' dediler. Hiç uç nokta dokümante etmemiştim. Ne yapacağımı bilemedim. İlk hafta çok şey öğrendim ama hiçbirini doğru öğrenmedim. Geliştiricilerle toplantılara girdim, sordukça cevap aldım ama hangi soruyu sormam gerektiğini bilmiyordum. API dokümantasyonu deneyimi bana şunu gösterdi: teknik bir yazarın en önemli becerisi 'doğru soruyu sormak'. Üç hafta sonra ilk taslağı gönderdim. Geri bildirimler acımasızdı ama adildi. 'Bir geliştirici bu açıklamadan endpoint'i çağıramaz' dedi mühendis arkadaşım. Haklıydı; benim açıklamam kullanıcı perspektifinden değil, sistemin perspektifindendi. API dokümantasyonu deneyiminde bu ayrımı geç fark ettim. Yeniden yazdım. Bu sefer Postman'de her çağrıyı kendim denedim. Hataları belgeledim, başarılı yanıtları belgeledim. Dokümantasyon canlandı. O projeden çıkardığım pratik dersler: istek ve yanıt örneklerini her zaman gerçek verilerle gösterin, takma veriyle olmaz. Hata kodlarını açıklamak, başarılı yanıtı açıklamak kadar önemli. Geliştiricilerle yazışma geçmişinizi saklayın; en iyi bilgi oradadır. API dokümantasyonu deneyiminin bana verdiği en büyük şey ise teknik merak. O projeden sonra kod okumaktan korkmuyorum artık.