一、总体说明
1.1 修订历史--日期、版本号、作者、说明
1.2 项目概述--产品目标、业务领域知识
1.3 用户范围--对本RPD涉及的角色、系统的简要说明
1.4 功能范围--业务逻辑图,重点描述系统中角色的职责、与周边系统的关系、全局的商业规则
1.5 词汇表--对本PRD涉及的专有词汇、术语、缩写说明
1.6 非功能需求--如性能、监控等
1.7 其他说明--其他基础环境、约束、限制条件等
二、用例部分
2.1 整体说明
2.2 用例正文
2.2.1 UC_<用例名称>--详见下方“用例结构”说明
2.2.2 UC_<用例名称>
用例结构
概述部分
- 用例名称:动宾短语,任务的粒度自行把握,如点菜
- 用例ID:唯一标识符,如UC_ordermeal,表示用户点菜
- 业务描述:用户、商业目的,如领导检查员工出勤情况
- 需求描述:用户、商业目的,如领导检查员工出勤情况
- 行为者:用例的Actor,如小明
- 前置条件:触发这个用例的前提,如当餐桌有空位时
- 后置条件:用例完成的后续动作,如服务员接收订单
- 其他说明:补充备注,没有则空
- 业务描述:用户、商业目的,如领导检查员工出勤情况
界面描述
此部分篇幅较大,为了便于阅读,可独立写界面文档,标明位置于此处互相引用。其中应包含整体页面截图、界面元素描述(名称、类型|长度、必填、默认值、规则),如表单、列表、按钮。
业务规则
整个用例的通用规则,如小明不吃辣、预算100元。
私有的业务/流程规则写到流程描述中相应步骤中去。
流程描述
- 流程元素:主流程、分支流程、异常流程
- 描述元素:用户做什么、系统做什么、按什么规则做
- 图形表示:可配合UML时序图、活动图、路径图等
描述的方式因人而异,使用上图中的结构化描述或使用目录形式的均可,以下边为目录形式的示例。
1.某用户干了什么,系统按照某规则做了什么,系统响应给用户什么信息;
2.用户根据反馈信息可选择以下操作分支,
2.1 若用户点击按钮“确认”,系统如何处理
2.2 若用户点击按钮“再试一次”,系统如何处理
3.某用户干了什么,系统按照某规则做了什么,系统响应给用户什么信息;
4.某用户干了什么,系统按照某规则做了什么,系统响应给用户什么信息。
可以补充一个路径图,表示主流程、分支流程、异常流程的结构关系,如下图示例。
TIPS
视觉:插入静态Demo或引用界面文档,如页面大小、颜色、字体、字号
界面:引用界面规范文档,如文字对齐方式、表格样式
交互:引用交互规范文档,如出错提示方式
文案:引用文案规范文档,如提示、通知内容