级别: 初级 Lynne P. Kues, 高级软件工程师, IBM David E. Murray, 资深软件工程师, IBM
2009 年 11 月 04 日 IBM Rational Requirements Composer 通过提供统一的工具和视图,来搜索、注释、定义,以及在不同类型的工件之间导航,从而促进协作。来自 Rational Requirements Composer 开发员的特定技巧,使得这些对公用技巧的解释更加精确,以帮助您更有效率的使用该款软件。分析使用这些技巧,可以减少花在不必要工件和冗余信息上的时间,从而腾出更多的时间完善用户的需求。本文是本系列三部曲的第 2 篇。
在本系列 第 1 部分,关于导航,我们探讨了若干种定位工件以及将其在编辑器中打开的方式。现在我们将注意力转移到在打开工件之后怎么处理它们。
在 Rational Requirements Composer 中,注释工件或者工件中元素的特性,以及将其链接到团队成员创建的工件的特性都是通用的。每一种工件的编辑器,包括那些不属于 Rational Requirements Composer 的工件(图片,Microsoft® Word® 文件,等等),在报头都含有相同的控制因素,以查看和管理工件的注释、链接和需求。接下来的章节描述了,怎样最佳使用这些特性。
添加注释的技巧
注释工具条视图
注释工具条视图显示了特定工件的所有注释。注释可以通过以下渠道进行创建:
- 工件的编辑器区域,通过使用 Add Comment
工具栏按钮(图 1 左边控制器),或者元素的下拉菜单来进行操作。
- Comments 工具条视图中的 Comment 菜单(图 1 右侧的按钮)。Comment 菜单是环境敏感性的,基于工件编辑器区域选择的不同而有所不同。
图 1. 创建一条注释
为活性元素(以前屏幕截图中的“Mastercard”标签)创建新注释的选项,回应选择的注释的选项都在 Comment 菜单中。您可以使用工具栏上的下拉工具项,或者在工具条上右击,来显示 Comment 菜单。
技巧 1:
在写对工件中元素特定的注释之前(例如,用户界面草图或者文件段落中的一个标签),点击该元素以选中它。在您的同事稍后点击注释时,该元素就会被选中。
Comments 工具条也包含了为工件创建注释(与注释工件内的元素相反)的选项。通过使用 Create a New Comment for the Artifact 操作,来创建工件层次的注释。为了对非 Rational Requirements Composer 资源创建注释,请使用工件层次的注释。
多格式文本注释
Add Comment 窗口(图 2)支持默认条件下能够使用的拼写检查程序,以及多格式文本和链接创建。
图 2. Add Comment 窗口
技巧 2:
在合适的地方,向文本和链接添加您的注释,以让阅读注释的人导航起来更加容易。最大程度的利用拼写检查特性。
您可以切换至 Comments 工具条内注释的链接。图 3 所示的注释有两个链接。
图 3. 带有链接的注释
过滤注释
随着工件得到定义、评审、检查,关于工件的注释的数量也随之增长。您可以使用过滤器,来限制在工具条内显示哪一些注释。例如,您可能只对特定时期内的注释感兴趣,或者您只对与自己直接相关的注释感兴趣。使用 Comments 工具条内的 Filter 按钮,来过滤注释。
Comments 工具条部分将会显示注释是什么时候过滤的。在图 4 内的屏幕截图中,三条注释满足指定的标准,两条注释被过滤出,由“(3 of 5)”标签指示。
图 4. Comments 工具条部分指示的过滤器
技巧 3:
使用 Comments 工具条上的过滤器控制,来查看只对您重要的注释,例如那些您需要处理的,或者上周创建的等等。
在过滤注释时,还需考虑注释和所有的回应,回应的原始注释会一直显示出来。在图 5 中,注释 1 被显示出来,因为我们使用的是“Janet Thompson”来进行过滤的,然后 Janet 就会回应原始的注释了。
图 5. 回应一条未过滤的注释
强调所有操作需要考虑过滤。在图 6 中,Comments 工具条中只有那些拥有注释的元素会强调显示出来。注释被过滤出了的元素没有被强调显示出来。
图 6. 强调显示的注释元素
对注释进行分组和分类
注释可以在 Comments Sidebar 内得到分组和分类。例如,您可以使用 Group by Artifact Element 选项,来查看与图表中特定元素相关的注释。
图 7. 根据元素分组注释
您还可以根据 Author 和 Date,对注释进行分组和分类。
- 在根据 Author 进行分类和分组时,顶级注释的作者将会用作操作执行的基础。
- 在根据 Date 进行分类和分组时,将会考虑顶级注释和所有对它的回应;因此,对注释(包括它的回应)的最后一次操作的日期将会反映出来。
在图 8 中,注释将会根据 Date Last Modified 进行分类。在这里“Last Modified”才是关键点。注释 4 是在 2008 年 12 月 9 日作出的,所以该注释要比注释 10 来的更早,注释 10 是在 2009 年 6 月 6 日作出的。但是,早期作出的注释(4)会在晚期注释(10)之前出现,因为早期的注释有最近的回应。因此,注释 4 会在注释 10 显示之前结束。
图 8. 根据日期分类的注释和回应
技巧 4:
根据 Date Last Modified 进行分组或者分类,以引起对“活性”(最近所做的注释或者回应)注释线程的注意。
从注释发送电子邮件
每一条注释都含有书写注释的用户的名字,以及注释寄往用户的名字(如果指定的话)。左击用户名以向特定的用户发送一封电子邮件。
图 9. 点击 User Name 以发生电子邮件
解决多个注释
Comments 工具条支持多重选择。为了选中多个注释,在选择注释时按住 Ctrl 键。在有一个或者多个注释被选中时,环境菜单中的 Resolve Comment 操作就可以使用了,这样就可以一次性解决多条注释了。
为了解决一个元素上的所有注释,选中工件编辑器区域内的元素。该操作将会选择工具条内与注释相关的元素。在下面的屏幕快照中,三条注释与 Validate Credit Card 任务相关。当元素被选中时,这些注释会在工具条内被选中。然后就会执行 Resolve Comment 操作,以解决元素上的所有注释。
图 10. 选择多条注释
技巧 5:
使用 Ctrl 键来一次性选择或者释放多个注释。为了释放一个元素上的所有注释,选择该元素,并释放强调显示的注释。
添加链接的技巧
Links 工具条视图
Links 工具条视图显示了与特定工件相关的所有连接。在视图中,链接会按照以下格式进行显示:
目标工件( Source Element)
Target Artifact 就是需要链接的工件(终点),而 Source Element 就是链接开始(起点)的元素。
通过使用元素的环境菜单,或者使用 Link to other artifacts 工具栏按钮( ),来为基于图表的工件的元素,从工件的编辑器区域创建链接。
链接可以从 Links 工具条视图来创建链接(图 11)。Links 工具条上的 Links 菜单,基于工件编辑器区域选择的内容而是环境敏感性的。
图 11. 为工件或者元素创建链接
Links 工具条还包含了为工件(该链接中工件是链接的源头,而不是工件内的元素)创建链接的选项。您可以通过使用 Create a New Link for the Artifact 操作,来创建工件层次的链接。工件层次的链接对定义来自非 Composer 资源的链接特别有用。
过滤链接
在 Links 工具条视图之内,您可以根据链接的目标工件来过滤链接。使用 Links 工具条内的 Filter 工具栏按钮(图 12 中所示的三个三点箭头),来过滤链接。
图 12. 过滤 Links 工具条内显示的链接
技巧 6:
过滤 Links 工具条上的链接,以快速找到对特定类型工件的引用(例如,一个 Microsoft Word 文件)。
Links 工具条部分将会指示,链接什么时候被过滤掉。在图 13 中,有 4 个链接被过滤出,从而显示出“5 of 9”。
图 13. 显示一些链接被过滤出的链接
强调所有操作会考虑过滤因素。在图 14 中,只有链接到 Links 工具条的那些元素被强调显示出来。链接被过滤出的那些元素没有强调显示。
图 14. 链接没有被过滤出的元素才会被强调显示出来
编辑链接
在 Rational Requirements Composer 内,每一个工件都是根据 permalink 字符串来标示的,这是一个独一无二的标识符,它并不是来自工件名字或者它的位置。因此,如果一个工件会得到重命名,或者移至不同的文件夹,指向工件的链接却会保存下来。
技巧 7:
在您重命名工件,或者将其移至另一个文件夹中时,不要在意对工件的链接。对工件已存在的链接不会受这些操作的影响。
您可以使用 Links 弹出视图(图 15)的 Edit 选项,来编辑已存在的链接。您也可以使用元素工具栏或者元素下拉菜单中的 Link to other artifacts 按钮,来打开该视图。
图 15. 在选中时显示元素有一个链接
为了编辑一个已存在的链接,在视图中选中该链接,并使用视图的下拉菜单。Edit Link 操作会打开“Link to”对话框窗口,在这里链接描述、链接的类型以及链接目标都可以进行编辑。
图 16. 编辑已存在的链接
工件层次的链接可以从 Links 工具条中进行编辑。从工具条上的 Links 按钮使用 Manage Artifact Links 菜单项(图 17)。该操作将会打开列出所有工件层次链接的 Links Popup 视图。注意该弹出视图只列出了工件层次的链接,而不是工件所有的链接。源自工件内元素的链接有它们自己的链接弹出视图,该视图可以通过元素的环境菜单或者元素工具栏上的 Link to other artifacts 按钮来打开。
图 17. 为顶级工件编辑或者删除链接
拖拉项目以创建链接
您可以拖拉资源到以下的工件以创建链接:
- Actor
- Business Process Diagram
- Document
- Requirement
- Use Case
- Use Case Diagram
使用 Project Explorer 或者 Search 视图来拖拉工件以创建链接。在基于图表的编辑器中,灰色背景可以指示链接是为哪一个元素而创建的(见于图 18)。
图 18. 将工件拖拉到图表元素上以创建一条链接
您也可以通过将目标工件拖拉到图表中的空白位置上,来创建工件层次上的链接。
技巧 8:
当用不同的工件修饰带有链接的工件时,考虑一下使用 Project Explorer 或者 Search 试图 中的其他工件,通过拖拉操作来添加链接。如果您是在编辑器中添加的链接,那么您就需要在“Link to”对话框中,切换到每一个目标工件。拖拉操作能够节省时间,因为您不需要为每一次链接执行切换操作。
对于基于文件的编辑器(角色,文件,需求,用例),红色的垂直线显示链接将会在文件的什么位置创建。对于基于文件的编辑器,也可以在拖拉工件到目标上时,通过按住 Ctrl 键,来嵌入到文件中。
图 19. 按住 Ctrl 键同时拖拉工件到文件上来嵌入工件
链接和需求
将需求与工件和工件内的元素联系起来的操作,不同于并分隔于创建链接的操作。在创建链接时,“Links to”对话框中的 Choose Existing Artifact 窗格将会过滤出需求工件,而 Create New Artifact 窗格并没有包含需求类型。为了将需求与工件内的元素联系起来,使用 Mark as Requirement 操作(图 20)。该操作位于工件元素的环境菜单中。
图 20. 从图表元素中导出需求
您也可以通过使用元素工具栏上的 Show Requirements 图标,来将需求与元素联系起来(图 21)。
图 21. 通过工具栏控制来管理对元素的链接
与工件相关的需求会出现在单独的工具条中。对 Requirements 工具条的操作类似于对 Links 工具条的操作。您可以从 Highlight All,Filter,或者 Sort 操作中进行选择,并切换至可用的源元素和目标元素。注意 Requirements 工具栏(图 25)并没有包含像 Links 工具栏这样的 Outgoing 与 Incoming 部分。当需求与工件相关时,工件将会作为 Links 工具条的 Incoming Link 而出现。
图 22. Requirements 工具条
为了将需求与工件联系起来作为一个整体,从 Requirements 工具条的 Requirements 菜单中使用 Create a New Requirement for the Artifact 操作。
图 23. 从整个工件中导出需求
您也可以通过使用工具条上 Requirements 菜单的 Manage Artifact Requirements 操作,来管理和编辑工件层次的需求。该操作会打开列出所有工件层次需求的 Requirements 视图。
图 24. 为顶级工件编辑或者删除需求
注意该弹出视图只列出了工件层次的需求,而不是工件的所有需求。与工件内元素相关的需求,会在 Requirements 弹出视图中单独显示,您可以通过使用原始的环境菜单或者元素工具栏上的 Show Requirements 图标,来打开该视图。
占位符链接
占位符链接就是与开始时未定义目标的链接。假设您遇到了一个用户,一起讨论特定程序的需求。在讨论期间,您开始商讨一些用户界面设计,而且您决定创建一个 User Interface Sketch,来获取讨论的内容。在您和该用户定义元素草图时,就会意识到,需要使用 Document 工件来为特定的字段定义验证规则。您可以为字段创建一个占位符链接并继续工作(设计用户界面),而不是必须为该额外的信息创建一个新的 Document 工件。稍后您可以获取该验证规则。
技巧 9:
使用占位符链接,来获取尚未存在工件之间的关系,以快速的获取需求。
为了创建一个占位符链接,使用 Links 弹出视图并指定一条链接描述,但是不要为链接指定目标。在图 25 中,创建了一条传递和处理规则的链接,但是定义这些规则的工件尚未存在,所以指定一条链接描述。
图 25. 在不定义目标的前提下添加一条链接
在 Links 工具条内,占位符链接通过一个钻石型的图标进行标示 。为了向占位符链接指定目标,您可以点击 Links 工具条内的链接,或者您可以编辑 Links 弹出视图中的链接。这两种操作都会打开“Link to”窗口,您可以在这里指定链接的目标。
图 26. 占位符链接
在将需求与工件联系起来之时,您也可以使用占位符。在图 27 中,Cardholder 名字区域可以有一个 Cardholder Validation 的占位符需求。
图 27. 占位符需求
特殊链接
有一些操作创建了工件之间的关系,而 Rational Requirements Composer 会自动创建 Links 中或者 Requirements 工具条的链接,来自动获取这些关系。创建链接的操作会根据工件类型而列出:
- Business Process 图表
- 使用 Use Case 图表或者草图精化一项任务
- 将系统用例与任务联系起来
- 将过程与子过程联系起来
- 用例图
- 使用共享的角色或者共享用例
- 精化脚本和用例
- 词汇
- 指定一个相关的或者同义的词
- 需求
- 管理 IBM® Rational® RequisitePro 中的需求®
- 用户界面草图
- 重复使用图形,部分或者草图
- 用户界面部分
- 重复使用图形,部分或者草图
- 故事板
- 将草图与框架联系起来
- 基于文本的工件(文件,角色,用例,需求
- 插人一幅图片或者工件(如果插人的工件就是需求,那么该联系会添加到 Requirements 工具条内)
- 通过使用 Mark As Requirement 来嵌入一条需求(该联系将会添加至 Requirements 工具条)
- 链接到词
注意这些链接不能直接进行编辑或者删除。相反,Rational Requirements Composer 会将这些链接,当做关于关系变更或者关系移动的信息来管理。
技巧 10:
当阅读或者评审同事所写的工件时,查看一下输出的和输入的链接和需求,以看那里是否有您感兴趣的相关工件。
技巧总结
技巧 1:在写对工件中元素特定的注释之前(例如,用户界面草图或者文件段落中的一个标签),点击该元素以选中它。在您的同事稍后点击注释时,该元素就会被选中。
技巧 2:在合适的地方,向文本和链接添加您的注释,以让阅读注释的人导航起来更加容易。最大程度的利用拼写检查特性。
技巧 3:使用 Comments 工具条上的过滤器控制,来查看只对您重要的注释,例如那些您需要处理的,或者上周创建的等等。
技巧 4:根据 Date Last Modified 来分组或者分类,以引起对“活性”(最近所做的注释或者评论)注释线程的注意。
技巧 5:使用 Ctrl 键来一次性选择或者释放多个注释。为了释放一个元素上的所有注释,选择该元素,并释放强调显示的注释。
技巧 6:过滤 Links 工具条上的链接,以快速找到对特定类型工件的引用(例如,一个 Microsoft Word 文件)。
技巧 7:在您重命名工件,或者将其移至另一个文件夹中时,不要在意对工件的链接。对工件已存在的链接不会受这些操作的影响。
技巧 8:当用不同的工件修饰带有链接的工件时,考虑一下使用 Project Explorer 或者 Search 试图 中的其他工件,通过拖拉操作来添加链接。如果您是在编辑器中添加的链接,那么您就需要在“Link to”对话框中,切换到每一个目标工件。拖拉操作能够节省时间,因为您不需要为每一次链接执行切换操作。
技巧 9:使用占位符链接,来获取尚未存在工件之间的关系,以快速的获取需求。
技巧 10:当阅读或者评审同事所写的工件时,查看一下输出的和输入的链接和需求,以看那里是否有您感兴趣的相关工件。
参考资料 学习
获得产品和技术
讨论
作者简介  | 
|  | Lynne Kues 是 IBM Rational 产品开发组的一名高级软件开发人员,从事 Rational Requirements Composer Web 客户端的工作。在加入 Rational 开发部之前,Lynne 的大部分时间在进行 IDE 和 GUI 工具集的开发。她是 Eclipse UI,SWT,eSWT 和面向 Java 团队 的 VisualAge 上的一名开发人员。她居住在美国北卡罗来纳州的 Asheville。 |
 | 
|  | David Murray 是 IBM Rational Requirements Composer 的 Common User Interface 团队的一名成员。他主要负责胖客户端的项目主页和搜索视图。David 于 2004 年毕业于罗彻斯特技术学院,计算机科学学士学位。在加入 Rational Requirements Composer 团队之前,他一直工作于 IBM Rational Business Developer 的 Enterprise Generation Language (EGL) 组件的编辑器。在此期间,他获得了为较少技术背景的业务开发人员交付改进软件的经验。 |
对本文的评价
|