部署文档撰写经验分享

2011年，公司调我和几个同事去广西，与现场的同事一起撰写部署文档。去之前还感觉领导有点小题大做，写个部署文档至于么？我在公司半天就能写出一版了，还叫这么多人跑到广西写这个，真是崽卖爷田不心疼，公司费用随便花。
到了广西，负责人说了下部署文档的要求：简单明了、傻瓜部署。简单明了指的是文字清楚、不能有歧义、不拽文、精练。傻瓜部署指的是文档要写好每一步的操作，傻瓜拿着这个文档都能部署，不需要有专业的知识。
部署文档分为平台程序部署、数据库部署、业务开通部署等模块，笔者分到数据库部署这一块。平时我做部署时，对数据库安装有一些疑惑，趁此机会，把数据库版本选择及部署这块也熟悉了一下。首先确认数据库版本，下载版本后一步步安装，并把每一步的截图都放到文章里，即使只是点击下一步即可的截图也放进去。经过十几次部署后，把部署过程中遇到的各种问题，和自己的一些疑问也记录下来，并做说明解答。
数据库部署完毕后，开始做数据库建立，数据备份导入。日常做数据库割接升级前，一定要做数据库备份，并做备份还原验证，看看备份后的数据是否能成功还原。然后再做数据割接升级。以一次升级割接数据库为例，写明这次割接的范围、变更情况。把割接脚本每行写上注释，及是否需要根据本省情况进行调整。撰写割接升级脚本时，把数据库IP地址、库名等标红。各个省份现场升级时，修改为本地的数据库地址和库名即可。最后写上FAQ，把一些日常工作答疑时，大家常问的一些数据升级问题和解决方案写上。
最后写数据割接脚本后，如何确认是否迁移升级成功，提炼了几条list清单，按照这几项检查，基本上能够确认本次升级成功。
文档撰写完毕后，我们几个互相交换了下文档，