成为赞助商——支持中文 Agent 生态

了解赞助
库Agent场景库
← 返回用例列表

用 Agent 更新 AI CLI 工具文档页

对照最新 CLI 行为与帮助输出,自动刷新文档页中的命令、参数与示例,提交可审改动。

场景说明

AI CLI 迭代快,文档易过期。Agent 读取帮助输出与仓库示例,比对文档页,生成补丁式更新(新增旗标、废弃说明)。人审后合并。不编造未发布的命令;示例需可运行或标明伪代码。

案例叙事

01他们做了什么

作者在 Substack《Devin - First Impressions》里写过一条具体任务:让编码 Agent(文中为 Devin)更新自己站点上「AI 编程相关 CLI 工具列表」页面——先摸清现有条目的格式,再从该工具 GitHub 仓库取一句描述,按同样版式把新工具加进列表。作者自述约 5 分钟内拿到第一版 PR;过程中出现「当前日期认知错乱」(一度把 2024-12 当未来日期),经 CLI `date` 与来回纠正后才改对页上日期。公开文未给出文档新鲜度、错误命令率或人审驳回率等量化。

国内落地可把「帮助输出 / 变更日志 / 仓库示例」与现有文档页一并交给 Agent,只生成补丁式 diff 与文档 PR;每个示例旁标注测过的版本号,废弃命令保留「迁移到」链接。硬约束:文档改动必须人审后再发布/合并,禁止编造未发布旗标或伪造成熟度;示例需可运行或明确标为伪代码。审阅意见与待合并清单可同步飞书/企微文档群。

02实际效果

  • 源未披露文档新鲜度、错误命令检出率或人审驳回率等量化;公开文只描述「列表页格式对齐→GitHub 一句描述→开 PR」的文档更新任务。
  • 作者自述:该 CLI 工具列表页更新任务约 5 分钟内拿到第一版 PR;中间因日期认知问题需来回纠正后才改对页内日期(文章陈述,非我方实测)。
  • 文档从「手抄过期帮助」变成可审的补丁式 PR;是否合入与对外发布仍由人决定。

03值得知道

  • 公开源未给出可复用的文档质量基线,上线后需用自有 CLI 版本矩阵复盘,勿把「出过 PR」当成文档正确承诺。
  • 硬约束:文档改动须人审后再发;禁止编造未发布命令/旗标;示例旁保留版本号,废弃项须给迁移链接。
  • 模型可能弄错日期或漏扫页面;合并前用帮助输出与真实 `--help` 对照,飞书/企微讨论勿贴生产密钥。

04可复制提示词

CLI 文档差异补丁草案

你是 CLI 文档更新助手。对照「帮助输出/变更日志」与「现有文档页」,只输出可审的中文差异说明与补丁草案。禁止编造未出现在帮助输出里的命令或旗标;不确定处标「待确认」。

输出 Markdown:
## 新增(命令/旗标/示例 + 依据摘录)
## 修改
## 废弃(保留「迁移到」)
## 示例旁建议标注的版本号
## 需人审项
## 非目标(本轮不改产品代码/不直接发布)

帮助与文档:
{{cli_help_and_docs}}

文档 PR 人审清单(飞书)

把文档 diff 压成可贴飞书/企微的人审清单(≤180 字):改动摘要、须人工核对的命令、是否允许合并发布。明确写「待人审,未发布」。不要添加未提供的下载量或兼容性承诺。

diff 摘要:
{{docs_diff}}

怎么做

  1. 拉取 CLI 帮助/变更日志与现有文档
  2. 生成差异补丁与示例更新
  3. 开文档 PR,人工核对后发布

实用提示

  • 每个命令示例旁标注测试过的版本号
  • 废弃命令保留「迁移到」链接,避免死胡同
#文档#CLI#AI工具#内容#开发者