Generating Use Case Specification A step-by-step guide for Training Scenario 1
Generating Use Case Specification
TABLE OF CONTENTS Introduction ...................................................................................................................................................................2 Accessing the Use Case Diagram using inteGREAT Portal .............................................................................................3 Defining Use Case Diagram and Requirements using SmartVisio4TFS ..........................................................................7 Step1: Managing the basic Use Case Diagram...........................................................................................................7 Connecting with Team Project ..............................................................................................................................7 Creating Business Requirement Work Item...........................................................................................................9 Creating Use Case Work Items ............................................................................................................................11 Step2: Drilling down Use Cases ...............................................................................................................................14 Linking Use Case Work Item with the other page in the diagram .......................................................................14 Creating Linked Work Items for the shapes in the drilled down page ................................................................18 Step3: Detecting Scenarios ......................................................................................................................................19 Step4: Detecting and Publishing Use Cases .............................................................................................................23 Step5: Attaching an actor Work Item with the Use Case ........................................................................................27 Step6: Detecting and publishing Test Cases ............................................................................................................29 Reporting using Customized EY Templates .................................................................................................................31
Generating Use Case Specification INTRODUCTION Generating Use Case Specification guide demonstrates how to create Use Case Specification document that can be generated using inteGREAT Portal, SmartVisio4TS and SmartWord4TFS. Step-by-step approach is taken to explain what to do, in order to model the Use Case Diagram, identify requirements, detect scenarios Use Cases and Test Cases and finally generate that particular document. During the course of this guide we would be working on the following Use Case Diagram (in Step1).
Generating Use Case Specification DEFINING USE CASE DIAGRAM AND REQUIREMENTS USING SMARTVISIO4TFS STEP1: MANAGING THE BASIC USE CASE DIAGRAM CONNECTING WITH TEAM PROJECT 1.
Create/open the desired Visio drawing.
2.
Click on SmartVisio4TFS Tab Choose Team Project option.
Generating Use Case Specification CREATING BUSINESS REQUIREMENT WORK ITEM We can now create Linked Work Items of the desired type that are automatically linked with the selected Visio diagram element (Diagram page, the selected shape etc.). We start by linking our Visio Diagram with a Business Requirement Work Item. 4.
Select Business Requirement from the Type drop-down list in Smart Panel.
5.
Enter “Subscriber management shall be provided by the system” as the name for the Work Item and hit the Enter key
Generating Use Case Specification CREATING USE CASE WORK ITEMS 7.
In the Ribbon Bar, click Attach Snapshot As Description to attach the snapshot of the Visio Diagram in the Description property of the Business Requirement Work item linked with the diagram.
8.
Select Sign up shape in the drawing and using the process described above, link it with a new Linked Work Item named Signup (of type Use Case).
While creating the Use Case Work Item, make sure to set Pre Conditions and Post Conditions using the Conditions Tab.
We can repeat the above process to create Use Case Work Items for all the shapes in the diagram. However SmartVisio provides us with an option to speed things up. 10. Click Bulk Add option in the Ribbon Bar.
11. Select Use Case Work Items types for the respective shapes, give suitable descriptions and click the Create Button.
Note: Clicking inside the Description cells produces default descriptions. Users can use these descriptions as is, or update as required.
All the Use Case Work Items (either created individually or using Bulk Add option) are created as child of the Business Requirement Work Item created earlier.
Generating Use Case Specification STEP2: DRILLING DOWN USE CASES Step 1 described the process of managing the Use cases of the application. In this step we would drill down use cases for a more elaborate management of the requirements. This requires creating separate Visio diagrams for each use case created in step1. There are two approaches to this task: Select relevant shape (linked with a Use Case) and click the Drill Down option in the Ribbon Bar. This would create a new page in the Visio drawing where we can start designing the work flow of the use case. Alternatively if we can use a Visio diagram which has all the relevant pages added (this is the scenario used in this training), then we can link the desired Use Case Work Item with the relevant page.
LINKING USE CASE WORK ITEM WITH THE OTHER PAGE IN THE DIAGRAM 1.
The Use Case Work Item is now linked with the second page in the Visio diagram.
Now we can start linking the shapes of this new page in the diagram with the relevant Work Items. Since we are now drilling down one of the Use Cases therefore we would link the shapes in this page with Functional Requirement Work Items instead of Use Case Work items.
Generating Use Case Specification CREATING LINKED WORK ITEMS FOR THE SHAPES IN THE DRILLED DOWN PAGE 6.
Using the same process employed in Step 1, created linked Work Items for the shapes of this new page in the diagram. Use the following table as a cue to create the Linked Work Items.
Shape in the page Show Sign Up page Select Plans to sign up Get credit card info and check credit Request subscriber to call toll free number Show details to subscriber and ask to confirm Setup user subscription Show confirmation
7.
Linked Work Item Title System shall allow users to signup The system shall allow users to select plan that they wish to signup for Use credit card to check for risk before signing user up System shall allow users to call CSR in case the signup credit check fails Before signup is complete the user will be asked to confirm Subscription signup info will be recorded the CMS and support system Show confirmation to user of their signup details
Work Item Type Functional Requirement Functional Requirement Functional Requirement Functional Requirement Functional Requirement Functional Requirement Functional Requirement
Similarly create Issue and Non Functional Requirement type Work Items.
Note: Since Non Functional Requirements describe the quality of the system (and are not associated with a particular functionality) therefore these Work Items are not created to be linked with a shape in the page but are linked with the page itself. The same is true for issues. 8.
Repeat the process described in this step with all the Use Case Work Items created in Step 1.
Generating Use Case Specification STEP3: DETECTING SCENARIOS In Step 1 and 2 we created Linked Work Items to elaborate our system. However another aspect of elaborating our system is to detect various scenarios. SmartVisio4TFS offers users a very easy and hassle free way to detect all the scenarios present in a carefully designed Visio page/diagram. Once detected, we can create Work Items for each of the detected scenarios in the list. The details are discussed in the following steps: 1.
Click Scenarios Tab in Smart Panel.
All the scenarios are automatically detected and listed. The selected scenario is highlighted with green colored path in the diagram.
Generating Use Case Specification STEP4: DETECTING AND PUBLISHING USE CASES In Step1 we created Use Case Work Items on application level. In this step we would automatically detect Use Cases paths relevant to our process flow. Keep in mind that this process flow is the elaboration of one of the Use Cases that we created in step1. This means that the Use Cases detected and published in this step are the drilled down elaboration of one of the Use Cases of step1. The Use Cases detected with SmartVisio4TFS come with automatic narration, describing in details the sequence of events in that particular Use Case. SmartVisio4TFS also tells which Use Case is the default flow, as per the modeled diagram. However users can always override this and choose another flow to be the default one. The steps involved in detecting and publishing Use Case are described below. 1.
Click the Use Case Tab in the Smart Panel.
All the Use Cases are automatically detected and listed. The selected Use Cases is highlighted with blue colored path in the diagram.
Give a suitable title to the selected Use Case and click the small button besides the title text box.
5.
Enable the Use case in description check box and then click the Publish Button.
This publishes all the information (related to the selected Use Case Path) as the description of the Use Case Work Item, linked with the drilled down page of the Visio diagram (shown in the following image).
Generating Use Case Specification STEP5: ATTACHING AN ACTOR WORK ITEM WITH THE USE CASE It is necessary to have an Actor/Role that would use a particular Use Case. In this step we would create an Actor Work Item linked with the Use Case of the drilled down page. 1. 2.
Click on the background of the diagram so that the drilled down page is selected. Click on Links Tab in Smart Panel.
3.
Select Actor as type of Work Item and enter a suitable title for Actor Work Item.
4.
Hit the Enter key
, set desired properties and click the Save Button.
Generating Use Case Specification STEP6: DETECTING AND PUBLISHING TEST CASES The last major step in this training involves detecting and publishing Test Cases. Like Use Cases, SmartVisio4TFS also has the ability to automatically detect test cases. The relevant steps are elaborated below. 1.
Click Test Cases Tab in the Smart Panel.
All the Test Cases are automatically detected and listed. The selected Test Cases are highlighted with orange colored path in the diagram.
Edit the name of the selected Test Case and click the Publish Button.
3.
Repeat the process with all the desired Test Cases that are required to be published.
This completes the authoring part of this training. Next we would carry out the reporting part to bring out all our efforts in the shape of customized EY Templates.
Generating Use Case Specification REPORTING USING CUSTOMIZED EY TEMPLATES This step involves opening the desired template using inteGREAT Portal. The detailed steps are given below. 1.
Log on to inteGREAT Portal and navigate to the folder where the desired template has been uploaded.
2.
Select the template (Use Case Specification in our case) and click the Open option.
Connect the document to the relevant Team Project. (The process is virtually the same as we carried out in SmartVisio4TFS). Click the mouse inside the placeholder in the document and then click the Refresh option in the Ribbon Bar.
All the information that we created/published in SmartVisio4TFS is extracted from the Team Project and populated in the document appropriately.
This template supports bi-directional information transfer with the connected team project. Therefore if we update any information then clicking the Refresh option would update the information on Team Project as well.
This completes our step-by-step guide to create the Use Case Report.
