docs-sync:OpenAI 官方文档同步神器,治文档和代码不同步的良药
有多少开发者被文档和代码不同步折磨过?API 文档写的是 v1 参数,实际代码早就切到 v2 了;新加的功能没人更新 docs/,用户照着文档调半天报错……
今天推荐一个 OpenAI 官方出的 Skill,专门治这个病——docs-sync。
它的工作逻辑非常清晰:先确认分析的分支范围,然后从代码主分支提取所有公开接口、配置项、环境变量、CLI 命令,生成一份「功能清单」;接着逐页 review docs/ 目录下的文档,对比这份清单找出三类问题:文档写了但代码没有(过时)、代码有但文档没提(缺失)、以及两者的描述不一致(错误)。
最后输出一份结构化报告,包含具体文件路径、证据、建议修复位置。用户确认后,它会直接改 docs/ 下的英文文档,并调用 make build-docs 验证站点还能正常构建。
整个流程完全自动化,而且很克制——只动英文文档,日语/韩语/中文目录一个字符都不碰。
这个小众但精准的 Skill 特别适合:SDK 维护者自己扫文档 Debt、AI 应用开发者检查第三方库文档、或者团队想建立 Code Review 附带文档 Review 的机制。
安装数目前只有 25,属于还没被太多人发现的那种。趁早用起来。
GitHub:https://github.com/openai/openai-agents-python/tree/main/.agents/skills/docs-sync
GitHub: https://github.com/openai/openai-agents-python/tree/main/.agents/skills/docs-sync
评论区
0 条评论
登录后可评论。