专栏首页Java后端技术栈“杀”一个程序员不需要用枪,改三次需求就可以了!

“杀”一个程序员不需要用枪,改三次需求就可以了!

原文作者:CharlieChu

原文出处:https://www.cnblogs.com/charliechu

原文标题:《没有功能需求设计文档?对不起,拒绝开发!》

在很多软件公司,特别是一些创业型的团队中,对于这样的情景可能大家都很熟悉:项目经理或者产品经理(产品狗)口头或者简单记录一下软件产品的大致要做的功能,直接就让研发团队的兄弟(程序猿)去狂撸代码。然后他就去喝茶撩妹或者回家陪老婆了...

这种撸起袖子就开干的方式,看似简单高效,便于直接沟通,能够快速迭代。却不知,发现没有一份正规且实时更新的功能需求设计文档,会付出三四倍的代价来弥补。

最终会引发一场产品狗和程序猿之间的“猿狗大战”...

一、WHY - 为什么需要功能需求设计说明书

在没有功能设计文档时,主要有如下几个问题:

1、前期研究团队沟通成本

如何要让团队里面的所有人员对软件产品的功能需求设计有一个共识?没有功能设计文档,反正我是想不出有什么办法。当该项目的团队人员越多,沟通成本就变得很高。

研发人员很容易有一个通病:以为自己了解了一小块需求就立即开始埋头狂撸......代码。最终很可能与项目经理和客户真正想要的功能相差甚远。

更可怕的,研发人员把数据库设计好了,代码也已经写得差不多了,这时产品狗突然跑到程序猿这,说我们的需求要做一点变化,大家都知道,“对产品狗来说那一点变化,可能会害得程序猿撸过几天几夜”。那很小的变更可能导致之前设计的数据库,码的代码都不能用了。对于程序猿没有什么比加班加点写了几个月的代码,最终被产品狗告知需求变了,代码要删除重新写更可怕的。估计只能用涨工资来安慰一下那受伤的心灵了。

还有一个比较隐藏的事情是,每个程序猿都认为自己写的代码很牛逼(其实对于大多数人这只是一个错觉,你写得代码并不优秀),不太愿意删除之前所写的东西,总是想在原有的代码基础上进行修改,让他们删除代码比杀了他还难。

作为公司的技术负责人,我每几天都会Code Review团队里面所有人的代码,一直要求他们把不用的代码去掉,但他们的应对方式总是加两个//。注释掉他们写的代码,而不是去做真正的删除动作。他们总有自己的理由,“这只是暂时注释掉,后面会用到”,但最终的结果是那些代码就像尸体一样,一直在那里,干扰着团队人员正常的思路。所以我只能强制性让他们那些“暂时没有用,以后会用到的代码”干掉 。

2、前期任务进度安排和分配

该文档也是任务进度安排和分配的重要依据。在没有功能需求设计文档之前的所有任务进度计划都是瞎扯淡,都不知道具体要做什么东西,哪能拿出合理的任务进度计划。如果你拿出来了,我也不相信那是经过认真分析做的进度计划,我知道那只是用来看领导看的。

3、中期产品经理需求变更

软件在开发过程中难免会遇到功能的需求变更,将程序猿们召集在一起把所有的变更讲一遍?当走出会议室的时候可能每个人都有自己的理解。下一场战争已悄然临近...

4、后期测试团队产品测试

测试团队应该在项目Kickoff之时就应该介入,而不是在产品开发完成之后。测试团队应该对功能需求设计文档充分了解,且以此来编写具体的测试用例文档。否则,只能是在界面上进行简单的表面测试,而真正的BUG并不在表面,这些BUG会藏得很深,等发现的时候可能已经造成很大的损失。测试团队想覆盖全部的测试用例此时已经相当困难,他们甚至都不知道产品有哪些功能。

测试用例应该尽可能详细,尽量保证测试用例走完能确保产品能上线发布。下图为我们在登录注册时用到的一部分用例:

二、WHERE - 文档应该放在何处

功能说明文档一定要保持实时性,任何变更的需求,新增的需求都必须在该文档中体现。

一只产品狗(或一群)在编写完文档后,要发给项目经理、研发人员、销售人员、运营推广人员等人,如何保证每个人的文档都是最新的呢?如果通过QQ,邮件等方式,是不是每次更新都要重新通知所有人:“嘿,各位兄弟,文档作了一次修改,我给大家都重新发一份新的”。每个人电脑里面都有好几个版本的文档,时间长了,自己都忘记哪个文档是最新的;产品狗也记不清是否是所有相关的人都发了最新的文档。

研发人员可能会说通过SVN来作版本管理啊,给每个人分配一个帐号。“天啊,SVN是啥?”-销售人员、运营推广人员估计一脸懵逼。

