保持文档更新

Keep documentation up-to-date EngineeringCode

场景定位

用代码和其它来源自动化更新文档，减少文档漂移。本页把官方 use case 的章节、工具、起步提示词和检查点整理成中文执行流程，便于直接对照落地。

难度: 中级
时间跨度: 约 45-90 分钟

适合用于

需要把「用代码和其它来源自动化更新文档，减少文档漂移。」做成可复用流程的团队，且来源分散在 GitHub 等工具中
希望 ChatGPT 或 Codex 保留来源、检查点和可审阅输出的使用者
需要把「保持文档更新」从一次性对话变成可复查工作流的场景

Skills & Plugins

起步提示词

Update the [product/feature] documentation based on the following sources:
- the changed source files in [this repo/source linked repo]
- the existing docs pages that mention a new behavior
- any linked issue, PR, release note, or public reference I provide below

Then:
- identify what is user-facing
- update only the docs that need to change
- keep unpublished roadmap, private customer details, and internal-only context out of public docs
- preserve the existing docs structure, terminology, and cross-links
- run the docs checks that fit the change

Before finalizing, summarize what changed, what you verified, and any claims you could not prove from trusted sources.

[link release notes or other references here]

在 ChatGPT 中尝试

介绍

这一节对应官方流程中的「Introduction」。落地时围绕「保持文档更新」把目标、输入、执行步骤和验证证据保持在同一条工作流里。

操作要点：先把本节需要的来源材料、权限和上下文补齐，并关注 Codex 等相关来源或工具；缺失内容要明确标记，不要让 ChatGPT 或 Codex 隐式猜测。

操作要点：先把本节需要的来源材料、权限和上下文补齐；缺失内容要明确标记，不要让 ChatGPT 或 Codex 隐式猜测。

如何使用

这一节对应官方流程中的「How to use」。落地时围绕「保持文档更新」把目标、输入、执行步骤和验证证据保持在同一条工作流里。

Prompt Library

建议提示词

先界定范围

For Keep documentation up-to-date, first inspect the available sources and propose the smallest useful scope. Name the inputs, outputs, validation steps, permissions, and anything that needs approval before action.

交付前复核

Review the result for Keep documentation up-to-date. Check source coverage, assumptions, unresolved questions, and the evidence that proves the output is ready to use.