用例文档模版整理

用例名称

比如：会员功能模块1

角色（Actors）

编写UC的参与者，比如会员

用户界面 （UI）

交互稿或者视觉稿上对应功能模块的截图，比如

会员回答问题的页面

会员回答UI

会员回答问题的错误提示页面

会员回答-错误提示UI

辅助图例（Diagram）

用于补充用户界面的一些图例，没有可不写

时序图

可以用时序图描述业务模块在系统中和其他模块的交互过程，使用时序图表达

前置流程 （Pre-Conditions）

前置流程的顺序描述，也可以流程图表达

基本流程 （Main Flow of Events）

基本主流程的顺序描述，也可以流程图表达，例如：

1. 会员请求回答问题
2. 系统验证会员已登录
3. 系统验证会员积分
4. 会员提交答案信息
5. 系统验证答案信息完整
6. 系统验证答案无违禁词
7. 系统验证答案无敏感词
8. 系统保存答案信息
9. 系统返回至问题detail页面

分支流程 （Alternate Flows）

分支流程的描述，也可以流程图表达，例如：

• 2a 系统验证会员未登录或登录状态失效
• 2a1 系统提示会员登录
• 2a2 会员执行登录
• 2a3 返回3
• 3a 系统验证会员积分值未达到规定要求
• 系统提示会员积分值不足，不能回答问题
• 用例结束

后置流程 （Post-Conditions）

后置流程的顺序说明，也可以流程图表达

• 回答问题成功后，用户可以编辑自己的答案，详见社区ASK项目_编辑自己的答案
• 如果问题的提问者提问时选择了Email me when I receive a new answer，系统需要向该提问者发送提示邮件（定时发送）
• 如果有会员关注了此问题，系统需要向该关注者发送提示邮件（定时发送）

业务规则 （Business Rules）

步骤	业务规则
3	会员的积分值不小于零，会员才可以回复问题
4a1	提示文案见会员回答-错误提示UI
4b	当会员填写的答案描述含有违禁词时或答案描述为空时，不能进行预览，系统应给出提示
6a1	将违禁词高亮显示。提示文案见会员回答-错误提示UI
8	保存答案成功后，系统按照后台设定的积分奖惩规则给会员加ask point值。见【社区ASK项目_设置会员积分规则】一个用户对某个问题只能有一个回答，用户可以编辑这个答案

数据字典 （Data Dictionary）

UC涉及的相关数据结构的说明，包括数据字段名称、字段类型、字段说明等

词汇表（Glossary）

UC编写过程中用到需要解释的词汇，可以使用表格的形式：

词汇	解释
词汇1	词汇说明1

补充说明 （Additional Information）