现代软件工程讲义 7 设计阶段 Spec

在前一个博客里 (典型用户), 我们讲了怎么收集, 分析和验证用户的需求。 这里我们讲 spec – specification

Specification, 又叫spec, 有两种:

    a) functional spec, 软件功能说明书, 主要用来说明软件的外部功能, 和用户的交互情况 (把软件当作一个黑盒子)

    b) technical spec, 软件技术说明书, 又叫 design doc, 设计文档, 主要用来说明软件内部的设计 (把软件当作一个透明的箱子)

有同学说, 我们崇尚动手, code & fix 就是我们的座右铭,  写那么多文字作甚?  上次来了个需求, 我一看图纸, 很简单, 不就是做个烟囱么?  干!

image

做到一半, 用户来了把我打了一顿!

我冤枉啊

图纸拿倒了, 原来是要挖一口井!

image

后来我只好强力 "重构", 把烟囱强力插入地里去, 累坏了…

笑话讲完了,我们继续讲 functional spec: 从用户的角度描述软件产品的功能, 输入,输出,界面, 功能的边界问题,  功能的效率问题(对用户而言), 国际化, 本地化异常情况, 等; 不涉及软件内部的实现细节

谁来写spec?  项目的PM, 或者其他人员

谁来实现spec? 开发人员, UX/UI 设计人员

谁来验证spec? 质量保障人员 (QA)

怎么写好spec?  其实就是一件事情描述清楚,  下面是一个练习:

如果你要给一个外星人描述怎么系鞋带, 写一个 “系鞋带“ 的spec (用英语), 你怎么写?

第一, 我们要定义好相关的概念

—what is “shoe”, “shoe laces”, “tied shoe laces”, and “untied shoe laces”  鞋, 鞋带, 系鞋带, 解鞋带都是什么概念

—Benefit of this feature “tie your shoe laces”。 系好鞋带的好处是什么

—The goal of the feature?                                    系鞋带的目标是什么?

—What does “success” look like?                       什么叫系好了?

—Unambiguous steps to achieve from “untied” to “tied”   明确的步骤来演示系鞋带的过程

这是两个同学写的系鞋带的spec: 例子1, 例子2。

第二, 规范好一些假设 (assumptions), 例如, 鞋带是已经穿好在鞋上的么? 什么样的鞋属于我们要处理的? 

 

imageimage

 

第三, 避免一些误解, 下面这个从技术上也是 ”鞋带绑紧了“,  但它是 “系好了”么? 打了死结算成功么? 要打多少个蝴蝶结才算好?

image

第四, 厘清一些边界条件,  下面的情况属于好的系鞋带状态呢,  还是不好的状态呢? 这需要PM/Dev/Test 协商达成一致意见。鞋带要打多紧才算好? 打好的鞋带能拖在地上么?

imageimageimage imageimageimageimageimage

 

第五, 描述主流的用户/软件交互步骤。

image

第六, 一些好的功能还有副作用,  我们要把这些副作用明明白白地写出来。

例如: 美国很多地区用节能灯(LED) 代替了原来的白炽灯,  但是LED 灯泡发热少,  下雪天不能融化灯面的积雪, 导致交通问题。当初的spec 要把这一副作用 (危险) 给写出来。

 imageimage

 

有人说, 我们敏捷的团队,就喜欢直接的面对面的交流,不喜欢搞文档什么的,多好!

其实大多数情况下,留下文字的文档是很有好处的,相对于后来的浪费,当初花的时间真的是太值了。 看下面的例子:

自习课时,教务主任走进来,告诉班长“帮我找两个人,我要班花”,  同时两手在胸前做了一个抱花的动作,  就走了.  班长就组织全班投票评选起班花来,闹了一节课,搞了一些大数据, 终于统一了意见,选出了班里最PL的两mm。于是两mm很羞涩的去找主任,主任说:“怎么是你们? 男生都哪去了?  好吧,  跟我去后勤,我要搬花。。。”

当面, 直接的交流当然很敏捷, 但是还是要留下文档, 以明确用户的需求。

 

在大规模软件的开发中, 我们一定要说清楚服务质量是什么等级, 意味着什么,不然就会人云亦云,以谬传缪。例如: 三峡大坝到底能防多大的洪水?

我们看一看从 2003 年到 2010 年 大家的理解:

image

人民群众看不见具体的spec, 只能道听途说,专家有细致的解释:  http://news.163.com/10/0722/01/6C5MUM6R00014AED.html 

image

写好的 spec 的秘诀不多, 只有下面三条:

实践, 实践, 再实践

 

