怎么写开发用例?
最近在搞软件构建,总结下编写开发用例的知识。
用例是什么?
用例是文本形式的描述,使用系统实现用户目标的情节发现和纪录功能性需求
用例要说明的内容:
- 场景的简单描述
- 关于场景的假设条件
- 用例的发起参与者
- 场景的前置条件
- 场景中与系统相关的步骤序列
- 场景完成后的后置条件
- 用例的收益参与者
开发用例
编写用例的目的
用例是软件构建过程中经常被提到的名词。测试用例是为了让测试人员更好的测试,同样的道理开发用例就是更好的指导开发人员完成编码。
在这要说的是两个基本目标:
- 覆盖所有需求
通过用例对产品需求进行有效的整理,并将需求转成一个个用例。 - 指导开发
完整的用例减少开发人员在编码阶段对功能需求的重复思考,一方面可以调高效率,另一方面也能避免功能背离需求的情况。
编写用例
下面通过对用例的几个必备因素聊一聊写开发用例。
描述
描述要表达的基本含义就某某(角色)通过【xxx】(功能)做xxx,以达到xx的目的。由此可以得出用例描述所要体现出以下几个基本信息:
- 参与者——角色
- 行为——功能
- 目的——产生的影响
前置条件
前置条件就是说用户要做这件事情之前,必须要完成的事情或者具备的条件,没有做到这个条件不能执行当前行为。这个通常指业务上的一些前置,例如:必须登录;必须是某某角色。
后置条件
后置条件是执行完用例后产生的一些影响,比如:添加完信息后列表可以显示出来。
执行步骤
步骤主要说明用例在业务上的执行步骤。
写用例的粒度
粒度是一个很关键的问题,一般用例可以按照功能点划分,但是如果功能业务逻辑十分复杂,且非常耗时,这时是有必要拆分下用例,以便能分析问题逐个解决。另外一个可能是功能十分简单,没有具体的业务且耗时较短,这类看似没有必要写成一个用例,但是如果是一个独立的功能,还是要写的。
检查项
检查项不是用例必须的因素,但个人认为检查项十分有用,至少对于开发来讲。检查项应该是越详细越好,一方面可以清晰的体现业务的约束和边界为开发提供有利的帮助,另一方面可以很好的验证开发的完整性。