UML软件工程组织

编写用例文档
文档中应包括哪些部分,为什么要包括这些部分

Scott W. Ambler
总裁,Ronin International
2000年10月5日

Scott Ambler 阐明了基本用例和系统用例之间的区别,并针对如何编写这两类用例的文档提出了一些建议(主要讨论系统用例)。本文由《The Object Primer 2nd Edition》的第三章改编而来。

当记录基于组件的系统的行为需求时,用例是最常用的技术之一。开发人员常问的一个问题是,“用例文档应该包括哪些信息?”尽管我在此提到的一些部分是可选的,但在我看来,将这些部分包括在用例文档中不失为一个好主意。当编写基本用例的文档时(另请参阅前一篇技巧 Modelling essential use cases),我倾向于略去可选部分(因为基本用例关注的是是什么,而不是为什么,因此不必像系统用例那样复杂)。当编写系统用例时,我通常将所有部分都包括在内。回顾一下,基本用例和系统用例之间的主要区别是,系统用例包括了高级实现决策,而基本用例是要以与技术和实现无关的方式捕捉用户的意图。

参与者 (actor) 和被包含的用例这两个部分实际上只看用例图即可确定。但是,按我的经验,各个用例最好相互独立 — 换句话说,用例应该包含理解它们所需的全部关键信息以及它们所在的上下文。这使您的主题问题专家 (SME) 能够分别充实各个用例。(他们可能上午以小组为单位协同工作,下午则各自独立地以最快的速度充实所分配的用例,从而提高了整个小组的生产效率。)

用例的各个组成部分

为了让用例建模工作变得轻松一点,我制作了一个模板,它反映了本技巧说明的内容,可通过以下链接下载这个模板:Ronin International Reusable Templates。此模板是以 Microsoft Word(和纯文本)格式提供的,我希望此模板以及该网页上的其他模板对您能有所用处。

参考资源
有关用例的详细信息,请参阅:

  • 以前的技巧:"Modeling essential use cases"
  • 《Building Object Applications That Work: Your Step-By-Step Handbook for Developing Robust Systems with Object Technology》,Scott W. Ambler 著。纽约:Cambridge University 出版社,1998 年。
  • 《Process Patterns -- Building Large-Scale Systems Using Object Technology》,Scott Ambler 著。纽约:Cambridge University 出版社,1998 年。
  • 《The Object Primer 2nd Edition》,Scott W. Ambler 著。纽约:Cambridge University 出版社,2000 年。
  • 《Software For Use: A Practical Guide to the Models and Methods of Usage-Centered Design》,Larry L. Constantine 和 Lucy A.D. Lockwood 著
  • 《Use Case Driven Object Modeling with UML: A Practical Approach》,Doug Rosenberg 和 Kendall Scott 著
  • 《The Unified Modeling Language Reference Manual》,James Rumbaugh、Grady Booch 和 Ivar Jacobson 著。Reading,MA:Addison-Wesley Longman 公司,1999 年。
  • 《Applying Use Cases: A Practical Guide》,G. Schneider 和 J.P. Winters 著