Write a Handover Document
Added 2026-10
Write a Handover Document — 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.