Use Case 编写建议与注意事项

版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/zuozewei/article/details/79471255

 

一、     Use Case的定义

             Use Case(以下简称UC)作为用例描述文档,应当定义为系统分析或需求分析人员对用户需求的深刻理解的体现。也可以对作为项目估算的依据,以及根据UC复杂度和开发周期来衡量开发人员的工作效率。

           因此可见UC对于后期软件的详细设计以及编码阶段起着指导性的关键作用。编写UC的同时其实也是对软件架构和界面布局等方面的梳理过程。一份详细、清晰且流程(路径)覆盖度高的UC会对今后的开发和测试等各方面工作提升很多效率。

 

二、     编写UC的一些建议和注意事项

Ø  对用户的需求和提出的问题要有非常深刻和完善的理解

 

Ø  及时明确需求以及设计方案

对于UC文档编写初期经常会遇到需求不明确或者是软件架构和整体框架设计无法确定等情况。在这里我的建议是:

1) 需求不明确的地方先用红色字体将主要要完成的功能及流程描述清楚。在今后与客户的讨论过程中可针对红色字描述部分向客户提出问题并明确需求细节。

2) 对于无法确定架构或界面等设计方案的UC流程可用黄色高亮标明,在项目例会上集中解决并理清思路。

 

Ø  UC中关于细节的描述

如何才能算是一个理想的UC流程描述。最简单的检验方法就是让一个不清楚该功能模块的开发或测试人员看着这份UC流程,能很快理解模块要实现什么功能,用户想要软件达到什么效果,甚至可以照着UC画出详细的流程图和简单的界面效果图。这样我们就必须达到以下的要求:

1)需要在UC的编写过程中尽量用数字描述并量化指标,切忌出现一些模棱两可的描述词。例如:很快、多、较大等形容词。

2)不要将预期结果讲得太笼统。例如:用户需要页面显示5 * 5的金额结算列表,每一列分别显示什么值。那我们就必须将“5 * 5”、“需要显示的列标题名”这些关键元素都描述清楚,而不是仅仅用 “正确显示金额结算列表”这样的语句一笔带过。否则就会失去编写UC最重要的价值,因为无论是开发还是测试人员在阅读此类UC后都不清楚到底怎么样才算正确的,怎么样是不正确的。

 

Ø  UC的内容必须涵盖所有需要解决的问题以及更深层次的思考

1)在完成功能的同时不要遗漏一些容易忽略的问题。如:预留的接口,模块及接口间的数据交互等。虽然UC只是一个黑盒的模型,但在用例规约中适当的编写上述的一些内容,无论对今后详细设计还是开发工作都将带来更多益处。

2)对于进度较为紧急的项目来说,往往容易忽略一些非功能上的需求,例如:性能需求。有时候用户并未明确提出这些需求,但是开发时必须考虑到这方面的问题。最好在项目初期就要求用户制定相关性能需求,以免在系统验收后客户再反馈此类问题,可能就为时已晚了。所以尽量在涉及到相关问题的UC上都能将非功能性的规约都体现出来。

 

Ø  UC编写的后期在时间允许的前提下需提供UI设计图

提供UI设计图的好处在于明确界面布局设计以及需要用到哪些控件,更有利于指导后期的开发和测试工作。(UI设计图可以让美工提供,但必须事先提供必要的文字或简单框架描述。如果没有时间制作UI设计图则必须将界面的布局用文字描述清晰,描述内容包括:界面的布局、所用到的控件、控件的样式、窗体的CAPTION以及页面或弹出框的提示文字等。另外,在设计时需要考虑界面、图标及文字提示的统一性,切忌风格不统一)

 

Ø  尽量做到单个UC的全流程覆盖

做到全流程覆盖是件十分困难的事情,即使一个再有经验的测试人员也很难将一个功能模块的所有流程都理清。但是作为一名研发或者是测试人员来说有这样一种意识是很有必要的。也就是说不但要将所有正常流程都梳理清楚,也必须考虑到各种可能引起程序异常的流程。

 

就拿最简单的 增/删/改 功能来举例,完成增/删/改功能的正常流程也许就是验证一些弹出的页面,查看页面元素是否完整,控件是否都可用,以及最终提交后的数据是否正确,数据是否正确更新到数据库中等。类似这种流程即使考虑完整其分支也不会超过3个。但若多考虑一些异常情况,就会发现 在编码时还需要考虑如何增加程序的健壮性。
例如:在增加一条记录时,我们不仅要考虑数据是否被正常添加了。还要考虑当关键字段为空时,是否不应该成功添加,页面应该如何提醒用户重新操作;当输入的值超出数据库字段定义的范围或会导致程序溢出时,系统应该如何处理,是否要清空当前输入错误的值,提高软件适用度等。如果能把此类异常的流程都梳理一遍并编写到UC中的话,就可省去今后很多返工或者是修改BUG的时间,也会极大程度上提升工作效率和项目进度。

