Halaman ini berisi detail proyek penulisan teknis yang diterima untuk Google Season of Dokumen.
Ringkasan proyek
- Organisasi open source:
- Buka Fakta Makanan
- Penulis teknis:
- FutureOfDocs
- Nama proyek:
- Mendokumentasikan Open Food Facts API
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Saya pertama kali mendengar tentang "Season of Docs" melalui email yang saya dapatkan dari instruktur kursus tentang dokumentasi REST API yang saya ikuti beberapa bulan lalu. Meskipun saya sangat menyukai ide tersebut, saya memutuskan bahwa saya hanya akan melamar sebuah proyek jika saya benar-benar bisa memahaminya. Ini adalah sesuatu yang akan saya lakukan selain pekerjaan rutin saya, dan jika saya melakukannya, itu pasti menyenangkan dan bermakna.
Ketika membaca penjelasan tentang Open Food Facts, saya tahu bahwa saya telah menemukan proyek itu. Saya senang menjaga tubuh dan kesehatan saya melalui olahraga dan makanan. Menurut saya, nutrisi adalah salah satu kunci hidup bahagia, dan kita semua harus bisa membuat pilihan yang lebih baik, yang hanya bisa terwujud jika kita memiliki cukup informasi tentang makanan dan kosmetik yang kita gunakan. Open Food Facts menyediakan informasi ini, dan saya ingin berkontribusi dalam inisiatif yang luar biasa ini.
Dalam tiga tahun terakhir, saya bekerja sebagai penulis teknis di perusahaan pengembangan software yang berspesialisasi dalam otomatisasi proses dan rilis. Di antara yang lain, kami telah mengimplementasikan REST API dengan Swagger yang memungkinkan developer berkomunikasi dengan aplikasi kami melalui permintaan API. Saya telah membantu tim pengembangan menulis deskripsi yang lebih baik untuk permintaan/respons, dan bersama-sama kita telah mengidentifikasi informasi mana yang dibutuhkan oleh pelanggan kami untuk memberikannya dengan cara yang jelas dan ringkas.
Saya telah meninjau situs Open Food Facts API saat ini dan sepertinya kita bisa menyusun ulang dan menyempurnakan dokumentasi agar lebih mudah digunakan (halaman Umum, BACA, TULIS). Selain itu, saya juga ingin menyiapkan, bersama dengan tim pengembangan, cara untuk membuat dokumentasi API secara otomatis dari kode (ini membutuhkan waktu, itulah sebabnya saya mengusulkan kolaborasi jangka panjang).
Kita semua tahu penampilan itu penting ;) Itulah sebabnya kita juga dapat menyesuaikan CSS dan logo REST API untuk menyelaraskan UI kustom dengan dokumentasi pengguna.
Saya sudah tidak sabar ingin bekerja sama dengan Anda dalam proyek ini.