如何依赖文档驱动开发及管理

1. 传统的开发流程存在哪些弊端?

作为一名程序员我们比较熟悉的开发流程:

如何高效的实现项目研发及管理50.png

看起来好像是一个完美的前后端开发流程,其实在开发中存在很多的问题?

(1) 上图看起来时前后端分离,但是实际上前端依赖后端开发,因为往往前端的页面开发比较快,会出现持续等待Api接口,浪费大量的时间

(2) 前端和后端会因为接口不通,结果集的格式或者参数不正确,接口不够等问题等问题,争吵,讨论,导致接口请求时间长,服务器压力大,前端等待服务端修改接口,

(3) 开发直接通过原型开发,由于信息量不足,存在假设的情况进行开发,导致开发偏差,例如我们曾因为审批流的流程问题反复调整

(4) 随着验收不断临近的截止日期,大家都忙于开发功能,越来越没有时间编写文档,一但在验收中对文档的完整度和正确性提出要求,会非常的苦恼,而延长交付时间

2. 采用文档驱动开发的是优势

既然我们已经清除了传统开发存在,前后端依赖的问题,前端后端存在调试接口的问题以及文档等问题。那么我们对开发流程需要优化,我们把设计文档,开发文档放在最前面设计,看能否解决我们研发问题呢?

1.第一阶段:设计阶段

[图片上传失败...(image-c736c6-1621935973384)]

2.第二阶段:开发阶段

(1) 编写开发文档

参与人(UI,测试,服务端,前端)负责人,所有参与人并行开发

① 前端任务:产出接口文档(字段没有和数据库表字段对应)

 [图片上传失败...(image-c21e5-1621935973384)]

② 服务端任务:产出数据库模型和数据库,待产出数据库后,实现接口文档和数据库的字段对接,最终产出完整的API接口文档

  [图片上传失败...(image-db4920-1621935973384)]

③ 测试任务:根据产品原型编写测试用例

④ UI任务:根据产品原型制定整体设计风格

(2) 编写代码

① 服务端任务

根据相关文档按模块输出ap

[图片上传失败...(image-555459-1621935973384)]

② 前端任务

根据相关文档按模块编写功能,并提测

[图片上传失败...(image-d2a5f7-1621935973384)]

③ 测试任务

  1. 如果API文档有输出,按照接口文档测试API文档

  2. 如果前端有模块输出按原型需求文档测试模块

④ UI任务

按照产品原型文档设计页面

优势:

(5) 在设计阶段,开发设计阶段,只需要各端负责人进行评审和相关文档的输出以及标准的制定,无需所有开发人员接入,节省人力

(6) 在所有开发阶段中严格保证了所有开发人员的分离开发,无需相互依赖,充分减少每个端上人员的交流,真正的实现了多端分离

(7) 严格保证了所有开发人员在开发中有据可查,大大提高编写效率

(8) 减少了在研发周期人员更替,新员工上手难的问题

(9) 随着项目开发的完成,开发文档也完成,减少项目交付时缺少文档的尴尬

3. 如何采用文档进行管理

文档贯穿了整个项目,既然我们要依赖文档来进行开发,那么文档应具备以下特性,才能方便我们依赖他管理整个项目

1.可修改性

虽有的文档都是在前期编写的,可能会存在一些未考虑到的问题,所以更需要所有人员共同发现文档的缺陷,及时修改完善文档。

修改文档应该是由下向上逐级反应,最终有相关负责人评估后方可修改文档,研究各人以任何理由私自篡改文档。

2.正确性

在设计编写文档时,应该保证保证文档的正确性,不应将未确认,未评审的文档流入开发阶段,或者开发人员手中

3.同步性

在研发周期中不管是在任何阶段,任何环节如果需要修改文档,变更需求都应经过评审后,修改所有相关文档,不能只修改某一个文档,严格保证所有文档的同步性,避免多端开发不统一的问题

4.约束性

所有相关人员都应该严格遵守文档中的要求,按照文档开发,坚决避免私下确立开发方案,不按照相关文档开发测试

4. 如何依赖文档管理项目

项目管理非常帮的一种管理方式就是通过任务来管理项目,但是在实施中有一个很大的问题那就是如何把一个项目细分成任务,如果不能把项目有效的划分成任务,那么通过任务管理项目就无法实现,那么如何把一个项目有效的划分任务并管理呢?

1.通过项目原型文档和API接口文档等文档来划分任务

(1) 通过原型文档可以把项目划分成模块,在划分成最页面,组件等最小单元,以页面,组件给前端,UI设计分配任务是个非常不错的选择

(2) 因为API接口文档本身就是最小单元,那么服务端任务就非常容易划分

2.规划开发周期

通过任务计算开发周期,通过交付时间规划任务开发时间,正向反向论证,确保在交付时间内,完成项目,如果在交付时间内不能完成开发任务,方便前期就做各种预案,避免尴尬

3.建立里程碑

通过开发周期,任务完成度划分里程碑,让开发人员获得相应的成就感,并时刻保持激情

5. 文档编写标准

(略)

6. 开发标准以及要求

(略)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容