系统
浅色
深色2024 年 9 月 3 日，星期二 ·2分钟阅读
来自 Google Season of Docs 2024 项目的更新
返回博客Blessing Ene Anyebe
Valeria Hernandez
Dhairya Amrish Majmudar
Benjamin Granados
JSON Schema 文档项目
JSON Schema 的主要目标是 文档项目 是创建一个可扩展的文档架构，使其清晰、一致且全面。为了通过 Google Season of Docs (GSoD) 实现这一点，我们重点关注
- 规范文档的重构: 规范文档需要一个结构，帮助所有 角色 了解 JSON Schema 如何在不同的版本中演变以及每个版本中引入的功能。
- 信息架构的改进: 文档需要一个新的信息架构，更好地与 文档开发人员旅程 对齐，并根据 diataxis 框架 组织内容。新信息架构的目标是改进入门体验和内容可发现性。
GSoD 项目成果
自 5 月以来，该团队（Valeria Hernandez、Blessing Ene Anyebe、Dhairya Amrish Majmudar 和 Benjamin Granados）一直在努力实现这些目标。在文档方面，我们已完成以下工作
该团队还对网站进行了更改，例如目录和 上一页下一页 组件，旨在提高内容可扫描性和导航。
未来的道路
那么，还有哪些待办事项呢？我们目前正在处理 JSON 超级模式 和 迁移页面，它们是规范文档的一部分。
我们还记录了 文档贡献和文本格式指南，记录缺少的关键字（参见问题 951、952 和 961），以及编写分步指南（参见问题 180、950 和 954）。
结论
我们的文档工作每天都在扩展，您的贡献可以帮助改善它们。您可以通过以下几种方式提供帮助：
- 分解大型文档以改善文档网站的整体结构
- 为开发者旅程的故障排除和扩展阶段创建缺少的文档
- 为迁移页面做出贡献
我们的文档会议每两周举行一次，时间为每周二下午 3:00（UTC）。欢迎您加入 JSON Schema Slack 工作区 中的 #gsod24 频道，并向我们发送包含您的电子邮件地址的消息，以便我们将其添加到会议中。
感谢您对 JSON Schema 文档项目的兴趣，并期待您的贡献及其对更广泛开发者社区的益处。
JSON Schema 的 Google Season of Docs 团队。