如需查看完整的文档索引,请参阅 llms.txt。在文档页面的 URL 末尾加上 .md 即可查看该页面的 Markdown 版本。
主导航
主题
Codex

Codex 使用场景

让文档保持最新

根据代码和其他资料自动更新文档。

难度 Easy
时间跨度 30m

让 Codex 对照源代码变更、公开文档、发行说明和 PR 的相关信息,有针对性地起草文档更新,并列出发布前的验证步骤。

最适合

  • 需要随产品行为频繁更新的开发者文档、README 文件、运维手册、示例和迁移说明。
  • 为技术产品维护文档的团队。

目录

    ← 所有使用场景

    让文档保持最新

    根据代码和其他资料自动更新文档。

    让 Codex 对照源代码变更、公开文档、发行说明和 PR 的相关信息,有针对性地起草文档更新,并列出发布前的验证步骤。

    Easy
    30m

    让 Codex 对照源代码变更、公开文档、发行说明和 PR 的相关信息,有针对性地起草文档更新,并列出发布前的验证步骤。

    Easy
    30m

    相关链接

    最适合

    • 需要随产品行为频繁更新的开发者文档、README 文件、运维手册、示例和迁移说明。
    • 为技术产品维护文档的团队。

    技能与插件

    • 如果您通过 GitHub 接收缺陷报告,可以查看议题、Pull Request、评论、代码审查中的讨论和未通过的检查。
    技能 使用理由
    GitHub 如果您通过 GitHub 接收缺陷报告,可以查看议题、Pull Request、评论、代码审查中的讨论和未通过的检查。

    起始提示词

    请根据以下资料更新 [product/feature] 的文档: - [this repo/source linked repo] 中有改动的源文件 - 提及新行为的现有文档页面 - 我在下方提供链接的议题、PR、发行说明或公开参考资料 接下来,请完成以下工作: - 找出用户能感知到的变化 - 只更新需要改动的文档 - 公开文档中不要包含尚未公布的路线图、客户的保密信息或仅供内部使用的背景信息 - 保留现有文档的结构、术语和交叉链接 - 运行与本次变更相关的文档检查 定稿前,请概述改动内容和已验证的事项,并列出无法通过可信来源证实的说法。 [link release notes or other references here]
    请根据以下资料更新 [product/feature] 的文档: - [this repo/source linked repo] 中有改动的源文件 - 提及新行为的现有文档页面 - 我在下方提供链接的议题、PR、发行说明或公开参考资料 接下来,请完成以下工作: - 找出用户能感知到的变化 - 只更新需要改动的文档 - 公开文档中不要包含尚未公布的路线图、客户的保密信息或仅供内部使用的背景信息 - 保留现有文档的结构、术语和交叉链接 - 运行与本次变更相关的文档检查 定稿前,请概述改动内容和已验证的事项,并列出无法通过可信来源证实的说法。 [link release notes or other references here]

    简介

    源代码变更时就同步更新文档,比等上几周再补写更容易让文档保持最新。Codex 可以查看改动过的代码和测试、发布说明、关联的议题以及 pull request 的上下文,然后沿用现有文档结构,仅针对受影响的内容起草更新。

    您可以用这个工作流更新开发者文档和 README、起草变更日志、编写迁移说明、维护运维手册,也可以用它维护其他需要跟进产品行为频繁变化的文档。

    使用方法

    1. 从您需要记录的变更入手。

      提供相关的分支、pull request、提交、议题或文件。如果文档面向公众,请明确要求排除尚未公开的路线图、客户的私密信息以及仅供内部使用的背景信息。

    2. 请 Codex 梳理变更涉及哪些文档。

      起草前,请它在现有文档中搜索功能名称、配置键、命令、示例及相关术语。

    3. 只更新说明此次变更所必需的内容。

      Codex 应保留现有页面结构、术语、交叉链接和 frontmatter。如果补充一条具体说明、添加一个示例或更新一个小节就足够了,应避免大范围重写。

    4. 验证更改。

      请 Codex 运行适用于该代码仓库的格式检查和文档检查,然后逐项说明文档中面向用户的表述有何依据。

    应向 Codex 提供哪些资料

    资料 用途
    改动过的代码和测试 让 Codex 分析代码的实际行为,有针对性地起草文档更新。
    公开的发布说明或产品文档 帮助 Codex 沿用公开资料中的术语,并准确说明功能的可用范围和当前状态。
    Pull request 或议题的上下文 说明变更的原因,以及哪些用户可见的行为值得关注。
    本地文档检查 让 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 pull requests,并据此更新文档:

    请在当前聊天中为上述工作流创建计划任务。获取 [this repo/linked repo] 中近期的所有 PR,并根据其中的变更更新文档。

    相关使用场景