spec 的最大敌人是什么? 乏味。软件公司的大部分人都不喜欢读文档,更不要说大学生了。 强迫大学生写乏味和没有人读的文档,简直就是扼杀同学们对软件工程的兴趣。 怎么把spec 写让人读了不困?

  1. 用活生生的人物和故事描述用户怎样用软件的  (参见上文 典型用户 )
  2. KISS - 保持简单, 直接的描述。涉及UI 的部分可以直接上图。 也可以画表格,不要写长篇累牍的文字。
  3. 如果是技术文档,最好把示例代码写上,单元测试也写好,让程序保证spec 的正确性,也让读者可以验证 spec 的正确性。
  4. 把边界条件规定清楚,理工科思维的工程师们看到这里大脑就兴奋起来了 - 他们想找出你 spec 的破绽! 

spec 的另一个敌人是时间。 几乎在spec 写好的那一瞬间,spec 就开始过时了。 容颜易老,spec 尤甚,怎么办?

  1. 记录版本修订的时间和负责人 - 这样出了问题好去找人。
  2. 在spec 中要说明如何验证关于功能的描述,从spec 的描述中就能知道单元测试怎么写, 最好把测试用例也链接上。
  3. 把spec 和测试用例,项目任务等放一起 (例如 TFS 上面),相互链接。
  4. 变化一定会发生的,与其在 spec 中有意忽略这一点,不如主动挑明哪些部分是容易发生变化的,提前做好预案。 哪些部分如果改变,会有何种连锁反应。
  5. 在做任何改动的时候,一定事先参考spec,事后更新spec,  团队领导人不应该在没有spec 的情况下做拍脑袋的决定

 

有spec  的模板么? 很多同学问,似乎很多同学有这样的希望,一旦搞到某文档的模板, 某课程的PPT,事情就成功了一大半。 盲目地套用最最给力的模板,对项目有大的副作用。 各位PM 要注意。 把上面正反的例子综合起来,就是一个模板:

    1. spec 的目标是什么,spec 的目标不包括什么
    2. spec 的用户和典型场景是什么
    3. spec 用到哪些术语,他们的定义是什么
    4. 用户如何使用软件的功能的
    5. 各种边界条件是什么,软件功能应该怎么样变化
      1. 这些边界条件多了去了,用户数量的变化,输入内容的上限下限, 不同国家/地区/文化/语言/硬件/软件版本/环境参数….
    6. 功能有什么副作用,对于其它功能有什么显性或隐形的依赖关系?
    7. 什么叫“好”,  什么叫这个功能测试完了,可以交付了?

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/500405.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

北航 2012 秋季 软件工程课 M2 要求

祝贺同学们完成了第一个里程碑 M1. 经过报告/评论/Postmortem, 大家对各自项目在M1 的优缺点都应该有很深的了解, 也理解到做一个好的软件和实现一个算法的差别。请把这些对于软件工程的感悟体现在M2 的具体工作结果中。 关于转会 - 软件工程师换工作是常有的事,…

现代软件工程 2012 北航 项目复审模板

这是现代软件工程课在北航的项目复审要求。 这次我们有下列 10 个团队, 他们做了一些有意思的项目: 有七个小组合作,携手打造一个叫 学霸 的网站: 100Years 网页收集和归类工具76er 网页收集和归类工具FightingSnail 网页元数据抽…

现代软件工程讲义 8 软件的血型

[这是 现代软件工程讲义 的一篇] 一个软件团队经历了计划/设计/开发等阶段, 达成代码完成 (Code Complete) 这一目标,似乎后面的事情就水到渠成了. 其实不然, 软件生命周期的最后阶段往往是最考验团队的,不但考验团队项目管理水平,应变能力…

现代软件工程讲义 6 用户调研

[现代软件工程讲义 的一部分] 软件开发的过程, 就是 “用户最需要的东西” 在下面这一链条中传送,转换,实现,扭曲或丢失的过程。 用户最需要的 > 用户表达出来的 > 软件团队能理解的 (老板/PM) 团队的商业目标 > 软件团队成员具…

软件工程讲义 0 微博上的软件工程

[现代软件工程讲义] 有舌尖上的美味, 也有微博上的软工。舌尖上的美味各有千秋, 而微博上对软工的抱怨都是相似的。 下面是我在新浪微博收集到大学生对软件工程教学的反馈: 师生关系(不限于软件工程) 教材 上课 & 老师 实践 & 作业 考试 考完…

现代软件工程讲义 5 团队合作的阶段

[现代软件工程 讲义] 团队合作要经历的阶段 1 萌芽阶段 萌芽(Forming)阶段,就像小苗破土而出,柔弱但充满希望。在这个时候,团队成员刚刚接触到团队的宗旨,同时很可能刚刚互相认识。在学校的环境中&#x…

现代程序设计 (课程设计中, 征求意见稿)

