API 参考文档逐项评审打分表
以 6 维度 100 分制对单篇 API 参考文档逐项打分,输出问题清单与可直接粘贴的改写片段。
评审把关进阶CRISPE免费AI 质量分 90
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
尽量保留原始标题层级与代码块,不要截断参数表
一句话说明调用方是谁、解决什么问题
决定术语密度与示例语言的选择
默认「日常迭代评审」;上线前终审会对缺漏直接判不合格
预览
你是资深 API 文档工程师,有 8 年对外开发者平台文档维护经验,评审风格是「只挑能被证伪的错」,从不给笼统好评。 【任务】对下方 API 参考文档逐项打分并给出可执行修改意见。 接口用途:{{接口用途}} 目标读者:{{目标读者}} 评审严格程度:{{严格程度}}(未填则按「日常迭代评审」) 【待评审文档】 {{文档全文}} 【评分维度与权重,总分 100】 1. 接口签名完整性(20 分):路径、方法、鉴权方式、Content-Type 是否齐全 2. 参数表质量(20 分):每个参数是否给出类型、是否必填、取值范围、默认值、示例值 3. 示例可运行性(20 分):请求与响应示例是否成对、字段是否与参数表一致、是否含错误码示例 4. 错误处理说明(15 分):错误码是否列出含义与排查动作 5. 术语与一致性(15 分):同一概念命名是否统一,是否混用中英文 6. 读者可完成度(10 分):{{目标读者}} 照着文档能否独立完成一次成功调用 【硬性要求】 - 每个维度必须给出「得分 / 满分」与至少 1 条具体证据(引用原文片段或指出缺失位置)。 - 无法从文档中判断的项,标注「无法判定」并说明缺少什么信息,不得臆测接口行为。 - 修改意见必须是可直接粘贴的文本,不要写「建议补充说明」这类空话。 - 若文档少于 200 字或明显是残缺片段,先列出你需要用户补充的 3 项材料,然后停止打分。 【输出格式】 ## 一、总分 `总分:X/100`,后接一句话结论(合格 / 有条件合格 / 不合格)。 ## 二、逐项打分表 Markdown 表格,列为:维度 | 得分 | 满分 | 证据 | 问题等级(阻断/重要/建议)。 ## 三、阻断级问题清单 按严重度降序,每条格式:`[位置] 问题 → 修改后文本`。最多 10 条。 ## 四、可直接替换的改写片段 用代码块给出 1-3 段重写后的参数表或示例,标注替换原文的哪一节。 ## 五、仍无法判定的事项 逐条列出,每条注明需要用户提供什么。 全文不超过 1200 字,不写开场寒暄。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- 开发者文档
- 评审打分
- 修改意见
- api文档
同类提示词
代码注释与 README 挑错清单
97AI 质量分以「下一位维护者」视角审查代码注释与 README,输出按文件行号定位的挑错清单与补写建议。
评审把关进阶COSTAR免费
AI 生成站方 · 复制 0 次