GPTbot

编程辅助

GPT接口文档事实核查使用方法教程

本教程指导用户如何使用GPT进行接口文档的事实核查工作,涵盖准备资料、具体步骤、虚构示例、核对清单及常见误区。

更新:2026-11-07 · AI生成内容,请自行核对

一、适用问题

用户需要对API接口文档进行事实核查,确保其内容准确无误,符合实际业务逻辑和规范要求。

二、准备资料

需提供接口文档文本,包括接口描述、参数说明、返回值、错误码等信息,并确保文档版本清晰,无歧义。

三、具体步骤

1. 通读接口文档,理解整体结构和内容。
2. 对关键参数、返回值、错误码进行逐一核对。
3. 比较文档内容与实际业务逻辑,验证是否一致。
4. 检查文档格式是否规范,如是否包含必要的注释、版本信息等。

四、虚构示例

原始输入:
"接口文档内容:用户可使用GET方法获取用户信息,参数包括user_id(整数)、status(字符串),返回值为用户详细信息。
"完整提示词:
"请对以下接口文档进行事实核查,确保其内容准确无误。文档内容为:用户可使用GET方法获取用户信息,参数包括user_id(整数)、status(字符串),返回值为用户详细信息。请检查参数类型、返回结构是否符合实际业务逻辑,并验证是否存在歧义或错误。"

示例输出:
"接口文档内容正确,参数user_id为整数,status为字符串,返回值结构合理,无歧义。文档版本清晰,符合实际业务逻辑。

五、核对清单

1. 参数类型是否正确?
2. 返回值结构是否清晰?
3. 是否包含必要的注释或版本信息?
4. 是否存在歧义或错误描述?
5. 文档格式是否规范?
6. 是否符合实际业务逻辑?
7. 是否有遗漏的关键信息?
8. 是否有重复或冗余内容?
9. 是否有遗漏的错误码或说明?
10. 是否有需要进一步澄清的内容?

六、常见误区

1. 仅关注文档表面内容,忽略实际业务逻辑。
2. 未验证参数类型与实际业务匹配,导致误用。
3. 忽视文档版本信息,导致信息混淆。
4. 未检查文档格式是否规范,影响阅读体验。
5. 未核实错误码与实际错误情况一致,影响用户体验。
6. 未进行多角度验证,如与实际系统交互测试。
7. 未考虑不同用户群体的使用场景,导致文档不完整。
8. 未进行持续更新维护,导致信息过时。