部署文档撰写经验分享

2011年，公司调我和几个同事去广西，与现场的同事一起撰写部署文档。去之前还感觉领导有点小题大做，写个部署文档至于么？我在公司半天就能写出一版了，还叫这么多人跑到广西写这个，真是崽卖爷田不心疼，公司费用随便花。
到了广西，负责人说了下部署文档的要求：简单明了、傻瓜部署。简单明了指的是文字清楚、不能有歧义、不拽文、精练。傻瓜部署指的是文档要写好每一步的操作，傻瓜拿着这个文档都能部署，不需要有专业的知识。
部署文档分为平台程序部署、数据库部署、业务开通部署等模块，笔者分到数据库部署这一块。平时我做部署时，对数据库安装有一些疑惑，趁此机会，把数据库版本选择及部署这块也熟悉了一下。首先确认数据库版本，下载版本后一步步安装，并把每一步的截图都放到文章里，即使只是点击下一步即可的截图也放进去。经过十几次部署后，把部署过程中遇到的各种问题，和自己的一些疑问也记录下来，并做说明解答。
数据库部署完毕后，开始做数据库建立，数据备份导入。日常做数据库割接升级前，一定要做数据库备份，并做备份还原验证，看看备份后的数据是否能成功还原。然后再做数据割接升级。以一次升级割接数据库为例，写明这次割接的范围、变更情况。把割接脚本每行写上注释，及是否需要根据本省情况进行调整。撰写割接升级脚本时，把数据库IP地址、库名等标红。各个省份现场升级时，修改为本地的数据库地址和库名即可。最后写上FAQ，把一些日常工作答疑时，大家常问的一些数据升级问题和解决方案写上。
最后写数据割接脚本后，如何确认是否迁移升级成功，提炼了几条list清单，按照这几项检查，基本上能够确认本次升级成功。
文档撰写完毕后，我们几个互相交换了下文档，严格按照他们写的文档一步步操作，看是否能够成功完成升级。然后整合大家提的意见，增加了部分自己认为是常识，未做说明或未写上的事项。
两周后，部署文档撰写完毕。发给各省，果然收到各省的一致好评。省份同事说，以前做升级割接时，都是先研究下部署文档，然后重新写一版部署文档，过程中还需要请教研发、DBA、技术支持等人员。现在直接按照这份文档进行升级即可。大大减少了省份的工作量，也减少了部署出现问题的几率。
笔者后面也去了几个省份做升级割接，发现每次升级割接时，按照之前撰写的那版文档，稍作改动，调整成本次的脚本和程序即可完成升级。而且根据文档后面的检查list清单，基本上能够保证99%以上的功能点都能使用。而不是之前升级后，自己随机选取一些页面进行确认，自我感觉没有问题，但第二天客户使用时发现一堆问题。
笔者后来负责一个群组项目，刚接手时就赶上五六十个省份并发检查测试。省份维护人员对如何部署程序一无所知，全靠总部几个研发测试人员全国奔波升级，大家当时苦不堪言，其中一个人一个月跑了十几个省升级。第二年我就召集各个省份的负责人来京，每个省份分配了几项，总共61项。让他们写自己负责那几项的部署确认，问题检查，疑点剖析等，然后让大家做交叉检查。历时两周完成了这版文档，之后的几年内，检查项也有调整，也出现过几次五六十个省份并发测试检查。但省份再也没有提出部署割接的支持需求。
很多人对部署文档都存在错误的认识，认为其只是一个简单的文档，随便一个人写写就行。殊不知它是系统上线交付用户使用的关键一环。前期需求调研反复修改确认，研发熬夜熬肝开发等，经历了万里长征到最后胜利在望时，因为部署升级的问题，导致好多功能不能正常使用，给客户留下公司不专业的印象，那该多冤呢。
部署升级是现场维护人员日常维护的一项重要的指标和工作内容。如果公司总部不把部署文档写好，而靠各个现场根据自己的经验和技术能力去保证割接升级的成功率，维护公司的形象。各个现场的人员水平层次不齐，而且各个现场维护人员做升级割接时，也不能保证自己的思路和想法能够完美覆盖公司的所有检查项。那么升级割接的成功率可想而已，客户对公司的印象也可想而知了。

部署文档撰写经验分享相关推荐

如何在WPS一个文件中以链接形式插入另外一个文件？WPS文档插入经验分享
1.打开WPS软件,打开原文件A 2.点击文件上方WPS插入选项,点击对象,弹出"插入对象"对话框 3.先点击由文件创建,再点击浏览选择需要插入的文件 4.点击需要插入的文件,再点 ...
Blog_mini完整部署文档
为了使广大朋友能够使用上开源博客系统Blog_mini,作者撰写了非常详细的部署文档,涵盖在CentOS与Ubuntu上的详细部署方案,力求:只要看了部署文档,就一定可以把Blog_mini成功部署! ...
服务器安全部署文档（转载）
转载链接http://www.cnblogs.com/EmptyFS/p/3547796.html 年前一直在赶项目,到最后几日才拿到新服务器新添加的硬盘,重做阵列配置生产环境,还要编写部署文档做好安 ...
杂谈PPT文档撰写(原创)
Normal 0 7.8 磅 0 2 false false false EN-US ZH-CN X-NONE杂谈PPT文档撰写说到PPT,其实更是一门学问:运用起来说简单也简单,说复杂也是很复杂. ...
2022最新IntellJ IDEA的mall开发部署文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
MRD文档撰写方法与技巧
继上一篇<BRD文档撰写方法与技巧>,今天又给大家分享一篇原创的<MRD文档撰写方法与技巧>,希望大家能互相学习,互相分享,一起折腾. 何谓MRD? 同样在了解MRD涵盖那些方 ...
（六）MkDocs学习——部署文档
mkdocs学习笔记系列 (一)MkDocs 学习--快速开始 (二)MkDocs学习笔记--撰写文档 (三)MkDocs学习--配置主题 (四)MkDocs学习--自定义主题 (五)MkDocs学习 ...
Hyperledger-indy indy-node部署文档
撰写目的 Hyperledger-indy官方提供的indy-node手动部署文档较为简略且为全英文,本人在初次搭建节点时走了一些弯路,因此希望能为初次接触Hyperledger-indy的小伙伴提供 ...
loganalyzer部署文档-（第一部分）
loganalyzer部署文档环境准备: 简介 LogAnalyzer 是一款syslog日志和其他网络事件数据的Web前端.它提供了对日志的简单浏览.搜索.基本分析和一些图表报告的功能.数据可以从 ...

部署文档撰写经验分享

部署文档撰写经验分享相关推荐

最新文章

热门文章