产品需求文档的写作(五) – 用例文档(UML用例图、流程图)

作者: 唐杰 分类: 产品设计 发布时间: 2012-11-12 23:37

在产品和技术领域里都有UML的技能知识,而对于产品人员的UML则更多的是指用例图,也就是我所称呼的用户流程图。在讲PRD文档写作的第二篇文章里,我提到了用户流程图的制作,实际上用户流程图是我在产品规则的初期对用例图的一种结构化的表达方式,由于以结构化的方式描述用例太抽象,缺少逻辑性表达,并且那篇文章更偏向于功能性用户流程,还不是实际意义上的用例,因此今天我补文一篇,细讲一下UML用例图用例文档

用例文档是由多个用例组成的一份文档,主要用于技术开发与测试使用,他是PRD中的重要辅助文档,用于讲解某个环节的功能逻辑,例如用户注册、活动报名等等功能都是需要用例辅助说明的。用例文档的写作时间在原型设计之后,通常和PRD文档同步撰写。

用例文档中有两个关联文件,分别是用例图流程图用例图是UML的一种类图表现方式,是从用户角度描述产品功能,并指出该用户在产品各功能中的操作权限。流程图是通过线框图形的方式描述产品功能的处理过程,主要是描述功能的执行顺序、分支和循环的逻辑。

写用户文档的常用软件是Word,其中用例图和流程图的制作软件常用的是Visio,当然也有用Axure RP软件制作的,例如下面的第三步流程图就是用Axure RP制作的。

一份完整的用例文档分别是由以下三点内容组成,其中第3点的“用例”是描述功能逻辑的部分,根据功能的多少决定有多少个用例。

用例文档的大概组成部分如下:
1、修改记录:每次修改的备注记录,同PRD文档。
2、角色介绍:描述参与系统中的各个角色
3、用例:同下方步骤的第4步,其中第3步中的流程图是直接插入到第4步的流程图表格项中的。

用例文档的模板格式如同以上三点内容,通过Word文档绘制表格,在表格中撰写用例描述,表格的格式和样式参考以下示例图。

1、撰写用例文档的第一步是注明使用产品的各个角色(参与者)和角色说明(角色介绍)。(如下图)

角色

2、第二步是以用例图的方式注明角色在前后端的用例关系。(如下图)

会员中心UML用例图

3、第三步是以流程图的方式注明角色在各个功能环节的活动过程。(如下图:以活动报名为示例)

流程图

4、第四步则是以用例文档的方式将以上三步整合到一起,并撰写各个功能环节的用例描述。(如下图)

流程图

表格说明:
4.1、用例名:此功能环节的名称
4.2、用例编号:在此产品中该用例的编号
4.3、行为角色:参与或操作(执行)该功能的角色
4.4、简要说明:用最少的文字描述一下该用例的需求
4.5、前置条件:参与或操作(执行)此功能的前提条件
4.6、后置条件:执行完毕后的结果条件
4.7、流程图:该功能的角色活动过程(处理过程)图(第三步中的图)

上面示范的用例描述相对简单,也是最常用和基本的用例描述内容,当然也有稍微复杂一点的用例文档,文档中会详细描述使用场景、事件流和信息字段,也有一些用例文档还会插入产品界面效果图。

使用场景主要描述行为角色在不同情况下使用产品时,根据情况或问题给出相应的系统反馈。事件流类似流程图,只不过是通过文字的方式描述角色的活动过程。信息字段主要是描述用例中所用到的数据字段。

这些更多的描述内容取决于个人的习惯,最终目的都是为了描述清晰产品逻辑,因此我的原则就是用越少的文字描述清晰越多的需求说明。(毕竟这些文档是产品开发中的执行文档,文字不在多,表达清晰即可。)

产品需求文档(PRD)的写作:
产品需求文档(PRD)的写作方法(文章的摘要介绍)
产品需求文档的写作(一) – 写前准备(信息结构图)
产品需求文档的写作(二) – 梳理需求(产品结构图和用户流程图)
产品需求文档的写作(三) – 原型设计(手绘原型,灰模原型,交互原型)
产品需求文档的写作(四) – 撰写文档(PRD文档)
产品需求文档的写作(五) – 用例文档(UML用例图、流程图)

如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!

