本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 打开食品营养信息
- 技术文档工程师：
- FutureOfDocs
- 项目名称：
- 记录 Open Food Facts API 的知识
- 项目时长：
- 长时间运行（5 个月）
Project description
几个月前，我从讲师那里收到了有关 REST API 文档课程的电子邮件，我第一次听说了“Google 文档季”。虽然我非常喜欢这个想法，但我决定只申请自己真正认同的项目。这将是我在正常工作之外要做的事，而且我要做的事必须有趣且有意义。
当我读到 Open Food Facts 的说明时，就知道自己找到了这个项目。我喜欢通过运动和饮食来照顾自己的身体和健康。我真的认为营养是幸福生活的关键之一，我们都应该能够做出更好的选择，而要做到这一点，就必须对自己所用食品和化妆品有足够的信息。Open Food Facts 让这些信息由我们处理，我想为这个令人惊叹的计划做出贡献。
在过去三年里，我一直在一家专门从事流程和发布自动化的软件开发公司担任技术文档工程师。其中之一，我们使用 Swagger 实现了 REST API，让开发者能够通过 API 请求与我们的应用进行通信。我曾帮助开发团队为请求/响应撰写更好的描述，并且我们一起确定了客户需要哪些信息以简洁明了的方式提供。
我一直在审核当前的 Open Food Facts API 网站，认为我们可以重构和改进文档，使其更易于用户使用（“General”“READ”“WRITE”页面）。此外，我很乐意与开发团队一起设法从代码自动生成 API 文档（这需要时间，因此我建议进行长期合作）。
我们都知道外观很重要 ;) 因此，我们还可以调整 REST API CSS 和徽标，使 Swagger 界面与用户文档保持一致。
期待与您一起合作完成此项目！