Codex 用例
保持文档处于最新状态
使用代码及其他来源自动更新文档。
使用 Codex 对比源代码变更、公开文档、发布说明和 PR 上下文，然后在发布前起草有针对性的文档更新及验证步骤。
适用场景
- 需要跟踪频繁变更行为的开发者文档、README、运维手册、示例和迁移说明。
- 负责维护技术产品文档的团队。
目录
保持文档处于最新状态
使用代码及其他来源自动更新文档。
使用 Codex 对比源代码变更、公开文档、发布说明和 PR 上下文，然后在发布前起草有针对性的文档更新及验证步骤。
适用场景
- 需要跟踪频繁变更行为的开发者文档、README、运维手册、示例和迁移说明。
- 负责维护技术产品文档的团队。
技能与插件
- 当 GitHub 是你的 Bug 收集渠道之一时，读取 issue、拉取请求、评论、审查线程和失败的检查。
| 技能 | 为什么使用它 |
|---|---|
| GitHub | 当 GitHub 是你的 Bug 收集渠道之一时，读取 issue、拉取请求、评论、审查线程和失败的检查。 |
起始提示词
简介
文档与源代码变更同步更新最容易保持最新状态，而不是等到数周之后。Codex 可以检查已更改的代码、测试、发布说明、相关 issue 和拉取请求上下文，然后起草符合现有结构的限定范围文档更新。
将此工作流用于开发者文档、README 更新、更新日志草稿、迁移说明、运维手册，或其他任何需要跟踪频繁变更行为的内容。
如何使用
-
从需要记录的变更开始。
共享分支、拉取请求、提交、issue 或文件。如果文档是公开的，请明确指出未发布的路线图、私人客户详情和仅限内部使用的上下文不得包含在内。
-
让 Codex 映射受影响的文档。
要求它在起草之前，在现有文档中搜索功能名称、配置键、命令、示例和相关术语。
-
更新最小且有用的文档范围。
Codex 应保留当前的页面结构、术语、交叉链接和 frontmatter。当只需添加精确的注释、示例或更新特定小节就足够时，它应避免大范围重写。
-
验证更改。
要求 Codex 运行适合该代码库的格式化和文档检查，然后总结每项面向用户声明背后的证据。
向 Codex 提供什么
| 来源 | 为何有帮助 |
|---|---|
| 已更改的代码和测试 | 让 Codex 分析实际行为，从而起草有针对性的文档更新。 |
| 公开发布说明或产品文档 | 帮助 Codex 匹配公开的术语、可用性和功能状态。 |
| 拉取请求或 issue 上下文 | 解释变更发生的原因以及哪些面向用户的行为是重要的。 |
| 本地文档检查 | 在文档发布前为 Codex 提供明确的完成定义。 |
添加更多上下文（如公开发布说明）可以让 Codex 避免包含私有上下文或尚未公开的更新。
使工作流可重复
对于整个代码库的约定，请将文档期望添加到 AGENTS.md。例如：
## Documentation
- When user-facing behavior changes, check whether docs, examples, or changelogs need updates.
- Public docs must only include public information or behavior visible in this repo.
- Preserve existing terminology and frontmatter.
- Run the docs formatting and build checks before final handoff.如果流程包含更多步骤，请将其转换为 技能 以便未来的 Codex 线程可以遵循相同的源代码检查、起草和验证循环。请参阅 将工作流保存为技能 其中分享了有关此模式的更多细节。
您还可以将此工作流转换为 会话自动化 通过要求 Codex 按计划运行来实现自动化，例如要求它从 GitHub 获取所有最近的 PR 以自动保持文档最新，比如按周执行：
