Skip to content

官网文档更新机制

Agently 的能力变化通常同时影响代码、示例、release notes、兼容说明和官网文档。官网不是 framework docs 的自动镜像;公开文档需要按读者路径重新整理。

更新顺序

  1. Framework release 先完成代码、示例、release notes 和 compatibility 信息。
  2. 官网刷新 release 事实,确认哪些页面受影响。
  3. 按读者路径更新公开文档:入口页、核心教程、案例和参考页。
  4. 运行构建和内容检查,确认没有重复页面、断链和前台内部说明。

这样做的好处是:release 事实来自 framework release,官网文档仍然保持产品手册的阅读质量。

每次 release 后检查什么

检查项关注点
首页当前版本、能力入口、案例链接是否仍准确
文档首页推荐阅读路径是否需要调整
能力地图新能力是否改变“按问题选能力”的判断
核心教程API 名称、推荐入口、代码示例是否仍正确
术语表新术语、迁移术语、兼容状态是否需要更新
案例示例文件是否仍存在,输出说明是否来自真实运行

什么不应该自动发布

  • 只刷新了资料来源,但没有重写和校对的页面。
  • 带有维护者备注、站点规划、同步说明的前台内容。
  • 未验证的客户承诺、性能结论或生产效果。
  • 旧 API 被误写成新项目推荐入口的文档。

读者可以从哪里确认版本