给对接方写一份联调手册
收录 2026-10
外部团队接你的接口总要来回问，把时序、字段和常见错误一次写清
有 [数量] 家外部团队要接我们的接口，每次都重复回答同样的问题。请写一份联调手册，包含调用时序图、必填字段与取值示例、鉴权与签名步骤、常见错误码及自查方法、以及联调环境的限制。输出：手册目录与各节要点、一个可直接复制的最小请求示例、联调前的自检清单。
本站原创
中文原文
使用示例
示例输入
有五家外部团队要接我们的接口，每次都重复回答同样问题，写一份联调手册。
输出应包含
- 含时序、必填字段与取值示例
- 给鉴权签名步骤与错误码自查
- 附最小请求示例与联调前自检表
复制前替换这些占位符 1
把方括号里的内容换成你的具体信息，替换后再粘贴给 AI。
[数量]
使用建议
手册里的示例要能真的跑通，过期示例比没有示例更浪费时间。
可以这样改
- 要求它先复述需求与约束，确认无误再写代码。
- 让它给出最小改动 + 回滚方式，而不是整文件重写。
交付物（这次应拿到什么）
- 可运行的最小改动（含直接可用的代码块）
- 影响面清单：改了哪些文件、哪些调用点要跟着改
常见错法
- 一次让它改十个文件，最后分不清哪处改动导致了新问题。
- 只贴报错不贴代码和版本，拿到无法落地的修法。
输出验收（怎么判断能用）
- 改动可运行、可回滚，且没顺手改无关代码。
- 边界条件（空值、超长、并发）有说明或测试。
适用场景与注意
- 适合：让它先复述需求和约束，再给最小可运行改动。
- 注意：贴报错时同时给版本号与最小复现，否则它容易给出看似合理但不适配的写法。