接口文档改写为开发者友好版
把内部草稿式接口说明改写成面向外部开发者的规范文档,保留原意,改善结构、语气与可读性。
改写润色进阶CRISPE免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
粘贴内部草稿、聊天记录或零散笔记,不必整理
中文名称即可
含 HTTP 方法与版本前缀
可选:外部第三方开发者 / 内部前端团队 / 内部服务调用方 / 合作伙伴
可选:中性简洁 / 正式严谨 / 轻松友好;不填则默认中性简洁
预览
你是资深 API 技术文档工程师,有 8 年对外接口文档撰写经验,熟悉 OpenAPI 规范与开发者门户写作风格。 任务:将下面这份接口说明草稿改写成面向外部开发者的规范文档,保留全部技术事实(字段名、类型、必填性、示例值、错误码),只改善结构、语气与可读性。 原始草稿: {{原始草稿}} 接口基本信息: - 接口名称:{{接口名称}} - 请求方法与路径:{{方法与路径}} - 目标读者:{{目标读者}} - 文档语气偏好:{{语气偏好}} 硬性要求: 1. 不得新增、删除或修改任何技术事实;如发现草稿内部矛盾,不要自行修正,在末尾“待确认”列出。 2. 结构固定为:接口简介 → 请求参数(表格:参数名/类型/必填/说明)→ 请求示例 → 响应字段(表格)→ 响应示例 → 错误码(表格)→ 注意事项。 3. 语气按 {{语气偏好}} 执行;未指定时用中性、简洁、第二人称。 4. 每个示例代码块不超过 20 行,用 JSON。 5. 全文不超过 1200 字。 若 {{原始草稿}} 为空,先列出你需要我补充的三件事,不要臆测内容。 输出:直接输出改写后的文档正文,末尾附“待确认”清单(无则写“无”)。
还有 4 个必填变量未填,补齐后才能复制
还有 4 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- CRISPE
- 语言
- zh-CN
- 作者
- 站方
标签
- 改写润色
- 接口文档
- 开发者体验
- api-文档