这也是一个好的UC应该体现的价值。

 

三、     UC修改示例

以下选取有代表性的UC流程来举例。

注意:由于只是范例,因此可能与实际的需求或实现的方案有出入,仅用于提供一些编写UC的思路。如果大家觉得哪里有可以再改进的地方,请在项目会议上多提宝贵建议。


配置自动数据采集服务

修改前: 

概要

・   从菜单中选择配置自动采集,设置自动采集服务

角色

・   数据采集管理员

先决条件

・    

处理后条件

・    

备注

・    

顺序

主流程ー1(从数据采集主菜单选择配置自动采集)

关联画面 (Wxxx)

处理详细 (Lxxx)

DB处理

(Dxxx)

异常

(Exxx)

1-1. 选择数据采集主菜单,点选配置采集子菜单

 

 

 

 

1-2. 设置自动采集配置

 

L001

L002

L003

 

 

1-3. 定时执行数据采集服务

 

 

 

 

处理详细

 

L001

查询自动配置设置

打开自动配置设置,查看配置详情

L002

修改自动配置设置

修改配置信息,改变定时采集任务执行时间、执行范围

L003

删除自动配置设置

删除配置信息,取消定时采集任务

异常处理

E001

存在重复采集进程,提供两种处理选项:取消本次采集(取消操作按钮);强制执行本次操作(继续执行按钮)

E002

 


修改后:

概要

・   从菜单中选择配置自动采集,设置自动采集服务

角色

・   数据采集管理员

先决条件

・   采集数据库可正常写入数据;

・   采集服务不受外界影响,可正常访问数据库;

处理后条件

・    

备注

・    

顺序

主流程ー1(从数据采集主菜单点选配置采集子菜单)

关联画面 (Wxxx)

处理详细 (Lxxx)

DB处理

(Dxxx)

异常

(Exxx)

1-1显示自动采集服务配置页面元素

 

L001

 

 

1-2 载入自动采集服务配置;

点击取消定时采集按钮,跳转至流程1-5;

点击启动定时采集按钮,跳转至流程1-4

 

L002

 

 

1-3修改自动采集服务配置

 

L003

L004

L005

 

E001

1-4. 点击“启动服务”按钮

若该服务已经启动,则跳转至分支流程101

 

L006

 

 

1-5. 点击“取消服务”按钮

 

L007

 

 

分支流程(重启自动采集服务)

关联画面 (Wxxx)

处理详细 (Lxxx)

DB处理

(Dxxx)

异常

(Exxx)

101 弹出提示框;

若点击取消按钮,跳转至流程103

 

L101

 

 

102 点击继续执行按钮

 

L102

 

 

103 点击取消按钮

 

L103

 

 

处理详细

 

L001

查看页面元素

页面包含: 采集服务类型下拉框(下拉框包括:每天,每小时,自定义3个选项);定时启动服务输入框;

“启动服务”按钮;“取消服务”按钮;(待确认)

L002

查询自动配置设置

若已配置自动采集服务设置,系统自动载入最近一次的配置值;

若未配置自动采集服务设置,所有选项值均为空

L003

下拉框中选择启动类型为“每天”

输入框中输入定时启动的小时,即每天定时启动

L004

下拉框中选择启动类型为“小时”

输入框中输入定时启动的分钟数,即每小时定时启动

L005

下拉框中选择启动类型为“自定义”

输入框中可设置任意的启动时间,如设置:2,4,6表示每天的2点4点6点运行该服务

L006

启动自动采集服务

启动自动采集服务;

服务根据页面配置的时间点执行自动采集的操作

L007

撤销自动采集服务

删除自动采集服务的配置信息,并取消定时采集任务;

L101

查看提示框显示元素

提示框包含:提示文字“是否强制执行本次操作?”、“取消”按钮、“继续执行”按钮

L102

重启自动采集服务

取消之前启动的自动采集服务,丢弃还未正式导入的数据库中的数据;

启动本次采集服务,并从之前未成功导入的数据开始重新导入数据

L103

取消启动本次自动采集服务

取消本次采集服务器启动操作,原服务依然执行

异常处理

E001

1)选择启动类型为每天,输入框中输入的小时数范围不为0-23的整数或为特殊字符或为空,点击启动自动采集服务,页面弹出错误提示框:“请输入正确的数值”;

2)选择启动类型为小时,输入框中输入的分钟范围不为0-59的整数或为特殊字符或为空,点击启动自动采集服务,页面弹出错误提示框:“请输入正确的数值”;

3)选择启动类型为自定义,输入框中输入特殊字符或超出范围或为空时,点击启动自动采集服务,页面弹出错误提示框:“请输入正确的数值”;

 


展开阅读全文

没有更多推荐了,返回首页