Write an Integration Onboarding Guide
Added 2026-10
Write an Integration Onboarding Guide — Chinese original prompt
有 [数量] 家外部团队要接我们的接口，每次都重复回答同样的问题。请写一份联调手册，包含调用时序图、必填字段与取值示例、鉴权与签名步骤、常见错误码及自查方法、以及联调环境的限制。输出：手册目录与各节要点、一个可直接复制的最小请求示例、联调前的自检清单。
Site original
Chinese original
Example
Sample input
有五家外部团队要接我们的接口，每次都重复回答同样问题，写一份联调手册。
The output should include
- 含时序、必填字段与取值示例
- 给鉴权签名步骤与错误码自查
- 附最小请求示例与联调前自检表
Replace these placeholders 1
Swap the bracketed parts for your own details before sending.
[数量]
How to use
手册里的示例要能真的跑通，过期示例比没有示例更浪费时间。
Try tweaking it
- Have it restate requirements and constraints before writing code.
- Ask for the smallest change plus a rollback path, not a full-file rewrite.
What you should get
- A minimal, runnable change with copy-ready code
- Impact list: which files and call sites must follow
Common mistakes
- Asking it to touch ten files at once, then losing track of what broke what.
- Pasting only the error, with no code or version, and getting an unfixable answer.
How to check the output
- The change runs, can be rolled back, and touches nothing unrelated.
- Edge cases (empty, oversized, concurrent) are covered or explained.
Where it works
- Good for: having it restate requirements and constraints, then propose the smallest runnable change.
- Watch out: include versions and a minimal reproduction with the error, or the fix may look plausible but not fit.