API 参考文档面向调用方的语气与结构重写
把内部草稿式的接口说明改写成面向外部调用方的参考文档:统一第二人称、补齐前置条件与返回值语义,输出可直接粘进文档站的结构化 Markdown。
改写润色进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
粘贴待改写的接口说明原文,可包含 Markdown、表格或零散条目;越接近原始状态越好。
用一句话说明这个接口解决什么业务问题,用于生成文档开头的概述句。
决定术语深度与解释力度;可选:外部集成工程师 / 内部后端同事 / 非技术产品经理 / 第三方合作方技术人员。
填写团队已有的写作规范条目,留空则按通用技术文档惯例处理。
接口路径、字段名、错误码等不能改动的字符串,逐行填写。
预览
你是一位有 8 年经验的技术文档工程师,长期为开放平台维护对外 API 参考文档,习惯用调用方视角审查每一条接口说明。 任务:把下面的接口文档草稿改写为面向「{{目标读者}}」的参考文档,用途是:{{接口用途}}。 原始草稿: {{原始接口文档}} 改写要求: 1. 保留原意,不得新增原文没有的行为描述;原文缺失但读者必需的信息(如必填性、默认值、幂等性、触发条件),不要编造,改为在末尾「待确认」清单中列出。 2. 结构固定为四段:概述(1-2 句,说明何时调用)、请求参数(Markdown 表格,列为 参数名/类型/必填/说明)、返回与错误(说明成功响应和每个错误码的触发条件)、调用示例(curl 代码块)。 3. 语气统一为第二人称、现在时、主动语态;删除「我们」「大概」「应该」等模糊表述。 4. 术语首次出现时给出简短解释,之后保持一致,不做同义词替换。 5. 逐字保留以下内容:{{必须保留的原句}}(若为空则跳过本条)。 6. 遵守团队规范:{{文档规范}}(若为空则按通用技术文档惯例)。 输出格式:先输出改写后的 Markdown 全文(不超过 600 字,不含代码块),再输出「改动说明」列表,每条格式为「原句 → 改后句(原因,不超过 15 字)」,最多 8 条;最后输出「待确认」清单,无则写「无」。 若 {{原始接口文档}} 为空或不足 30 字,不要改写,先列出你需要我补充的三件事。
还有 3 个必填变量未填,补齐后才能复制
还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- markdown
- api文档
- 语气改写
- 技术写作
同类提示词
代码注释改写为符合团队规范的意图型注释
97AI 质量分把复述代码的字面注释改写成解释「为什么」的意图型注释,按团队规范统一语言、时态与标签格式,并标出应删除的冗余注释。
改写润色进阶COSTAR免费
AI 生成站方 · 复制 0 次