敏捷开发的技术文档管理

许多团队或个人都有一个观念是敏捷开发应该弱化技术文档管理，以达到敏捷的目的。其实不然，敏捷开发只是把开发的生命周期变成不断迭代的软件开发过程，在迭代的过程中应该包含了技术文档的整理完善，使其可以为下一个迭代做准备。而且，建立完备、便于理解并与代码配对的技术文档是软件工程师的基本素质。这种素质是独立的，不随软件开发方法的改变而改变的要求。

下面分享一些敏捷开发的技术文档管理实战经验，这些经验能驱动团队建立相对完善的技术文档。

建立任务(Ticket)的书写框架 - 建立Ticket的书写框架，以保证覆盖需求的必要信息。如：Story必须有背景(Background), 描述(Description)和验收标准(Acceptance Criteria)。
代码分支(Branch)和代码提交(Commit)必须与任务(Ticket)关联 - 工程师接到任务并建立Branch开始开发的时候，Branch名必须以Ticket代号为开头，如：ABC-1234-xxxxyyyzzz。在Commit的时候，提交标题也必须以Ticket代号为开头，并在提交中尽可能详细的描述提交的内容。这样可以最直观的关联代码与Ticket之间的关系，知道代码为什么而改。
设计文档应单独建立任务(Ticket) - 设计文档应单独建立Ticket。至少在总体设计时应该这么做。设计文档一般由架构师，技术经理，或技术负责人建立，并保存在项目的文档中，如Confluence或Wiki。文档应由开发团队审查并确认，由此确认开发的方向。设计文档视项目的进程可以加入迭代的过程。
善用README和注释Comment，并加入同行评议(Peer review) - 软件工程师应该养成良好的注释代码(Comment)的习惯，在添加或修改代码的时候添加注释。另外，可以利用README作为设计文档的补充，添加详细的设计思路。这些最佳实践可以通过Peer review建立良性的文档习惯，通过Peer review让评议者保证代码和文档可理解性。

良好的技术文档管理可以提高代码的质量，可读性和可延续性。可以减少团队对某一成员的依赖，也减轻了某一成员与一个系统的耦合度。为团队的扩大和增长提供良好的基础。

敏捷开发的技术文档管理相关推荐

市面售价2W的仿抖音短视频原生双端APP源码，带技术文档管理后台和数据库
这个短视频系统源码是2w某站购买来的仿抖音视频app,原生双端开发,带技术文档管理后台和数据库.非常适合用来做类似项目的基础开发框架,能节省大量的开发时间和试错成本. 除了直播没有开通,其他功能都是精 ...
HTML5开发APP技术文档
HTML5开发APP技术文档一.环境参数 1.技术语言:HTML.CSS.ES6.Node.js等: 2.框架:Vue.js 2.x.Cordova: 3.开发系统:mac.windows等: ...
使用Docker搭建RAP2(技术文档管理私服)
文章目录前言准备工作安装 mariadb及redis安装 rap2-delos安装 rap2-dolores 安装 nginx配置ssl正式及解决跨域问题安装确认使用说明前言技术团队,文 ...
ShowDoc 软件开发团队接口文档管理利器
ShowDoc是一个非常适合IT团队的在线API文档.技术文档工具.你可以使用Showdoc来编写在线API文档.技术文档.数据字典.在线手册. 这里介绍 Showdoc 这款开源(免费)文档管理系统 ...
jeecgboot前端开发_Jeecg-Boot 技术文档
## 2.4+ 新版本文档请移步到: http://doc.jeecg.com ## (重要的事情说三遍,注意注意注意啦!!!) *** --- __ ![输入图片说明](https://static ...
使用nodejs开发一个markdown文档管理小系统(一)Using Nodejs to quickly develop a markdown management system...
好多年没碰过前端jquery了,用一两天时间重温一下,刚好写个小工具, 不递归取文件夹和文件,只写一层,保持足够简单,验证和参数判断暂不写,毕竟只写了几个小时而已,功能算完备了,添加一个简单的管理员权 ...
整理全网文档管理平台，持续跟更新
文档管理系统不会写文档得程序猿不是好程序猿,在日常工作中,几乎无时无刻离不开文档,也使用过很多文档管理平台,特此记录下. 1 MrDoc 地址:https://gitee.com/zmister/M ...
egg+vue+mongodb实践开发在线文档管理平台——水墨文档
授权转载自:围的围 https://segmentfault.com/a/1190000037621367 前言团队中会遇到在线文档管理的需求,包括技术文档,接口文档, excel 文档,和产品原型 ...
开发管理---配置管理与文档管理
随着软件规模和复杂性的增大,许多大型开发项目往往都会延迟和超出预算,软件开发不得不直面越来越多的问题,表现为开发的环境日益复杂,代码共享日益困难,需跨越的平台增多:软件的重用性需要提高:软件的维护越来 ...

敏捷开发的技术文档管理

敏捷开发的技术文档管理相关推荐

最新文章

热门文章