本页面包含有关 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 界面与用户文档保持一致。
期待与您合作完成此项目！