Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần tài liệu của Google.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Mở ứng dụng Chia sẻ thông tin về món ăn
- Tác giả kỹ thuật:
- FutureOfDocs
- Tên dự án:
- Ghi lại Open Food Facts API (API Thông tin thực phẩm mở)
- Thời lượng dự án:
- Chạy trong thời gian dài (5 tháng)
Mô tả dự án
Lần đầu tiên tôi nghe nói về "Season of Docs" là thông qua một email mà tôi nhận được từ người hướng dẫn một khoá học về tài liệu API REST mà tôi đã tham gia vài tháng trước. Mặc dù rất thích ý tưởng này, nhưng tôi quyết định chỉ đăng ký tham gia một dự án nếu thực sự có thể đồng cảm với dự án đó. Đây là việc tôi sẽ làm bên cạnh công việc thường ngày của mình, và nếu tôi làm được thì đó chắc hẳn là điều thú vị và ý nghĩa.
Khi đọc nội dung mô tả về Open Food Facts, tôi biết mình đã tìm thấy dự án đó. Tôi thích chăm sóc cơ thể và sức khoẻ của mình thông qua việc tập thể dục và ăn uống. Tôi thực sự nghĩ rằng dinh dưỡng là một trong những chìa khoá để có một cuộc sống hạnh phúc. Tất cả chúng ta đều có thể đưa ra lựa chọn tốt hơn, điều này chỉ có thể thực hiện được nếu chúng ta có đủ thông tin về thực phẩm và mỹ phẩm mà mình sử dụng. Open Food Facts cung cấp thông tin này cho chúng tôi và tôi muốn đóng góp cho sáng kiến tuyệt vời này.
Trong ba năm qua, tôi làm việc với vai trò là một nhà văn kỹ thuật tại một công ty phát triển phần mềm chuyên về tự động hoá quy trình và bản phát hành. Ngoài ra, chúng tôi đã triển khai một API REST với Swagger cho phép nhà phát triển giao tiếp với các ứng dụng của chúng tôi thông qua các yêu cầu API. Tôi đã giúp các nhóm phát triển viết nội dung mô tả tốt hơn cho các yêu cầu/phản hồi. Chúng tôi cùng nhau xác định những thông tin mà khách hàng cần để cung cấp thông tin một cách rõ ràng và súc tích.
Tôi đã xem xét trang web API Open Food Facts hiện tại và tôi nghĩ chúng ta có thể tái cấu trúc và nâng cao tài liệu để tài liệu trở nên thân thiện hơn với người dùng (các trang General (Chung), READ (ĐỌC), WRITE (GHI)). Hơn nữa, tôi muốn cùng với các nhóm phát triển thiết lập một cách để tự động tạo tài liệu API từ mã (việc này sẽ mất thời gian, đó là lý do tôi đề xuất một quá trình cộng tác lâu dài).
Chúng ta đều biết rằng giao diện rất quan trọng ;) Đó là lý do chúng ta cũng có thể điều chỉnh CSS và biểu trưng API REST để điều chỉnh giao diện người dùng swagger với tài liệu người dùng.
Tôi rất mong được làm việc với bạn trong dự án này!