背景: 目前中国大陆大学里学的编程主要有两种: 1) 学编程为了应付考试,偏重于静态的知识点, 语言细节。以闭卷考试为主。有些学校的数据结构和算法课有许多实际的练习,也有的课程练习很少。 2) 学编程为了ACM 算法比赛,偏重于算…

现代软件工程 团队作业 - 软件分析和用户需求调查 (2013)

【现代软件工程 的讲义】 医学院的学生, 要解剖人体; 软件行业的从业人员, 不管是项目经理, 开发或测试人员, 都要学会解剖分析软件, 我们就来试试看。 要求: 通过定性, 定量地分析, 总结和评定某软件是否满足了目标用户的需求,并把分析的过程和结果用博客表达出来…

现代程序设计 学生情况调查

【课程设计在这里】 既然开始上课,就要把目标受众研究一下,搞清楚他们的需求。下面是我在课上做的调查。由助教整理。 (学生都是计算机学院大三上学期, 还有一些高等工程学院的学生) 黄色标注的代表是人数最多的选项 代码量…

现代程序设计 作业 第1次

第 0 次作业已经在课堂上做了。 1) 建立 GitHub 账户, 把课上做的 “最大子数组之和” 程序签入 2) 在 cnblogs.com 建立自己的博客。 写博客介绍自己的 GitHub 账户. 并把博客地址写到这个博客的留言。这样TA 可以收集信息 3) 搞到一本教科书 (三本中选一本), 并在博客中说…

现代程序设计 作业 2

我们上节课讲了 返回整数数组中最大子数组的和 这个问题。 我们第二次作业在这个基础上扩展。 程序要使用的数组放在一个叫 input.txt 的文件中, 文件格式是: 数组的行数, 数组的列数, 每一行的元素, (用逗号分开) 每一个数字都是有符号32位整数, 见 MSDN 的定义. 当然, 行…

现代程序设计 作业 3

这个作业是采取结对编程的方式完成。 在上一个作业中, 我们尝试了各种命令行的处理,以及各种数组的处理。 现在, 我们要把 现代程序设计 作业 2 的各个结果转换成图形界面显示。这个问题看起来很难, 实际上大部分难的工作都在上一个作业完成了 (数组计…

现代程序设计 作业4

英语国家的小孩们经常玩 Word Search 的游戏, 就是在一个填满字母的矩阵中把单词找出来。 这是一个简单的例子: (来自 wikipedia) 这是一个比较复杂的例子: 这是答案: 美国的商店里还有不少 word search books 卖, 两三块钱一本。 让我们把这个有趣的…

现代程序设计 作业5

在前四个作业中, 我们体会了数组,子数组的和,二维数组,字符串和字母的处理, 简单和复杂的 UI 程序等。大家锻炼了命令行的处理,模块的持续重构和演化,单元测试,UI 程序的处理&#x…

现代程序设计 作业6 - 简单而有意义的题目

这是这个课件的一部分: 现代程序设计 (课程设计中, 征求意见稿) 好多同学们都说题目难,这回我们来一个简单而很有意义的。 :) 写代码爽还是读代码爽? 往一堆乱麻中再加上一些线索,似乎比较容易;然而从…

现代程序设计 作业7 - 更加简单的题目

在网上,当用户发现一个新东西 (海洋里捞出来的新物种,奇怪颜色的飞鸟,某种新的植物等), 大家会问下面的问题: 能吃么 好吃么 怎么吃 这三个振聋发聩的问题被吃货们简称为能好怎, 大家可以打开链接看看&…

现代程序设计 作业9 - 综合练习

经过大半学期的学习和练习, 我们把学到的东西综合起来。 在作业2 (http://www.cnblogs.com/xinz/p/3318230.html ) 中, 同学们用各种方法 (主要是动态规划,外加一些遍历)计算了一维和二维数组中最小最大子数组的和。 当然,程序在…

对微软实习生或者工作感兴趣的读者, 目前我的项目是...

从 2018/4 开始,我在微软亚洲研究院(北京)工作,做AI 工具的研发,请看:https://github.com/microsoft/ai-edu --------------- 从2014/7/28 开始,我在Windows 的中国工程团队干活: http://weibo.com/355…

现代软件工程 第一章 【概论】练习与讨论

0. 学习别人的经验和体会。 同学们在上这门课的时候,都是大二,大三,有的是跨专业考研过来的。觉得在大学里,到教室来听课有意思么?请看:你为何要来上课并且认真参与, 另外,请看&…

现代软件工程 第二章 【个人技术】 练习与讨论

1 基本作业: 从Hello World开始 要求每个读者(或者学生)开始管理自己的源代码: 每个人都有一个VSTS的客户端,系统管理员给每一个人都创建了TFS项目,每个学员都是各自项目的管理员。每个同学去申请一个GitHub [i]的项目&#xff0…