Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Gıda Bilgileri'ni açma
- Teknik yazar:
- FutureOfDocs
- Proje adı:
- Open Food Facts API'yi belgeleme
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
"Belge Sezonu"ndan ilk kez birkaç ay önce katıldığım REST API dokümanları konulu bir kurstaki eğitmenimden aldığım bir e-posta aracılığıyla haberdar oldum. Fikirden çok etkilenmiş olsam da yalnızca kendimi gerçekten ifade edebileceğim projelere başvurmaya karar verdim. Normal işimi yapmak dışında başka bir şey yapıyorum. Bunu yapmış olsaydım da eğlenceli ve anlamlı olurdu.
Open Food Facts'ın açıklamasını okuduğumda bu projeyi bulduğumu biliyordum. Egzersiz ve beslenme yoluyla vücuduma ve sağlığıma dikkat etmeyi seviyorum. Beslemenin mutlu bir yaşamın anahtarlarından biri olduğunu düşünüyorum. Hepimizin daha iyi seçimler yapabilmesi gerekiyor. Bu da ancak kullandığımız gıda ve kozmetik ürünler hakkında yeterli bilgiye sahip olduğumuzda mümkün. Open Food Facts bu bilgileri bizimle paylaşıyor ve bu muhteşem girişime katkıda bulunmak istiyorum.
Son üç yıldır süreç ve sürüm otomasyonu konusunda uzmanlaşmış bir yazılım geliştirme şirketinde teknik yazar olarak çalışıyorum. Diğerlerinin yanı sıra, geliştiricilerin API istekleri aracılığıyla uygulamalarımızla iletişim kurmasına olanak tanıyan Swagger ile bir REST API'si uyguladık. Geliştirme ekiplerinin istekler/yanıtlar için daha iyi açıklamalar yazmasına yardımcı oldum ve birlikte, müşterilerimize net ve kısa bir şekilde sunmaları gereken bilgileri belirledik.
Şu anki Open Food Facts API sitesini inceliyorum ve belgeleri daha kullanıcı dostu olacak şekilde yeniden yapılandırıp geliştirebileceğimizi düşünüyorum (Genel, OKUMA, YAZMA sayfaları). Ayrıca, geliştirme ekipleriyle birlikte API dokümanlarını koddan otomatik olarak oluşturmanın bir yolunu belirlemek isterim (Bu zaman aldığı için uzun süreli bir işbirliği öneriyorum).
Görünümün önemli olduğunu hepimiz biliyoruz ;) Bu nedenle, swagger kullanıcı arayüzünü kullanıcı dokümanlarıyla uyumlu hale getirmek için REST API CSS'sini ve logosunu da değiştirebiliriz.
Bu projede sizinle birlikte çalışmaktan memnuniyet duyarım.