本页面包含“Google 文档季”接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- 开放式食品成分
- 技术文档工程师：
- FutureOfDocs
- 项目名称：
- 编写 Open Food Facts API 文档
- 项目时长：
- 长期投放（5 个月）
Project description
我第一次听说“文档季”是我几个月前学习的一门课程的老师发来的，邮件内容是关于 REST API 文档。虽然我真的很喜欢这个想法，但我决定，我只有在能够真正认同这个想法的情况下，才会申请一个项目。除了平常工作之外，我还会做这件事，如果做这件事，一定会是有趣又有意义的事情。
当我看到 Open Food Facts 的介绍时，就知道自己发现了这个项目。 我喜欢通过运动和饮食来改善自己的身体和健康。我真的认为营养是快乐生活的关键之一，我们每个人都应该能够做出更好的选择，只有对所使用的食物和化妆品有足够的了解，才有可能实现这一点。Open Food Facts 将这些信息提供给我们，而我想为这一精彩的计划做贡献。
在过去的三年中，我一直在一家软件开发公司担任技术文档工程师，主要从事流程和发布自动化方面的工作。除此之外，我们通过 Swagger 实现了 REST API，使开发者能够通过 API 请求与我们的应用通信。我帮助开发团队为请求/响应撰写了更好的说明，并共同确定了客户需要哪些信息来以清晰简洁的方式提供这些信息。
我一直在查看当前的 Open Food Facts API 网站，我认为我们可以重新调整和完善文档，使其更便于用户使用（常规、读、写页面）。此外，我还想与开发团队一起设置一种根据代码自动生成 API 文档的方法（这需要时间，因此我提议长期开展协作）。
我们都知道外观很重要 ;) 因此，我们还可以调整 REST API CSS 和徽标，使 Swagger 界面与用户文档保持一致。
期待与您合作完成此项目！