ChatGPT 开发者文档审稿技能:先修读者卡点和示例缺口
EnglishChatGPT 安装步骤
- 打开固定提交的 .claude/skills/review-docs/SKILL.md,核对原文的输入和输出。
- 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 按下面的工作流程填写技能规则。提供目标文档、相邻页面、共享片段和读者完成的任务。
- 保存技能,在新对话输入本页的虚构示例并核对结果。
中文摘要
阅读文档及相邻页面,核对第一句、前置条件、示例、共享片段和一致性。按影响标出最先需要修改的内容。
SKILL.md 中文导读
可复现示例
虚构 CLI 指南解释如何同步,但首屏没有命令,示例需要配置文件且未说明,另一页已有共享配置步骤。请给三条改稿建议。工作步骤
- 检查任务入口、前置和实用示例。
- 核对相关页面的结构与复用。
- 按清晰度和完成影响给改稿顺序。
验收方法
优先补最小命令和配置先决条件,建议复用现有说明链接。按位置标注示例预期与格式问题。
GitHub 原文 · 更新日期
适用环境
需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。
常见问题
为了简洁可以删掉前置条件吗?
保留会改变能否成功执行的条件。可把详细设置放到已确认的共享片段,再给读者明确入口。