更好的办法是通过团队实时协作的云端工具。从而实现分享和实时讨论,告别反复修改版本再发送邮件的麻烦。如果你会FQ,那你可以使用Google Docs、Office Online。否则你可以使用石墨文档、一起写。

三、WHAT - 什么是功能需求设计文档 & 应该包含那些内容

功能需求设计文档最重要的是描述产品所要包含的所有功能,越详细越好,可以结合产品的原型设计图来讲解。让项目所有相关人知道产品是什么,包含哪些页面,页面如何跳转等。

该文档是产品经理、项目经理、研发人员、销售人员、运营推广人员沟通的一个桥梁,一份好的功能需求设计文档是软件产品是否能成功的关键。

考虑是该文档的受众,这份文档不应该包含具体的编程技术上的说明。不管你是用C#/.NET、JAVA还是其它,这应该是另外研发团队内部使用的一份文档。

一般人第一反映就是去网上找一份功能需求设计文档模板,我个人感觉那些模板90%根本没有存在的必要。都太过形式化,不要没有实际意义和模板化的内容,只会使文档成为一个摆饰,反而是在浪费大家的时间。

那么一份合格的软件需求设计文档应该包括哪些内容呢?

1、项目背景

项目产生的实际背景、具体的运用场景、大致要解决什么样的问题、针对的阅读对象、版本修改记录、文档作者以及修改人信息。

2、详细的功能点描述

写明产品所包含的所有功能点,对功能、界面、接口的描述一定要充分详细,每处可以交互的地方都要给出具体的说明。再次强调,一定要详细描述每一个页面所拥有的功能。

3、产品不包含的功能点说明

除了写明产品所包含的所有功能点外,还应该写明软件所不包含的功能,这一点也很重要。

4、使用场景(画面感)

将复杂的业务逻辑融入到具体的使用场景中,更容易让项目经理、研发人员、销售人员、运营推广人员不同背景的人产生共识。

5、流程图

大家都知道“一图胜千言”,能用图说明的尽量用图来说明,只通过大量枯燥的文字可能效果并不太好。流程图是一种用图形表示逻辑和算法的工具,特别对研发人员撸代码很有帮助。 Windows用户可以使用Visio,Mac用户可以使用OmniGraffle,还可以使用免费在线作图,实时协作工具ProcessOn。

我之前就用ProcessOn画了一个设置了缓存的网络请求的流程图,这里作个参考:

6、人员角色“实例化”

跟上面提到的“画面感”相结合,将人员和角色能够实例化。比如我们的产品要实现如下功能,有两种表达方式:

医生给患者测量血压,并记录到系统中。

上海华山医院肾内科的王主任医生在给32号病区1号病床的患者刘阿姨测量血压,将测量到的血压100/70mmHg输入到透析管理系统。

哪种方式更便于理解?特别是对医疗知识不太了解的码农们。当然可能有人觉得第一种方式更简洁。可能是我举的例子不够好,也可能是我的理解能力不够强。(但不要怀疑我的智商!哈哈哈...)

7、结合产品原型设计图

产品原型设计图可以粗枝大叶地产品大致的框架。便于项目经理、研发人员、销售人员、运营推广人员等人在产品未开发之前对产品有一个相对直观的认识。没有一个原型图,想到这帮人拉到同一个频道沟通一定是不可能的事。(如果你做到了,那么赶紧把你的简历发我,我决定录用你!)

常用的原型设计工具有墨刀、Mockplus、Axure。

扯了这么多,来个例子吧。

本软件是给北京某医院集团肾内科透析患者所使用的软件,包括院内管理系统、院外大数据平台、医护端APP、患者端APP...

版本

作者

修订时间

审核人

v1.0.0

Charlie Chu

2017-2-12

Vivian Wong

使用场景一:

肾内科的医生王医生给31号病床刘阿姨进行透析上机操作,王医生在院内透析管理系统上点击上机操作,信息会传递到院外的大数据平台以及医护端APP、患者端APP上...

刘阿姨患者的家属登录到患者端APP后,可以实时查看刘阿姨透析过程中的所有信息,还可以查看血压、血糖、体重等历史数据...

当刘阿姨在家中通过蓝牙血压计测量血压时,自动同步到医院内部,如果刘阿姨的血压超过预先设置的值,院内的王医生则会在自己的手机上查看到刘阿姨的血压异常报警信息,王医生可以立即跟刘阿姨的家属进行实时沟通...

...<此处省略N字>...

本软件(v1.0.1版本)不包括的功能需求如下:

  • 医生与患者的实时IM
  • 医生排班设置
  • 修改密码
  • 患者积分

