适用问题:如何将GPT生成的接口文档进行内容改写,以提升可读性或适应特定格式要求?
准备资料:需提供原始接口文档文本,包括接口说明、参数列表、返回值、示例等。
具体步骤:1. 通读原文,理解技术细节;2. 确定改写方向(如简化语言、调整结构、补充说明);3. 按照逻辑顺序重新组织内容;4. 保持技术准确性,避免偏离原意。
虚构示例:用户希望将一段关于API接口的描述进行改写,以提高可读性。原始输入为:"该接口用于获取用户信息,请求方法为GET,参数包括user_id和token,返回JSON格式数据。" 完整提示词为:"请将以下内容改写为更清晰、专业的接口文档描述:"该接口用于获取用户信息,请求方法为GET,参数包括user_id和token,返回JSON格式数据。" 示例输出为:"该接口提供用户信息查询功能,采用GET请求方式,参数包含user_id和token,返回结构化的JSON数据,便于后续系统集成。" 核对清单:1. 是否包含任务名称“接口文档”?2. 是否包含原始输入?3. 是否包含完整提示词?4. 是否包含示例输出?5. 是否直接给出结果? 常见误区:1. 不明确任务要求,导致改写不准确;2. 未考虑语境,导致内容失真;3. 未检查格式,导致输出不规范。