常言道,接口文档无人问津,并非读者懒惰,而是文档缺少“真实感”。若想让你用 MarsCode 生成的 API 对接说明免于被下游团队视为“又一份没人翻阅的文档”,核心诀窍在于:让它打开即见【src/integrations/payment/v3.ts第142行】这类精确到文件行的物理定位、带有情绪的 Code Review 评论、以及刚复现的报错堆栈——真实协作中,没人相信模板,只相信谁在哪一行改了什么、为什么改、改完是否测试过。

将 Git Code Review 评论原样喂入提示词
第一步,打开最近一次被驳回的 Pull Request 页面。找到最顶部那条带有火药味的评论,全选复制(对方括号、冒号、换行都不要放过)。例如:“【src/integrations/payment/v3.ts第142行】sign 字段拼接顺序与文档不一致,测试环境使用旧签名验签失败,已复现 5 次”。
接着,直接粘贴到 MarsCode 对话框的第一行。后面不加任何引导语,不加“请生成”“请说明”,不改标点、不删空格、不补句号。必须保留原始格式,删除任何一个符号都会让模型丢失行号锚定能力,转而返回通用校验逻辑。
这一步不可跳过。
绑定第三方系统的真实交互快照
要抓住真实感,有以下几种现成可用的方法:
方法一:贴出真实 HTTP 请求/响应体的前 10 行加后 10 行。从 Postman 或 Charles 中截取最新一次调用记录,复制 Raw 格式的 request headers 和 body 前 10 行,再复制 response status 和 body 前 10 行,粘贴到提示词末尾,标注“这是 2026-07-02 14:33:17 在沙箱环境的真实交互快照”。
方法二:注入下游系统错误日志片段。直接粘贴对方提供的错误日志原文,例如:“[ERROR] 2026-07-02T14:33:18.221Z gateway-service Invalid signature format: expected 'v3|timestamp|nonce|data', got 'v3|1678901234|abc123|...'”。不翻译、不概括。
方法三:写明你方调用时的真实限制条件。比如:“我方 SDK v2.4.1 不支持动态 header 注入,所有鉴权参数必须塞进 body;且超时阈值固定为 3s,不可配置。”
强制输出带可验证动作的段落
第一步:要求每段说明必须以动词开头。删掉所有“该接口用于……”“此字段表示……”这类句式,替换为“你调用前必须先调用 /auth/token 获取 access_token”“你收到 status=401 时,要立刻重刷 sign 并检查 timestamp 是否偏差>30s”。
第二步:禁用模糊时间表述。将“尽快校验”“建议在请求前完成”全部替换为“你发请求前 300ms 内必须完成 sign 计算,否则下游网关拒绝”。
第三步:插入一个真实失败案例的修复路径。例如:“上周三 15:22 出现批量 401,排查发现是前端 Date.now() 未转为秒级时间戳,修复方式:在 sign 拼接前加 Math.floor(Date.now()/1000)”。
第四步:指定输出格式为 Markdown 表格。列名固定为【字段名|你必须填什么|填错会怎样|在哪查正确值】,不允许合并单元格、不允许省略“填错会怎样”列。
