新手用trae生成接口文档需用填空式模板：第一步写清【适用场景】及触发条件；第二步注明角色与前置状态；第三步用三字段法说明错误码，并明确http状态码、前端动作建议及超时重试策略。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
新手用Trae生成接口文档常卡在写不好提示词，导致输出内容堆砌字段、缺失业务上下文、权限校验和错误反馈不明确，最终前端调用时频频报错却不知原因。
用填空式模板写适用场景
第一步：在提示词开头写【适用场景】+具体业务动作+触发条件+设备/网络状态。例如：“【适用场景】巡检员离线完成现场检查后，点击‘提交结果’按钮触发此接口，此时设备已恢复联网，需将本地缓存的JSON数据一次性上报。”
这一步必须写清楚，否则Trae默认按Web表单提交风格生成，会漏掉断网续传、批量合并等关键约束。
第二步：括号内注明角色与前置状态，如“(仅限管理员角色，工单状态为‘待分配’时可用)”。【不写这条，Trae生成的文档会缺失权限说明，前端盲目调用后收到403却无法定位原因】
三字段法写错误码说明
方法一：严格按顺序写出三个字段，用英文冒号+空格分隔：
【code】:1002
【message】:手机号已被注册
【reason】:用户提交的手机号已在系统中存在
param: phone
注意：param只写参数名，不加引号、不带值；多个参数出错也只写最核心的一个。
方法二：组合成自然语言文档片段，直接粘贴进“错误响应”章节：
客户端请求错误。错误码 1002:手机号已被注册。(用户提交的手机号已在系统中存在;关联参数:phone)
让失败路径可执行
第一步：列出所有可能HTTP状态码及对应业务含义，如400 → “检查项填写不全，需高亮缺失字段”。
第二步：为每个错误补充前端动作建议，不能只写“返回错误信息”，要写“前端应拦截该响应，弹出Toast提示‘网络异常，请稍后重试’，并启用本地草稿自动保存机制”。
第三步：注明超时与重试策略，例如“此接口超时设为8秒，失败后前端最多重试2次，第二次失败后进入离线缓存队列，下次联网时自动补发”。【不写这条，Trae默认不生成重试说明】
