客户端文档维护策略
客户端会自行更新,界面和参数随时可能变化。这一页说明我们如何让接入文档跟上变化,以及看到过期内容时怎么反馈。
最近核验
客户端接入文档以「最近核验」为准:表示在那一天有人按文档在真实客户端上完整走了一遍,确认步骤和截图与实际一致。
页脚的「最后更新」是另一回事——它来自 Git 提交时间,改一个错别字也会刷新。判断内容是否跟得上客户端版本,看核验信息。
核验周期
目标是 30 天内至少核验一次。每次核验检查:
客户端发布大版本时会提前核验,不等周期到期。
覆盖范围
策略适用于 Agents 和 ChatBot 两类客户端接入文档。
计费、错误码、API 端点这类文档不适用核验周期,它们跟随 ByteSeek 平台自身变更,改动时同步更新。
发现内容过期
文档与实际不符时,联系站内客服反馈,或按故障排查的模板提交问题。请附上客户端版本号——同一份文档在不同版本下的表现可能完全不同。