网站开发文档要不要？换人接手时你就知道了

      写网站开发文档这事，是开发环节里最容易被砍掉的。理由听起来都挺充分：工期紧、代码里注释都有、文档写了也没人看。等哪天原班人马散了，换个新人接手，这些理由一个都站不住。

我见过最典型的情况：接手的人打开项目，数据库几十张表没有一张说明，核心业务逻辑全写在一个两千行的文件里，配置项是什么意思只能靠猜。光搞明白“原来的人是怎么想的”，就耗掉大半个月。这半个月要是当初写文档花三天，早就省下来了。

      文档不用写成论文，实用就行。三样最要紧：一是环境说明，怎么把项目在本地跑起来，依赖什么版本；二是数据结构和核心业务的说明，哪张表存什么、下单流程怎么走的；三是部署和发布流程，怎么打包、怎么上线、出问题怎么回滚。有这三样，换人接手基本能在一周内上手，没有的话，就是一场漫长的考古。

所以别再问网站开发文档要不要了。它平时看着没用，换人那天就是救命稻草。写文档不是给别人看的，是给未来的项目留条活路。