需求用例文档编写建议 --事件流程(基本流程和扩展流程)部分

每个用例表示用户为实现某个目标与系统的一次交互,而事件流程则是对实现该目标的描述,事件流程包括基本流程(又称为主成功流程)和可选流程(又称为扩展流程);对这部分的编写应该清晰的描述不同的对象(用户、系统)完成目标的活动序列,例如,像这种方式:球员甲将球传给球员乙,球员乙运球,球员乙将球传给球员丙。

编写一个良好的事件流程有以下准则:

准则一:使用简单语法

主语+谓语+宾语,例如: “系统从帐户余额扣除一定数量金额“,简单的语句与用户沟通起来对需求的理解会更准确。

准则二:明确写出“谁控制球”(比喻)

控球的执行者会做下列事情:自己运球或将球传给别人,在步骤结束时要问问“把球给谁了”。

准则三:从系统外部的角度来编写用例

始终站在用户的角度来编写,而不是系统的角度,例如,不要出现这样的描述“系统读取卡号和密码,并从帐号余额中扣除一定的金额”,而要从系统外部的角度来编写,如:

1)用户输入ATM卡并输入密码

2)系统从帐号余额中扣除一定的金额

准则四:描述过程向前推进

每一个步骤都要离目标更进一步,步骤不要太细,也不能太粗,一般对基本流程3-10步是合适的,过多则会使用例文档显得太长。

准则五:描述执行者的意图而不是动作

编写用例常见的问题就是在操作界面来描述,这应该需要避免,例如:

用例1

1) 系统要求用户输入名字;

2) 用户输入名字;

3) 系统要求用户输入地址;

4) 用户输入地址;

5) 用户点击“确认”

6) 系统显示用户简介

修改后:

1) 用户输入名字和地址

2) 系统显示用户简介

虽然在操作界面进行描述能很精确的定义需求,但过多关注细节会花费大量的精力,同时文档也会变得很长,难以维护。

准则六:包含“合理”的活动集

对场景的描述可以把每个部分作为一个单独的执行步骤,也可以以不同的方式合并其中的几个部分,如何分隔要尽量按“是否合理”进行。一个常用的步骤模板如下:

1) 用户向系统发送请求数据

2) 系统验证请求

3) 系统更新内部状态

4) 系统显示成功处理结果

任何用例流程的描述,都可以在上述基础上进行适当的扩展完成。

准则七:“确认”而不是“检查与否”

描述中不要出现“如果”字句,例如

2) 系统检查密码是否正确

3) 如果密码正确,系统显示主页面

要修改为:

2) 系统确认密码正确

3) 系统显示主页面

对于密码错误的流程,则放到可选流程中处理

准则八:习惯描述“循环执行步骤X到Y,直到条件满足”

例如“用户重复步骤3-4,直到完成选购”

准则九:对于可选流程,格式如下:

如准则七的中的例子

2a:无效密码:

1)系统显示登陆失败页面

2b:用户没有响应(超时)

1)系统自动关闭该页面

参考资料:

《编写有效用例》

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

推荐阅读更多精彩内容