Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Buka Fakta Makanan
- {i>Technical writer <i}(Penulis teknis):
- FutureOfDocs
- Nama project:
- Mendokumentasikan Open Food Facts API
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Saya pertama kali mendengar tentang "Season of Docs" melalui email yang saya terima dari instruktur kursus tentang dokumentasi REST API yang saya ikuti beberapa bulan lalu. Meskipun saya sangat menyukai ide tersebut, saya memutuskan untuk hanya melamar proyek jika saya benar-benar dapat mengidentifikasinya. Ini adalah sesuatu yang akan saya lakukan selain pekerjaan rutin saya, dan jika saya melakukannya, hal itu harus menyenangkan dan bermakna.
Saat membaca deskripsi Open Food Facts, saya tahu bahwa saya telah menemukan project tersebut. Saya suka menjaga tubuh dan kesehatan saya melalui olahraga dan makanan. Saya benar-benar yakin bahwa nutrisi adalah salah satu kunci untuk hidup bahagia, dan kita semua harus dapat membuat pilihan yang lebih baik, yang hanya dapat dilakukan jika kita memiliki cukup informasi tentang makanan dan kosmetik yang kita gunakan. Open Food Facts menyediakan informasi ini, dan saya ingin berkontribusi pada inisiatif yang luar biasa ini.
Selama tiga tahun terakhir, saya bekerja sebagai penulis teknis di perusahaan pengembangan software yang berspesialisasi dalam otomatisasi proses dan rilis. Di antara lainnya, kami telah menerapkan 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 yang diperlukan oleh pelanggan untuk memberikannya dengan cara yang jelas dan ringkas.
Saya telah meninjau situs Open Food Facts API saat ini, dan saya pikir kita dapat merestrukturisasi dan meningkatkan dokumentasinya agar lebih mudah digunakan (halaman Umum, BACA, TULIS). Selain itu, saya ingin menyiapkan, bersama dengan tim pengembangan, cara untuk membuat dokumentasi API secara otomatis dari kode (ini memerlukan waktu, itulah sebabnya saya mengusulkan kolaborasi jangka panjang).
Kita semua tahu bahwa tampilan itu penting ;) Itulah sebabnya kita juga dapat menyesuaikan CSS dan logo REST API untuk menyelaraskan UI swagger dengan dokumentasi pengguna.
Kami berharap dapat bekerja sama dengan Anda dalam project ini.