如何编写项目发布文档

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

发布文档如何写？

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

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

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

时间评估：

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

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

如何编写项目发布文档相关推荐

网站项目标准文档格式模版---网站项目建设流程概述（转）
网站项目标准文档格式模版---网站项目建设流程概述(转) 一.概念网站项目管理就是根据特定的规范.在预算范围内.按时完成的网站开发任务. 二.需求分析项目立项我们接到客户的业务咨询,经过双 ...
[团队项目]用户需求文档发布！
用Github浏览更好:Phylab-Web项目用户需求文档团队主页链接:http://www.cnblogs.com/buaase 用户需求分析文档版本号:v1.0.2 修订历史: 版本号修改 ...
Django+Linux+Uwsgi+Nginx项目部署文档
Django+Linux+Uwsgi+Nginx项目部署文档 WSGI 在生产环境中使用WSGI作为python web的服务器 WSGI:全拼为Python Web服务器网关接口,Python We ...
postman项目接口文档和登录步骤原理
培训内容实训项目:非常果岭-发现模块接口测试,单接口.流程脚本编写: 使用工具:postman 培训方式 1)postman使用说明 2)项目接口文档和登录步骤原理一.首先了解postman使用 ...
【总结】1056- 如何编写前端设计文档？
在笔者所在的前端研发流程中, [技术调研及方案设计]属于连接[需求阶段]和[开发阶段]的中间节点.在需求详评(三审)后了, 需求的功能和交互已经基本确定, 而在实际进入开发之前, 还有一些待确定的技 ...
【GitHub.io/Github Pages使用教程】从头开始搭建自己的Github Pages，打造个人博客网站，展示个人简历、项目、文档或想要与世界共享的任何其他内容
巨人半边莲如果你曾征服乞力马扎罗山,留意过海拔 3,657-4,267 米处的尖顶植物,这种植物有时形似绿色大柱子(或'花序'),从中间长出花序. 那么你就可能看到许多巨人半边莲,这些植物生长在非洲 ...
组件库系列三：编写组件库文档
文章目录 vuepress介绍创建文档工程配置运行指令 vuepress浏览器自动更新下载插件和依赖 npm/yarn link docs文件夹 .vuepress文件夹可收缩代码块效果展示 ...
数据挖掘项目总结文档
数据挖掘项目总结文档 1.文档概述 1.1 编写目的记录本次实验思路及流程,备忘用. 1.2 适用对象个人学习总结,描述有偏差之处陆续更进. 2.业务理解与分析定义 2.1 需求概述针对传统网络 ...
基于C++的OpenCV项目实战——文档照片转换成扫描文件
基于C++的OpenCV项目实战--文档照片转换成扫描文件一.背景前段时间都是基于Python的OpecCV进行一些学习和实践,但小的知识点并没有应用到实际的项目中:并且基于Python的版本的移 ...
关于用java编写生成word文档，动态添加数据到word文档的一些心得
关于用java编写生成word文档,动态添加数据到word文档的一些心得,经过翻阅了无数的有用的和无用的资料以后,总算找到了一种靠谱的方法 1.概述经过反反复复的查阅资料,总算找到了一个靠谱的生成w ...

如何编写项目发布文档

如何编写项目发布文档相关推荐

最新文章

热门文章