功能模块详细描述:

一、APP登录页面

由于本产品不存在患者自己注册的场景,所有的患者录入都发生在院外透析系统中,患者及家属在院外只需要输入相应的手机号,即可登录系统。

登录页面只有两个输入框,一个手机号,一个密码。

当用户要输入手机号时,手机应该弹出纯数字键盘,最多只能输入手机号固定的11位。密码最多输入10位。

当用户点击登录时,APP与后台服务器进行交互:

  1. 不输入手机号和密码,直接点击登录按钮,应该提示用户输入手机号和密码。
  2. 输入手机号但不输入密码,点击登录,提示“请输入密码”。
  3. 输入不正确的手机号,点击登录,应该提示“不存在该用户”。
  4. 输入小于11位的手机号,应该提示“请输入正确的手机号”。

二、登录后首页

下图是左侧是一个首页,右侧是一个点击透析预警的详细页面:

首页包括功能点:

  1. 资讯信息轮播 首页顶部资讯信息轮播功能,点击可以跳转到新的页面可以查看资讯详情。
  2. 病情咨询 点击“病情咨询”模块,患者查看向指定的医生了解自己的病情。
  3. 透析记录 点击透析记录,患者可以随时随地查看自己的过往透析记录。
  4. 食物速查 点击食物速查,可以查看所有类别的食物成份含量。
  5. 透析上下机实时信息列表 当患者在医院内进行透析上下机等操作时,会记录患者的透析上机时间 、下机时间等信息。点击其中的一条记录,跳转到透析详情页面,如上图右侧所示。

四、HOW - 如何保证文档质量

要保证文档能够实时更新同步,而不是疲于应付。那就是让大家都通过该文档来进行沟通,谁有问题直接去看文档,需求一旦变更首先就更新到文档。

研发人员严格按文档上的描述来开发,在没有文档之前,对不起,拒绝开发!任何口头、QQ或邮件上的新的功能需求一概不理!提前是产品狗要比较给力,否则老板还是会让你狂撸代码...

本文分享自微信公众号 - Java后端技术(JavaITWork)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-09-05

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 创业公司技术总监,去上市公司面试,结果凉了!

    首先,大概介绍下自己,后端开发8年,头两年用.NET,之后用Python至今,大概六年。大概工作到第三年的时候,就开始兼着任管理职位。工作地点是在一个三、四线的...

    Java后端技术
  • Nginx模块管理和进程管理

    Nginx和Apache一样,同样使用模块化管理,但是和Apache“热插拔”(每次添加模块的时候,不需要重新编译,只需要重新载入即可)的方式不同,Nginx每...

    Java后端技术
  • Redis有哪些开发设计规范值得我们注意的!

    redis不是垃圾桶也不是 SUPER MAN,能力和资源都有限,不合理的使用会降低它的健康度,严重时甚至会引起redis抖动、阻塞等进而导致服务不可用,每一个...

    Java后端技术
  • 作为产品经理在设计产品过程中你需要使用哪些文档?

    相信产品原型、PRD这两个文档名称肯定是大家听的最多的,但是在一个产品的设计中光有这两个就够了么,显然答案是否定的,下面我就把我在产品的设计中会用到的文档类型及...

    公众号php_pachong
  • 关于文档的那些事

    1、让初次接手业务的同学有一个大概了解; 2、作为自己的备忘录,减轻记忆的负担,也方便后续快速跟进; 3、先从宏观角度来思考完备性,实现过程中可以作为指引;...

    落影
  • 技术文档如何编写?

    谢伟
  • 程序员既要写好代码,又要写好文档

    程序员既要写好代码,又要写好文档 作为一个长期混迹于CSDN社区的人,我对很多拥有高访问量的博主钦佩不已,特别是在参加了CSDN在举办“2014 CSDN博文大...

    用户1289394
  • Swoole 船新版本文档发布了,是兄弟就砍我!

    Swoole的文档一直被人所吐槽,虽然内容很丰富,但看起来很费力,更新也稍有些不足,所以这次识沃科技专门组织了人力和资源重新打造这一船新版本的文档,让人眼前一亮...

    桶哥
  • GO 文档笔记

    最开始写 GO 的时候, 发现方法的注释并不支持@param, @return等参数, 搞得我都不知道该如何给自己的方法写文档说明了. 而且网上搜了搜也没有搜到...

    烟草的香味
  • 读不懂英文文档,能写出代码不?

    作为一个开发人员,开发一个新项目,维护一个项目,想要快速的开展工作。最重要的是干什么?是阅读项目文档,没文档看代码。可见我们首要做的事情是看文档看懂文档,编程初...

    程序员互动联盟

扫码关注云+社区

领取腾讯云代金券