ChatGPT 软件文档核对技能:对齐 CLI 参数、接口签名和示例
EnglishChatGPT 安装步骤
- 打开固定提交的 .claude/skills/documentation-review/SKILL.md,核对原文的输入和输出。
- 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 按下面的工作流程填写技能规则。提供当前接口或 CLI 帮助输出、文档摘录和版本信息。
- 保存技能,在新对话输入本页的虚构示例并核对结果。
中文摘要
使用当前版本的实现片段和帮助输出检查 README、接口文档及变更记录。为每个不一致项写出处和可验证的改稿。
SKILL.md 中文导读
可复现示例
虚构 README 中预设工具使用参数 `--count`,当前版本帮助输出只列 `--amount`。另有示例未注明版本。请给核对表与改稿。工作步骤
- 对照实现和文档中的选项与参数。
- 检查示例、公开签名和版本记录。
- 逐条给改稿和需核实的版本证据。
验收方法
记录两个文本的位置和版本关系。仅在确认当前发布版也使用 `--amount` 时更新该版示例,同时保留适用版本。
GitHub 原文 · 更新日期
适用环境
需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。
常见问题
当前分支与最近发布版不一致怎么办?
分别标明分支和发布版的证据。先确定所维护的文档版本,再更新与它对应的帮助示例。