Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Buka Fakta Makanan
- Penulis teknis:
- FutureOfDocs
- Nama proyek:
- Dokumentasikan Open Food Facts API
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Saya pertama kali mendengar tentang "Musim Dokumen" melalui email yang saya dapatkan dari instruktur kursus tentang dokumentasi REST API yang saya ambil beberapa bulan lalu. Meskipun saya sangat menyukai ide itu, saya memutuskan bahwa saya hanya akan melamar proyek jika saya benar-benar bisa mengenalinya. Ini adalah sesuatu yang akan saya lakukan selain pekerjaan biasa saya, dan jika saya melakukannya, itu pasti menyenangkan dan bermakna.
Ketika saya membaca deskripsi Open Food Facts, saya tahu saya telah menemukan proyek itu. Saya suka merawat tubuh dan kesehatan saya melalui olahraga dan makanan. Saya benar-benar berpikir bahwa nutrisi adalah salah satu kunci hidup bahagia, dan kita semua harus bisa membuat pilihan yang lebih baik, yang hanya mungkin terjadi jika kita memiliki cukup informasi tentang makanan dan kosmetik yang kita gunakan. Open Food Facts akan membagikan informasi ini kepada kami, dan saya ingin berkontribusi pada inisiatif yang luar biasa ini.
Dalam tiga tahun terakhir, saya telah bekerja sebagai penulis teknis di perusahaan pengembangan software yang berspesialisasi dalam otomatisasi proses dan rilis. Di antaranya, 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 kami telah mengidentifikasi informasi mana yang diperlukan oleh pelanggan kami untuk memberikannya dengan cara yang jelas dan ringkas.
Saya telah meninjau situs Open Food Facts API saat ini dan saya pikir kami dapat menyusun ulang dan meningkatkan kualitas dokumentasi agar lebih mudah digunakan (halaman Umum, BACA, TULIS). Selain itu, bersama dengan tim pengembangan, saya ingin menyiapkan cara untuk membuat dokumentasi API secara otomatis dari kode (ini membutuhkan waktu, karena itulah saya mengusulkan kolaborasi jangka panjang).
Kita semua tahu tampilan itu penting ;) Itu sebabnya kita juga dapat menyesuaikan CSS dan logo REST API untuk menyelaraskan UI yang keren dengan dokumentasi pengguna.
Saya sudah tidak sabar ingin bekerja sama dengan Anda dalam proyek ini!