夜雨聆风学习资料网

ARTICLE · 1134570

代码改完文档别落下

代码改完文档别落下

功能已经上线,过了两周却有人照着旧文档调用接口;参数早已变化,示例还能运行,却悄悄返回了错误结果。很多项目的问题,不是代码没人维护,而是文档永远慢一步。

可以把“同步文档”直接写进交给Codex的完成标准,而不是等开发结束后再想起来。

先让它根据本次代码差异,列出可能受影响的README、接口说明、配置示例和操作手册。不要凭文件名猜,而要检查文档里是否引用了改变的参数、命令和行为。

接着让它同时更新示例与说明,并运行示例或文档中的命令。无法验证的内容要明确标注,不能用看起来合理的文字补过去。

最后检查差异:代码改了什么,文档是否逐项对应;新增限制、默认值和迁移步骤有没有遗漏。

真正完整的交付,不只是系统能运行,还要让下一个使用它的人不会走错路。

收录于滕州AI老板圈
山东,3小时前,

相关学习资料