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 Google Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Khám phá thông tin về thực phẩm
- Người viết nội dung kỹ thuật:
- FutureOfDocs
- Tên dự án:
- Ghi lại Open Food Facts API
- Thời lượng dự án:
- Lâu dài (5 tháng)
Mô tả dự án
Lần đầu tiên tôi nghe nói về "Phần Tài liệu" thông qua email nhận được từ người hướng dẫn trong một khoá học về tài liệu về 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 sẽ chỉ đăng ký dự án nếu tôi thực sự xác định được ý tưởng đó. Đây là việc tôi sẽ làm ngoài công việc thông thường của mình và nếu tôi làm như vậy thì chắc hẳn nó rất thú vị và có ý nghĩa.
Khi đọc phần mô tả Open Food Fact, tôi biết mình đã tìm ra dự án đó. Tôi thích chăm sóc cơ thể và sức khoẻ 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ủa một cuộc sống hạnh phúc và tất cả chúng ta đều có thể có những lựa chọn tốt hơn. Điều này chỉ có thể xảy ra nếu chúng ta có đủ thông tin về thực phẩm và mỹ phẩm chúng ta sử dụng. Open Food Facts cung cấp thông tin này theo ý chúng ta 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 biên tập viên kỹ thuật tại một công ty phát triển phần mềm chuyên về tự động hóa quy trình và phát hành. Ngoài ra, chúng tôi đã triển khai API REST với Swagger cho phép các nhà phát triển giao tiếp với ứ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 ta cùng nhau xác định những thông tin mà khách hàng cần để cung cấp một cách rõ ràng và súc tích.
Tôi đã xem trang web hiện tại của Open Food Facts API (API Thông tin thực phẩm mở) và tôi cho rằng chúng tôi có thể điều chỉnh cấu trúc và cải thiện tài liệu để làm cho tài liệu trở nên thân thiện hơn với người dùng (các trang Cài đặt chung, READ, WRITE). 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 về API từ mã (việc này cần có thời gian, đó là lý do tôi đề xuất một dự án 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 của API REST để căn chỉnh giao diện người dùng một cách hào nhoáng 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!