如何编写项目发布文档

今天在公众号上看到一篇文章，学习到了，顺便记下来自己的短板，如下：

• 发布文档如何写？

写发布文档的原则就是要写的尽可能详细，需求是什么，实现了哪些功能，发布时的步骤，注意事项，联系电话，发布日期等，最好是傻瓜式的，标准就是：只要按照发布文档写的进行操作就算在大街上随便抓个人过来部署都不会出问题。

这才是好的部署文档，很多人在写发布文档的时候很敷衍，基本用的都是模版，大纲都是有的，然后内容大概改一下就 OK，甚至文档编写人和电话都不改！有人会说很多运维和测试人员基本不看发布文档，浪费太多时间没必要，其实发布文档写的详细一些，不但会省很多时间，还会避免很多麻烦：比如避免测试人员部署或运维上线过程中出问题在联系开发人员去调试；而且发布文档写的详细也对开发人员自己有好处，可能过了很长一段时间后程序出问题了或者有人询问这个功能，开发人员可能自己都忘了，这时候，拿出发布文档一看清晰明了，会省很多时间！

更重要的是对接的人也会对这样的开发人员有一个靠谱的好印象，这里又涉及一个词：信任度，试想如果 QA 每次测你开发的程序都有很多问题，运维上线你开发的程序成功率很低，那很自然对你的信任度就会很低，即使是协同开发的项目出问题了，第一时间想到的可能就是你，而不是别人。

时间评估：

开发阶段大概只是花费整体开发时间的三分之一左右，评估开发时间的时候把自己的编代码时间大概乘以 2 或 3 基本是合理的。

用过即专家，这才是程序员的自我修养！