面向对象开发--用例文档的写法

目录

一.前言:

二.内容:


一.前言:

        最近做课程设计需要提交文档,被队友拖着写用例文档,于是便浅浅的学了一下,稍稍的总结一下吧~

二.内容:

1.用例文档: 也叫做用例描述,用例文档是用例建模的核心,主要用于描述用例,采用文字的方式描述用例的执行过程。

2.每一个用例 对应一个用例文档。

3.用例文档需要通俗易懂,需要让开发人员和客户都能看懂。

4.用例文档的组成:用例名用例编号执行者、涉众利益、前置条件后置条件基本路径、扩展路径、字段列表、业务规则、非功能需求、设计约束。

(1)用例名:要通俗易懂,常使用“动词+名词”的形式。(删除用户信息 | 查看历史订单 | 登录 | 注册)

(2)用例编号:用例的统一规范的编号。(User001 | User002)

(3)执行者:用例的执行者。

(4)涉众利益:关心用例的执行过程和结果,但是不参与用例的执行过程 。

(5)前置条件:用例执行之前系统的状态,必须是系统可以识别的状态。(如:用户已经成功登录)

(6)后置条件:用例执行之后系统的状态,必须是系统可以识别的状态。(如:系统更新用户信息)

(7)基本路径:也叫正常路径/开心路径,是用户最想看到的执行路径。一般用执行者或者系统作为主语来描述基本路径。(如:用户输入账号和密码   | 系统验证账号和密码是否正确)

(8)扩展路径:也叫异常路径、替换路径。

(9)字段列表:所涉及到数据字段。

(10)业务规则:执行者或者系统在执行操作时需要满足的条件。(如:商品编号不能为空)

(11)非功能需求:描述用例在安全性、可靠性等方面的要求。(如:系统响应时间不能超过20秒)

(12)设计约束:设计过程中存在的待解决的问题。(如:如何高效、快速查询商品) 

在实际软件开发中,用例文档必须包含:用例名用例编号执行者前置条件后置条件基本路径。其他部分根据实际情况编写,可有可无。

下面提供一个“注册”的用例文档示例仅供参考:

用例名称

注册

用例编号

User-WOC001

执行者

用户

涉众利益

工作人员:了解用户注册是否能正常执行,系统是否正确录入用户注册信息。

管理员:了解用户注册信息。

前置条件

用户已经进入系统初始页面且还没有在该系统注册身份信息。

后置条件

系统保存用户注册信息,更新用户注册表信息。

基本路径

  1. 用户输入账号和密码;
  2. 系统验证账号密码是否符合规则;
  3. 系统将用户信息录入到用户注册表;
  4. 系统提示用户注册成功。

扩展路径

1a.账号和密码不符合规则

  1. 系统提示用户注册失败,账号或密码不符合规则;
  2. 用户重新输入账号和密码;
  3. 系统再次验证用户账号和密码是否符合规则,直到该用户账号密码符合规则注册成功。

2a.注册失败

  1. 系统提示用户注册失败,超过用户注册表容量上限;
  2. 管理员新建用户注册表;
  3. 用户再次提交注册请求;
  4. 系统再次验证用户账号和密码是否符合规则,直到用户注册成功。

字段列表

用户注册信息包括:用户账号、用户密码

业务规则

  1. 用户账号不能为空;
  2. 用户密码不能为空;
  3. 用户密码必须为6-9位的字母和数字组合。

非功能需求

系统响应时间不能超过5秒。

设计约束

  1. 如何实现快速、安全、简单的注册?
  2. 如何提高用户账号、密码的安全性?

你可能感兴趣的:(前端框架)