这条提示词适合 编程开发 / 文档撰写 / 文档 相关场景。你可以先看摘要理解用途，再按公式和完整提示词做改写。
行业领域
编程开发
提示词类型
文档撰写
适用场景
编程开发 / 文档撰写 / 文档
摘要说明
适用于“API接口文档撰写”场景的提示词模板。
提示词公式
接口名称 + 接口类型（GET/POST）+ 请求参数 + 响应参数 + 错误码说明 + 示例代码 + 注意事项 + 版本信息
完整提示词
撰写用户登录API接口文档，接口类型为POST，请求参数含username（字符串、必填）、password（字符串、必填、需MD5加密），响应参数含code（状态码）、message（消息）、data（用户信息），错误码说明为1001用户不存在、1002密码错误、1003账号已禁用，示例代码含请求和响应JSON，注意事项为密码传输需HTTPS、登录失败需3次限制，版本为V1.0，要求文档结构清晰、代码可运行。
核心关键词
参数清晰
示例完整
错误码详细
版本明确
优化技巧
- 要求AI"示例代码需真实可用"（可直接复制运行），避免伪代码；明确"错误码需详细说明原因和解决方法"（如"1002密码错误→提示用户重试"），提升文档实用性。
- ---