Tool Mentor:  Reviewing Requirements Using Rational RequisitePro

Purpose

This tool mentor describes how to use Rational RequisitePro® to facilitate requirement reviews.

Related Rational Unified Process information: Activity: Review Requirements.

Overview

RequisitePro facilitates the review of requirements in a project team environment. All project documentation can be organized and accessed from a single location. Team members can then share comments about specific requirements or broader aspects of the project through online discussions. All discussion items, which can be shared in e-mail or directly in RequisitePro, are stored in the project database for later review. To review requirement documents, an author can temporarily secure a document during review and revision. Revisions are later merged back into the project and made available to all team members.

Tool Steps

The following requirements review concepts and procedures are presented in more detail.

1. Access requirements documents in a single location
2. Record requirements changes in documents
3. Develop a project team dialog
4. Secure requirements documents for review and revision

As requirement documents are created or imported in RequisitePro, they are integrated into the requirements management project. Each document is associated with the project database, which allows rapid, centralized access by all users. All requirement documents in the project can be opened from a single dialog box. You can also add nonrequirement documents, such as a glossary, to your RequisitePro project for easy access by your project team. In addition, requirement information is available through a variety of interfaces, including Microsoft® Word, views, and RequisiteWeb.

To create a requirements document:

1. In the Explorer, select the package in which you want the new document to reside. Then click File > New > Document. The Document Properties dialog box appears.
2. On the General tab, type a name and description for the document. From the Document Type drop-down list box, select a document type on which to base your new document.
3. Click OK.

To open one or more requirement documents while a RequisitePro project is open:

• In the Explorer, double-click the document you want to open.
• In the Explorer, select the document you want to open, right-click, and select Open.

To import a Word document that contains requirement text:

1. Click File > Import. The Import Wizard appears.
2. Select the Microsoft Word Document option. Then type the path and name of the Word document you want to import, or click Browse and navigate to the document you want.
3. Click Next to advance in the wizard. When you select the Requirements and document option, RequisitePro parses the requirements automatically and marks them in the imported document. You can parse the requirements on the basis of keywords, text delimiters, or Word paragraph styles.
4. Click Help on any screen to access additional instructions.

For More Information

Refer to the following topics in the RequisitePro online Help:

• Creating requirements documents (Index: documents > creating)
• Opening documents (Index: documents > opening)
• Importing requirements from a Word document (Index: importing > requirements from a Word document)

2. Record requirement changes in documents

When you modify a requirement's text in a document, you must describe the reason for the change. RequisitePro records and monitors revision information, thereby providing a record of the history of requirement changes.

To record a requirement change in a document:

1. Modify the requirement text.
2. Click anywhere in the requirement text, and then click RequisitePro > Requirement > Annotate Change. The Change Description dialog box appears.
3. In the Change Description text box, type a reason for the change.
4. Click OK to close the dialog box.

Requirement change information is available to project members. Click Requirement > Properties, and then click the Revision tab. RequisitePro generates a revision number for the requirement, indicates the date and time on which the change was made, lists the author of the revision, and provides a description of the change.

For More Information

Refer to the following topics in RequisitePro online Help:

• Revisions overview (Index: revisions > overview)
• Creating and modifying requirement revision information (Index: revisions > requirements)

3. Develop a project team dialog

RequisitePro facilitates team communication and review with discussion groups, making it easy for users to discuss their requirements. With discussion groups, users can quickly create and distribute discussion topics—comments, issues, problems, or even change notices— regarding a requirement or any aspect of the project. Distribution can be to the entire team or limited to a specific group of users. If e-mail is enabled for the project, replies can be made within RequisitePro or RequisiteWeb or with any SMTP e-mail application. RequisitePro notifies users of new messages and stores the discussion threads along with the associated requirements for easy reference by the whole team.

Project teams encounter during a project include capturing often forget to capture the rationale for making decisions and proposing changes. Discussion groups help teams solve such problems by allowing users to do the following:

• Create discussions and associate them with a single requirement, a set of requirements, or the whole project
• Automatically distribute an e-mail message (if enabled) to the selected discussion audience
• View a graphical representation of discussion threads in a hierarchical tree format showing comments and replies
• Run queries on discussions
• Modify the attributes of a discussion (priority, status)
• Print discussions

To create a discussion:

1. Do one of the following:
   • In the Explorer, select a requirement and click Requirement > Discussions.
   • In a view, select one or more requirements, and click Requirement > Discussions.
   • In a Word document, click anywhere in a requirement and then click RequisitePro > Requirement > Discussions. The Discussions dialog box appears.
2. Click Create.
3. In the Discussion Properties dialog box, click the General, Attributes, Participants, and Requirements tabs to define the discussion and add participants. You have the option of associating the discussion with requirements.
4. Click OK.

To view and reply to a discussion:

1. Click Project > View Discussions, or click the highlighted discussion icon on the toolbar (indicating that a new discussion message has been created).
2. In the discussions list, click a discussion. An expand/collapse indicator is displayed to the left of discussions with responses.
3. Click an item to read it.
4. To respond to the selected discussion item, click Reply.
5. In the Discussion Response dialog box, type your response.
6. Click OK.

For More Information

Refer to the following topics in the RequisitePro online Help:

• Creating discussions (Index: discussions > creating)
• Reading discussions (Index: discussions > viewing)
• Responding to discussions (Index: discussions > responding to)
• Configuring e-mail for discussions (Index: e-mail > discussions, setting projects up for)

4. Secure requirements documents for review and revision

The "offline authoring" feature in RequisitePro enhances the review process by allowing authors to "check out" a document from the project and revise it in Word. A read-only copy of the document remains in RequisitePro; it is protected from modification by other team members until the review is complete. The offline document, which is simply a Word document, can be distributed to co-authors for review and revision. The resulting document can be brought back online, and the review cycle can be completed.

While the document is offline, the user who took the document offline has the ability to mark (create), unmark, and delete requirements in the document using Microsoft Word. The user can route the document to other team members for similar revisions. (It's recommended that you maintain only one copy of the offline document and pass that copy to each team member in turn.) Other users can view the document in RequisitePro but not edit it.

When the document is brought back, RequisitePro does the following:

• It creates requirements from the marked text.
• It updates the database with changes made to existing requirements. These can include deletions, modifications, and additions. If requirements were deleted, the owner of the offline session is prompted before the deletions are recorded.
• It rejects any changes to requirements that the user does not have permission to edit. In this case, the entire document returns to its original online state.

To take a requirements document offline:

1. Click Tools > Offline Documents.
2. Click the document you want to take offline. (Use a multiple select action to select multiple documents.)
3. Click Take Offline. The Take Offline Information dialog box appears.
4. Type a reason for taking the document offline and the directory path where you want to store the document (or click Browse to locate the directory).
5. If you are taking multiple documents offline, select the Apply to All check box to apply the Reason and Location entries to all the documents. Clear this check box to address each document individually.
6. Click OK.

To bring documents back online:

1. Click Tools > Offline Documents.
2. In the Offline Documents list, select the document you want to bring back online.
3. Click Bring Online.
4. In the Description of Changes text box, type a description of the changes made to the currently selected document while it was offline. If you are bringing multiple documents back online and the changes apply to all subsequent documents, select the Apply to All check box.
5. Click OK. Click Yes to accept the updated document.

For More Information

Refer to the following topics in the RequisitePro online Help:

• Taking documents offline (Index: offline authoring > taking documents offline)
• Bringing offline documents back online (Index: offline authoring > bringing documents back online)

Copyright  © 1987 - 2001 Rational Software Corporation

Rational Unified Process