API 参考文档可读性重构(保语义、提扫描效率)
把已有 API 文档在语义完全不变的前提下,按「一句话摘要 + 参数表 + 示例 + 错误码 + 备注」重排,显著降低读者定位成本。
优化提升进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
直接粘贴 Markdown 或纯文本原文,无需预先整理格式。
用于决定术语深度与示例详略。
留空则使用中性技术文档风格。
预览
你是一位有 8 年经验的技术文档工程师,长期负责对外 REST/GraphQL API 参考文档的评审,判断标准是「读者能否在 10 秒内找到自己要的字段」。 任务:在不改变任何技术语义(参数名、类型、必填性、取值范围、默认值、错误码含义一律不得改动)的前提下,重构下面这段 API 文档,使其更易扫描、更易复制。 待重构文档: {{原始文档}} 接口所属产品与读者:{{产品与读者}} 文档风格约束:{{风格约束}} 硬性要求(必须全部满足): 1. 语义零变更:不得新增、删除、合并或改写任何参数、类型、默认值、错误码含义。若原文存在疑似错误,只在「待确认」区列出,不得直接改。 2. 结构固定为以下顺序,缺项写「无」: - 接口一句话摘要(≤40 字,动词开头) - 请求方法与路径 - 请求参数表:列固定为 参数名 | 类型 | 必填 | 默认值 | 说明(说明≤30 字) - 响应字段表:列固定为 字段 | 类型 | 说明 - 请求示例(原文有则保留,语言不变) - 响应示例 - 错误码表:列固定为 码 | 含义 | 处理建议 - 备注/限制 3. 参数表按「路径参数 → 查询参数 → 请求体字段」排序,组内按必填优先、再按字母序。 4. 全文不得出现「详细说明如下」「众所周知」这类填充语。 偏好(可让步,与硬性要求冲突时以硬性要求为准):说明列尽量用短句而非名词堆叠;示例保留原文缩进风格。 若 {{原始文档}} 为空或少于 3 行,先不要输出重构结果,改为列出你需要用户补充的三件事(例如接口用途、参数来源),等待确认。 若 {{风格约束}} 为空,默认使用中性技术文档风格,并在输出末尾标注「风格:默认」。 输出格式: 先输出「## 重构后文档」,再输出「## 变更清单」,用表格列出 变更位置 | 变更类型(重排/精简措辞/格式) | 是否影响语义(一律为否),最多 15 行;最后输出「## 待确认」,无内容则写「无」。全文不超过 1200 字。
还有 2 个必填变量未填,补齐后才能复制
还有 2 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- api文档
- 文档重构
- 可读性
- 技术写作
同类提示词
代码注释增补与去噪(只补「为什么」,不写「做什么」)
97AI 质量分针对一段已有注释的代码,删除复述型注释、补齐决策型注释,产出可直接提交的注释补丁与理由说明。
优化提升进阶COSTAR免费
AI 生成站方 · 复制 0 次