27条评论
  • 朗朗

    2017年5月8日 11:33

    谢谢博主的文章,有些虽然没看懂,但是还是有点收获的,我现在正往这方面转,但是原来没有这方面经验,感觉无从下手,希望你多多出一些文章,给我们看看,非常感谢,博主!!!

  • Jason

    2016年10月29日 21:23

    请问博主,在一般的工作流程中,产品把需求文档教给交互/UI和开发,流程图、原型等东西不是交互的工作吗?那在产品需求文档就把流程图、原型等做了,岂不是把交互的工作也完成了?

  • 铭聪

    2016年8月19日 14:34

    博主,你的流程图不是用VISIO画的吧,是用什么软件画的?感觉更加清晰

    1. 唐杰

      2016年8月19日 14:36

      Axure画的

  • 上官小夏winnie

    2016年7月18日 22:19

    博主真的很厉害,能认识一下吗?希望有机会跟您交流并学习.

  • yang

    2015年4月16日 00:07

    感谢唐老师,我是小白一名,想做表情合成类的app,学习中

  • susu

    2015年3月2日 16:49

    留个脚印,感谢博主,已关注微信~~~

  • fojay

    2015年1月13日 10:48

    看了博文,对自己受益很大,谢谢博主!

  • 2008polo

    2014年12月14日 16:58

    你好,有个用例分析一致困扰我,想请教一下用例图的画法:需求是财务报销系统,其中的审批环节较为复杂。最长的审批流程可以描述为:申请人提出申请-部门经理审批-分支机构财务部审批-分支机构财务经理审批-分支机构总经理审批-机构财务部审批-机构财务经理审批-副总审批-总经理审批。因为设计人员、环节比较多,分析时,不知道用用例图该如何表示,请帮忙分析一下,最好有个图示。谢谢!

    1. shawn

      2015年4月18日 14:42

      我觉得可以用泳道图做啊

  • rock

    2014年11月13日 17:31

    用例图中的会员中心用例和其他的用例之间不应该是泛化的关系,感觉用include表示更准确一点。

  • 赵晶

    2014年10月11日 13:04

    博主厉害,小小年纪,已有这样的见解,人生的机遇就是这样,天时地利人和不可缺少,做了多年的需求和设计,感觉还是不懂的很多,博主的文章让我受益匪浅,希望博主写更多好的文章分享。

    1. 唐杰

      2014年10月11日 15:47

      感谢支持
      这篇文章比较老了,我有新的更新,最近正在连载发布中

    2. 张大海

      2014年10月31日 15:37

      新的在哪里啊?

    3. 唐杰

      2014年10月31日 17:28

      http://tangjie.me/shu

  • 2014年6月10日 13:44

    目前我也在写需求文档,发现各家的需求文档结构都不同。谢谢博主,很好的文章,受益匪浅。

  • 佘轩儿

    2014年3月24日 17:37

    在寻找如何走上产品经理之路时看到博主的文章,受益匪浅呀,点个赞!

  • Pingback: 产品需求文档PRD的写作流程 - 资源&技巧 - 锐想Magento
  • 路由

    2013年6月25日 10:04

    我是刚刚做产品的,看了博主的文章,有股豁然开朗的感觉。。。

  • 小青年

    2013年5月27日 18:28

    小弟做了有几年网站运营了,主要是研究广告运营、活动运营、用户运营、营销推广等方面的知识和总结相关经验,从去年开始有兴趣学习和产品有关的知识以及软件的基本操作,现在有时候只要出门就会主动观察生活中的人和事的交互,希望日后多多发博,学无止境啊

  • 萧何

    2012年12月14日 13:32

    呵呵,没有想到这里还有这么热心的读者。我也在这里留一个脚印,希望以后可以和博主多交流!我主要以软件的普及我主要方向

    1. 唐杰

      2012年12月14日 13:43

      之前有位朋友介绍到你了,一直忙,也没仔细瞧瞧,等忙完这阵子,多多交流。

  • Pingback: 产品需求文档(PRD)的写作方法 | Lucien的产品经理之路
  • luk

    2012年12月6日 19:48

    真心受益,拜谢。

  • Pingback: 产品经理之PRD文档的撰写 - 产品经理,不是一个人在战斗
  • 林瘦山寒

    2012年11月13日 00:18

    博主大神你好,看了你的一系列的文章,作为初学者,真的感觉受益匪浅。最近一直在网上学习,还加了一些QQ群,有另外一个博主,跟博主你一样,也开了博客,为我们初学者服务,同时把您的这些思想见解跟他聊了下,他在他的博客中增加了你博客的链接,我觉得你们应该能产生共鸣,他说你的经历跟他好像,好了,不说废话了,给你网址,有空去看看,希望你们两位大神能交流下,产生火花,让我们这些初学者更好的学习到这些知识,再次感谢博主的文章给我的帮助。PS网址:http://www.heguangming.com/

    1. 唐杰

      2012年11月13日 16:46

      感谢关注

发表评论

电子邮件地址不会被公开。 必填项已用*标注