4.4.3 功能需求项的编写示例

  上节软件需求规格书模板中,章节3是大头,其中涉及功能需求项的编写。使用Use Case方式进行描述。本节给出一个需求项编写示例,详细说明一下编写方法。

  使用Use Case方式描述需求,除了正常过程外,还有可选过程和异常过程,还可以附加一些非功能需求,有助于将需求描述的更完整。

SRE实战 互联网时代守护先锋,助力企业售后服务体系运筹帷幄!一键直达领取阿里云限量特价优惠。

  下文示例的章节编排按照SRS文档的章节。

 

  章节3.1、SF1000 用户管理

  需求描述:系统必须提供用户账号管理的功能,包括:APP用户账号管理、管理后台用户账号管理。

  优先级:5

  参与者/角色(用户)

  前置条件

  后置条件

  正常过程

  可选过程

  异常过程

  非功能需求

 

  注:本节为非原子级需求项,仅提供需求描述和优先级信息,其它部分在子章节给出。

 

  章节3.1.1、SF1100 APP用户账号管理

  需求描述:系统必须提供APP用户账号管理的功能,包括:APP用户注册、APP用户登录、APP用户登出、APP用户忘记密码、APP用户信息维护等功能。

  优先级:5

  参与者/角色(用户): APP用户

  前置条件

  后置条件

  正常过程

  可选过程

  异常过程

  非功能需求

  NF0010 在公司任意一款APP注册了账号,该账号可以用在公司其它的APP,无需重新注册。

 

  章节3.1.1.1、SF1110 APP用户注册

  需求描述:系统必须提供APP用户注册的功能,注册包括:手机号注册、Email邮箱地址注册。

  优先级:5

  参与者/角色(用户): APP用户

  前置条件

  C1 用户点击“注册”,进入注册页面

  后置条件

  正常过程

  N1 APP用户注册

  N0010 显示“手机号注册”和“Email邮箱注册”两个tab页面

  N0020 用户选择“手机号注册”页面

  N0030 进入手机号注册过程

  N0100 正常过程结束

 

  可选过程

  A1 用户使用“Email邮箱注册”(N1.N0020的分支)

  A0010 用户选择“Email邮箱注册”页面

  A0020 进入Email邮箱地址注册过程

  A0100 返回N1.N0100

 

  异常过程

  非功能需求

 

  章节3.1.1.1.1、SF1111 APP用户手机号注册

  需求描述:系统必须提供APP用户使用手机号注册的功能,此时手机号为用户账号的登录名。

  优先级:5

  参与者/角色(用户): APP用户

  前置条件

  C1 用户进入手机号注册页面

  后置条件

  正常过程

  N1 手机号注册

  N0010 用户输入手机号,输入栏提示显示“输入11位国内手机号码”

  N0020 前端验证手机号的合法性

  N0030 手机号合法,验证码输入栏提示显示“点击获取验证码”,“获取验证码”按钮可用

  N0040 点击“获取验证码”按钮

  N0045 点击后,前端控制“获取验证码”按钮失效,60秒后恢复使用

  N0050 验证码输入栏提示显示“输入短信中的验证码,60秒内有效”

  N0060 用户输入验证码

  N0070 用户输入密码,密码输入栏提示显示“要求不低于6个字符,英文字母或数字”,允许切换明文/密文显示模式

  N0080 用户确认密码,允许切换明文/密文显示模式

  N0090 用户确认无误后,按“注册”按钮

  N0100 注册成功,提示“您已成功注册,欢迎开启XXX之旅!”

  N0200 正常过程结束

 

  可选过程

  A1 用户放弃注册,退出注册过程(N1的分支)

  A0010 用户点击“取消”按钮

  A0020 退出注册过程

  A0030 可选过程结束

 

  A2 用户放弃手机注册,选择邮箱注册过程(N1的分支)

  A0010 用户选择“Email邮箱注册”页面

  A0020 返回SF1110.A1.A0020

 

  异常过程

  E1 手机号不合法:长度不合法(N1.N0030的分支)

  E0010 提示:手机号长度不是11位

  E0020 返回N1.N0010

 

  E2 手机号不合法:号段不合法(N1.N0030的分支)

  E0010 提示:不支持XXX号段的手机号(截取前3位数字)

  E0020 返回N1.N0010

 

  E3 用户快速连续点击“获取验证码”(N1.N0040的分支)

  E0010 后端针对此情况,有相应处理机制,同一手机号,60秒内只允许处理一次获取验证码的请求(同时也防止通过HTTP接口的调用攻击)

  E0020 返回N1.N0045

 

  E4 密码规则不合法(N1.N0070的分支)

  E0010 提示:密码不少于6位,英文字母或数字

  E0020 返回N1.N0070

 

  E5 密码确认不一致(N1.N0090的分支)

  E0010 提示:两次密码不一致

  E0020 返回N1.N0080

 

  E6 用户在验证码有效期内没有完成注册操作(N1.N0090的分支)

  E0010 提示:验证码错误,请重新获取;如未收到验证码短信,请核查手机号

  E0020 清除验证码输入信息,保留其它的输入信息,返回N1.N0040

 

  E7 手机号已注册(N1.N0090的分支)

  E0010 提示:此手机号已被注册,无需再注册

  E0020 返回N1.N0010

 

  非功能需求

  NF0010 仅支持中国大陆地区的移动运营商的手机号,11位数字

  NF0020 170号段,归于虚拟运营商,目前不支持此号段手机号注册;系统应支持号段扩展和调整的灵活性

  NF0030 60秒的时间可以视需要调整

  NF0040 针对用户换号的情况,系统应提供相应的解决方案

 

  注:后续章节略,仅提供目录结构和需求编号的示例。

 

  章节3.1.1.1.2、SF1115 APP用户EMail邮箱地址注册

  章节3.1.1.2、SF1120 APP用户登录

  章节3.1.1.2.1、SF1121 APP用户手机号登录

  章节3.1.1.2.2、SF1125 APP用户EMail邮箱地址登录

  ......

  章节3.1.2、SF1200 管理后台用户账号管理

  ......

  章节3.2、SF2000 权限管理

  ......

 

扫码关注我们
微信号:SRE实战
拒绝背锅 运筹帷幄