交接文档要写到什么程度

管理员 ·

交接文档最常见的失败,是写成了流水账:做了什么、改了什么。接手的人真正需要的不是历史,而是「遇到情况该怎么办」。

先写清楚系统现在长什么样

一张结构图、几条关键链路、依赖了哪些外部服务。这部分的判断标准是:新人照着能不能说出「用户点这个按钮之后发生了什么」。

再写清常见故障与处置

这是最值钱的部分。列出过去半年真实发生过的三五个问题、当时怎么判断、怎么恢复。有过实战记录的文档,比任何理论说明都管用。

最后写清坑与边界

哪些地方不能动、哪些参数改起来会出事、哪些看起来该优化但其实有历史原因。这些信息在脑子里不值钱,写下来能救接手的人一整周。

可以先做的几件事

小结一下:「交接文档要写到什么程度」的答案是:写到接手的人能独立处理第一个故障为止。