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 Google Phần Tài liệu.
Tóm tắt dự án
- Tổ chức nguồn mở:
- Thông tin mở 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:
- Sử dụng lâu dài (5 tháng)
Mô tả dự án
Lần đầu tiên tôi nghe nói về "Phần của Tài liệu" thông qua email nhận được từ người hướng dẫn của 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 sẽ chỉ đăng ký tham gia một dự án nếu tôi thực sự đồng cảm với ý tưởng đó. Đây là việc tôi vẫn thường làm ngoài công việc bình thường của mình. Nếu tôi đã làm thì nó hẳn sẽ rất thú vị và có ý nghĩa.
Khi đọc phần mô tả về Open Food Fact, 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 bằng 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á để sống hạnh phúc. Tất cả chúng ta đều có thể đưa ra 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 mà chúng ta sử dụng. Open Food Facts cung cấp thông tin này theo ý 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 vừa qua, tôi làm việc với tư cách là người viết nội dung 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. Cùng với đó, chúng tôi đã triển khai 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 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 được thông tin nào 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 và 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 để tài liệu trở nên thân thiện hơn với người dùng (các trang nói chung, ĐỌC, GHI). Hơn nữa, tôi cùng với các nhóm phát triển sẽ thiết lập một cách tự động tạo tài liệu API từ đoạn mã (điều 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 giao diện là quan trọng;) Đó là lý do tại sao chúng ta cũng có thể tinh chỉnh CSS API REST và biểu trưng để căn chỉnh giao diện người dùng phong cách hơn 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!