getting started stpsoft requirements definer€¦ · getting started 3. requirements ribbon bar...

stpsoft Requirements Definer v2.0 Quick Start Guide v2.0 of 17 Copyright © 2011 stpsoft limited

Getting Started stpsoft Requirements Definer is a requirements definition tool for Microsoft® Visual Studio® Team Foundation Server 2010/2008 based on Microsoft® Visio® 2010. The tool transforms Visio diagrams in to structured requirements and test cases in Team Foundation Server, and in to structured requirements in Microsoft® Word for review and approval.

Typographical Convention: When asked to enter or select text in quotation marks, e.g. “some text…”, do not include the quotation marks. Important: Before starting ensure that you have access to a TFS 2010 or 2008 team project that can be used for training purposes. The project in this guide is based on the TFS 2010 “MSF for CMMI Process Improvement” process template. Ensure that your training project is based on this process template. Note that stpsoft Requirements Definer supports TFS 2010/ TFS 2008 team projects based on any process template. Note that screenshots in this guide may vary from actual screens. Start Visio 2010 and create a new document using the Basic Diagram template in the General template category. Note that you can use any Visio template to create diagrams for use with stpsoft Requirements Definer.

1. Create a new document

2. Select a TFS project

Minimize the Shapes window by clicking the < button at the top right of the Shapes window. You may want to increase the document zoom factor. In the example screenshot on the left, the zoom has been increased to 106% Select the Requirements menu from the Visio ribbon bar.

Click the button to select a TFS team project. Select your training TFS team project. Click OK to close the Choose Team Project screen. If you are working with a TFS 2008 team project, you will be prompted to select a work item type to represent a test case. Also note that some screenshots and descriptions may vary from those shown and described in this guide. Once the project is selected you can work with the Visio document offline. The example in this guide will be based on a generic self-service point-of-sale terminal for use in restaurants, hotels and health clubs. Save the Visio document as “POS Terminal.vsd”


Getting Started

3. Requirements ribbon bar

Choose Team Project Clicking the Choose Team Project button selects a TFS 2010 team project for use with the Visio document. Requirements in the Visio

document will be published to the selected project. If the list of ‘work item types’ or ‘link types’ is updated in the TFS team project configuration, clicking this button again will update the work item types and link types in the Visio document.

Mark Up Page Shapes that are ‘marked up’ represent work items in TFS. Although the tool is primarily concerned with marking up shapes as

requirements, shapes can be marked up as any work item type in the TFS team project. Clicking the Mark Up Page button marks up all shapes (including connectors) on the current page of the Visio document. Any new shapes added to the page will be marked up automatically. The Mark Up Page button is primarily used on pages in a new Visio document or on blank pages in an existing Visio document.

Mark Up Shape Shapes that are ‘marked up’ represent work items in TFS. Although the tool is primarily concerned with marking up shapes as

requirements, shapes can be marked up as any work item type in the TFS team project. Clicking the Mark Up Shape button marks up all selected shapes (including connectors) on the current page of the Visio document. The Mark Up Shape button is primarily used to mark up shapes on existing Visio documents.

Description Window Clicking the Description Window button displays a rich text window for entering a description of the current selected shape or the

current page (if no shapes are selected). Requirements List Clicking the Requirements List button displays a window containing a list of marked up shapes. Marked up connectors are not included

in the list. Get Work Items Clicking the Get Work Items button imports work items on to the current page. Imported work items are represented as rectangles and

they are marked up automatically. Any TFS links between the imported work items are represented as connectors between the respective work item shapes. The Get Work Items button can be used to incorporate existing work items in to a Visio diagram. The button can also be used on a new page to visualize the relationships between work items in a saved query.

Publish Clicking the Publish button publishes validated marked up shapes to the TFS team project as work items. New work items are added to

the team project and existing work items are updated. Connectors are published as links between work items. Grouped shapes are published as children of the group parent shape.

Trace Forwards Clicking the Trace Forwards button produces a diagram to trace the forwards relationships between a work item and other work items

in the team project. This is especially useful for impact analysis, for example, ‘show me the requirements, tasks and test cases that could be impacted if I change this requirement…’

Trace Backwards Clicking the Trace Backwards button produces a diagram to trace the backwards relationships between a work item and other work

items in the team project. This is especially useful for impact analysis, for example, ‘show me the requirements that are at risk because this test case has failed …’

Trace Related Clicking the Trace Related button produces a diagram to trace the forwards and related relationships between a work item and other

work items in the team project. This is especially useful for impact analysis, for example, ‘show me the requirements, tasks and test cases that could be impacted if I change this requirement, including any that are simply related to this requirement…’

Word / PowerPoint Clicking the Word or PowerPoint buttons exports the marked-up requirements to a Word document or a PowerPoint presentation.


Getting Started

4. Add a new stencil

As well as using the standard Visio stencils, you can create your own stencils and fill them with shapes that you have customized. We will mark up and customize a shape to represent the requirements for a generic self-service POS terminal and then add the shape to the new stencil for re-use.

Click the button at the top of the minimized stencil window. Select the More Shapes menu and then select one of the New Stencil menu options. A new stencil will be added to the stencils window. Expand the stencil window by clicking the > button at the top right of the window. Right-click the header of the new stencil and select Save from the pop-up menu. Save the stencil as “POS System Shapes.vss”, and minimize the stencil menu by clicking the < button. Note that custom stencils can be shared by saving the stencil file on a network share.

5. Add a new shape

Select the Data ribbon bar and tick the Shape Data Window box to display the Shape Data window. Dock the window on the right edge of Visio. Select the Home ribbon bar and click the Rectangle button in the tools group:

Draw a rectangle on the Visio page. Click on the Pointer Tool button in the tools group to revert the mouse pointer back to normal. Select the new shape, go to the Requirements ribbon bar and click the Mark Up Shape button. A text label is added to the shape with the text “Name”. The text label has an orange background to indicate that the shape is incomplete and cannot be published to TFS.


Getting Started

6. Define the shape

To complete the shape, the shape must have a text label, a definition and a type. To edit the shape’s label click the shape, type “POS Terminal” and press the Esc key. The definition and type can be edited in the Shape Data window. Click the Definition field in the Shape Data window and type “Self-service point of sale terminal for {purpose}”. Click the Type field and select “Requirement” from the pick-list. The orange background behind the shape label disappears to indicate that the shape is now valid. Click on the Visio page to de-select the shape, and then click on the shape to select it again. A floating smart menu icon is displayed to the left of the shape. Click the icon and a pop-up menu is displayed.

7. Add Child Requirements

Click the Add Detail… option on the pop-up menu to display the Add Detail window. In the Subject field type “Form Factor” and click the OK button. Add five more child requirements with the following subjects: Interface Operating System Connectivity to Host Card Reader Printer Note that the pop-up menu options are also available at the top of the shape’s right-click menu.

Click the button on the Requirements ribbon bar to display the Requirements List window. The window lists the POS Terminal requirement and its child requirements. Since the child requirements have yet to be defined, they are suffixed with the text “To be defined…”


Getting Started

8. Add the shape to the stencil

Drag the shape from the Visio page and drop it on to the new stencil window. The shape will be added to the stencil. Right-click the shape in the stencil and select Edit Master / Master Properties… from the pop-up menu. Clear the text in the Name field and type “Terminal”. Click the OK button.

9. Define the system overview

Rename the Visio page by double-clicking the “Page-1”

tab at the bottom of the Visio page. Type “Restaurant

Ordering System” and press the Esc key.

Go to the Insert ribbon bar and click the Clip Art button. In

the Clip Art window enter “mainframe” in the Search for

box and click the Go button. Click the first picture in the

list. Enter “diner” in the Search for box and click Go. Click

a picture of a Chef and a picture of some Diners. Close the

Clip Art window.

Reduce the size of each clip art image and lay them out on

the Visio page as in the screenshot.

Drag the Terminal shape from the new stencil and drop it

on to the Visio page. Drag the yellow diamond to the top

of the shape to move the shape text. Add another

Terminal shape to the page, press F2, rename the shape

text to “Kitchen Terminal” and press Esc. Lay the shapes

out as in the screenshot.

Go to the Home ribbon bar and click the Connector

button in the Tools group. Place the mouse pointer over

the Chef and a red border will appear. Press the mouse

button and drag across to the Kitchen Terminal until the

shape border turns red. Release the mouse button and a

connector will be added linking the two shapes. Type the

text “Confirm order” to label the connector and press Esc.

Connect the Kitchen Terminal and Host. Connect the POS

Terminal and Host. Connect the Diners and POS Terminal

and label the connector “Order details”.

Go to the Requirements ribbon bar and click the Mark Up

Page button to mark up all the shapes and connectors on

the page. Rename the shape text for the clip art images to

“Kitchen Staff”, “Host” and “Customers” (as in the

screenshot).

Note that the diagram in the screenshot above is conceptual and does not show all the flows in the system. The level of detail will usually depend on which stage you are at in the requirements process. For example, early brainstorming sessions could produce a similarly high-level rich picture, whereas detailed requirements workshops could produce a detailed rich picture, business process model or use case diagram. The tool is not limited to a particular Visio stencil or template, allowing you the flexibility to use the most appropriate diagramming technique for the task.


Getting Started

10. Define the requirements

Multi-select the clip art image shapes by pressing the Shift

key and clicking each shape. In the Shape Data window

click the Type field select “Requirement”. Click on the

Visio page canvas to de-select the shapes.

Click the Customers shape and select Edit Details… from

the smart pop-up menu (or the right-click pop-up menu).

In the Definition field type “Browse the menu, select

menu items for each person, place order and pay for

order” and click the OK button.

In the same way set the definition of the Kitchen Staff to

“Receive order, confirm availability, advise alternatives

and complete order”, and set the definition of the Host to

“Order processing, stock control, payments and

reporting”.

Click the Order details connector, right-click and select

Edit Link Type… to view the Shape Data dialog window.

The Link Type (End) field contains a pick-list of TFS link

types. You can use this field to set the forward

relationship between the two linked shapes. Click Cancel

to close the dialog window.

Click the POS Terminal shape and select Edit Details…

from the smart pop-up menu (or the right-click pop-up

menu). In the Definition field replace the text “{purpose}”

with “placing and paying for meal orders”. Set the other

requirement field values as follows:

Form factor: “A5 size tablet”

Interface: “Touch screen”

Operating System: “Silverlight compatible o/s”

Connectivity to Host: “Wireless”

Card Reader: “Credit/Debit card payment”

Printer: “Print bill with full cost breakdown”

Click the Kitchen Terminal shape and select Edit Details…

from the smart pop-up menu (or the right-click pop-up

menu). In the Definition field replace the text “{purpose}”

with “receiving meal orders and confirming fulfilment

ability”. Set the other requirement field values as follows:

Form factor: “Tough A4 size tablet with

protective screen cover”

Interface: “Touch screen”

Operating System: “Silverlight compatible o/s”

Connectivity to Host: “Wireless”

Card Reader: “Staff identification and login”

Printer: “Print meal order”


Getting Started

11. Elaborate a requirement

Click the POS Terminal shape and select Elaborate… from


A new page is created containing a ‘container’ shape

called POS Terminal.

Click the header of the POS Terminal container shape to

select the shape. Press F2, rename the shape to “POS

Terminal Functions” and press the Esc key.

In the ribbon bar click the Format menu under the

Container Tools menu group. You can use the options in

this menu to change the appearance and heading style of

the container shape.

Go to the Home ribbon bar and click the Rectangle button

in the tools group. Place five rectangle shapes in the

container with the text “Browse Menu”, “Place Order”,

“Pay Bill”, “Request Assistance” and “Messages”.

Click the Pointer Tool in the Home ribbon bar to revert

the mouse pointer to normal. Multi-select the five

rectangles (press Shift and click each shape), and press the

Mark Up Shape button on the Requirements ribbon bar.

With the shapes still selected, go to the Shape Data window and select “Requirement” in the Type field.

You can use the font buttons on the Home ribbon bar to increase the size of the shape text.

Click on the Visio page background to de-select the selected shapes. Click the Browse Menu shape and select Edit Details… from the smart pop-up menu (or the right-click pop-up menu). Type “Allow the user to browse the current menu and add items to the meal order” in the Definition field and click Ok. Define the Place Order shape as follows: “Allow the user to allocate meal items from the menu to individual diners and to submit the meal order” Define the Pay Bill shape as follows: “Allow the user to request the bill and make a single payment or shared payments” Define the Request Assistance shape as follows: “Allow the user to request assistance from a member of staff” Define the Messages shape as follows: “Display messages from the kitchen, such as confirmation of order or alternative menu items” Go to the first Visio page Restaurant Ordering System and right-click the POS Terminal shape. Note that the pop-up menu contains a hyperlink to the new POS Terminal page.


Getting Started

12. Define a wireframe Go back to the new POS Terminal Visio page, click the

Browse Menu shape and select Elaborate… from the

smart pop-up menu (or the right-click pop-up menu).

A new page called Browse Menu is created. Double-click

the page tab and rename the Visio page to “Browse Menu

Wireframe”. Click the Browse Menu container shape

header, press F2, rename the shape text to “Browse

Menu Screen” and press Esc.

Go to the Home ribbon bar and click the Rectangle button

in the tools group. Place ten rectangle shapes in the

container as in the screenshot and label them with the

text “Back Button”, “Request Assistance Button”, “Menu

Browser”, “Diner Menu Basket”, “Select Diner Button”,

“Add Menu Item Button”, “Remove Menu Item Button”,

“Submit Order Button”, “Message Pane” and “Message

Response Buttons”.


Page button to mark up all the shapes on the page

(including the container).

Press Ctrl+A to select all the shapes and go to the Shape

Data window. Select “Requirement” in the Type field.

Click on the Visio page background to clear the selection.

Click the Browse Menu Screen container shape and select Edit Details… from the smart pop-up menu (or the right-click pop-up menu). Type “Browse the menu, order meals for each diner and submit the order” in the Definition field and click Ok. Define the other shapes as follows: Back Button: “Go back to the main options screen” Request Assistance Button: “Call for staff assistance” Menu Browser: “Current food and drink menu” Diner Menu Basket: “Menu items for the selected diner” Select Diner Button: “Select a diner or add a new diner” Add Menu Item Button: “Add the selected menu item to the diner menu basket” Remove Menu Item Button: “Remove the selected menu basket item” Submit Order Button: “Submit all diner menu baskets to the kitchen” Message Pane: “Messages from the kitchen” Message Response Buttons: “Yes / No buttons to respond to messages from kitchen”


Getting Started

13. Add a use case

Go to the first Visio page Restaurant Ordering System,

click the Kitchen Staff shape and select Elaborate… from


A new page called Kitchen Staff is created. Click the

Kitchen Staff container shape header, press F2, rename

the shape text to “Kitchen Staff Use Cases” and press Esc.

Go to the Home ribbon bar and click the Down Arrow

next to the Rectangle button in the Tools group. Select

the Ellipse shape from the drop-down menu. The mouse

will now let you add ellipse shapes. Add an ellipse shape

to the container shape as in the screenshot.

Select the Pointer Tool on the Home ribbon bar to revert

the pointer to normal.

Select the ellipse shape, type “Fulfil Order” and press Esc.


Shape button.

In the Shape Data window select “Requirement” in the

Type field.

14. Describe the use case

With the Fulfil Order shape selected, select Blank Definition from the smart pop-up menu (or the right-click pop-up menu). Notice that the orange background behind the shape label disappears to indicate that the shape is now valid, even though the definition field is blank. With the Fulfil Order shape still selected, click the Description Window button on the Requirements ribbon bar. Enter the following text in the shape description window: “Receive and fulfill a meal order for one or more diners. Alternative Courses: 1. Order cannot be fulfilled and no alternatives available. 2. Order cannot be fulfilled and alternative meal items available.” Highlight the text “Alternative Courses:” and click the Bold button on the Description window toolbar. Highlight both lines of text below this and click the Italic button. The text should resemble the text in the screenshot. Click the Update button in the Description window toolbar to save the text to the shape.


Getting Started

15. Define business rules

Business rules can be added to the use case as child

detail items.

With the Fulfil Order shape selected, select Add Details… from the smart pop-up menu (or the right-click pop-up menu) to display the Add Detail window. In the Subject field type “Order Validation Rule”, in the Detail field type “Each diner must have at least one meal item or beverage” and click the OK button. Add two more detail items as follows: Subject: “Meal Item Availability Rule” Detail: “Meal items must be available against current stock” Subject: “Alternatives Rule” Detail: “Alternatives can only be offered if their suitability has been confirmed by the chef”

16. Define the use case flow With the Fulfil Order use case shape still selected, select

Define Process Flow… from the smart pop-up menu (or the right-click pop-up menu). A new page called Fulfil Order Process Flow is created. The page contains a process container shape with two swimlanes. Click the header of the Actor swimlane, press F2 and rename the header text to “Kitchen Staff”.

Go to the Cross-Functional Flowchart ribbon bar and click

the Swimlane button to add a new swimlane. Rename the

new swimlane to “Diner Terminal”. Click the > button at

the top of the Shapes window to expand the window.

Drag a Process shape from the Basic Flowchart Shapes

stencil and drop it below the Start shape on to the Kitchen

Staff swimlane. Type “Request Next Order” and press Esc.

Go to the Home ribbon bar and click the Connector

button in the Tools group. Place the mouse pointer over

the Start shape and a red border will appear. Press the

mouse button and drag down to the Request Next Order

shape until the shape border turns red. Release the mouse

button and a connector will be added linking the two

shapes.

Add the Process, Decision and Start/End shapes as shown

on the next page. Connect the shapes and then label the

shapes and connectors as shown on the next page.

Select each Process shape in the System swimlane and click the Mark Up Shape button to transform these in to functional requirements, and then right-click each of these shapes and select Blank Definition from the smart pop-up menu (or the right-click pop-up menu).

Note that in order to generate test cases in TFS there must be at least one Start/End shape with only outgoing links. There are no restrictions on the number of swimlanes or how they are named.


Getting Started

Fulfil Order Process Flow

Kitchen Staff System Diner Terminal

Ph

ase

Start

Request next order

Display order details

Request

Can orderbe fulfilled?

Send message with alternative

items

Cancel order

Receive alternative

items message

from Kitchen

Accept alternatives

No message

End

No

Update order details

Yes

Send confirmation

message

Receive confirmation

message from kitchen

Yes

message

Prepare order

Send completion message

Receive completion

message from kitchen

message

Notify Waiting Staff order is

complete

End


Getting Started

17. Publish the requirements to TFS

You can quickly navigate to an invalid shape by double-clicking the invalid requirement in the Requirements List window.

Click the < button at the top of the Shapes window to hide the window. Go to the first Visio page called Restaurant Ordering System. Click the Requirements List button on the Requirements ribbon bar to view the list of requirements. Notice that the Id column is blank. When the requirements are published to TFS, the Id column will contain the TFS “WorkItemId”. Click the POS Terminal shape and select Edit Details… from the smart pop-up menu (or the right-click pop-up menu). Select the contents of the Definition field and press Ctrl+X to cut the text to the windows clipboard. Click the OK button. Look at the POS Terminal requirement text and its child requirement text in the Requirements List window. The text goes red indicating that the requirements are incomplete. Press Ctrl+S to save the Visio file. Click the Publish button on the Requirements ribbon bar to publish the requirements to TFS. Click Yes on the message box and wait for publishing to complete. Click OK on the message that appears after publishing, and scroll through the Requirements List to see the Ids and errors.

18. View a published work Item

Click the POS Terminal shape and select Edit Details… from the smart pop-up menu (or the right-click pop-up menu). Place the cursor in the Definition field, press Ctrl+V to paste the cut text and click OK. Save the Visio file and re-publish to TFS by clicking the Publish button on the Requirements ribbon bar. After publishing has completed, close the Requirements List window (click the x in the bottom left of the window). Place the mouse over the POS Terminal shape and click the smart pop-up menu icon. Select the Open Requirement: n menu option (n is the WorkItemId). A window is opened containing the TFS work item details. Click the All Links tab to view the work item links. You can resize the window to view all the contents. Notice that child work items have been created for each item in the functional elaboration. Child work items are also created for each child requirement. Related work items have been created for shapes linked to POS Terminal in the diagram. A test case has also been added based on the POS Terminal child requirements. Click Cancel to close the window.


Getting Started

19. View the forwards traceability for a work item

Select the POS Terminal shape, place the mouse over the shape and click the smart pop-up menu icon. Note the WorkItemId displayed next to the Open Requirement: menu option. Go to the Requirements ribbon bar and click the Trace Forwards button. The Search for… window is displayed. Click the IDs: radio button and enter the noted WorkItemId in the text box. Click the Find button, select the row in the results list and click the OK button. A new Visio page is added containing a forwards traceability diagram for POS Terminal. You can use the zoom slider in the Visio status bar to zoom in and out. Browse the diagram to see the work items and their relationships. Notice that the name of the Visio page begins with a ~. This indicates that the shapes on this page should not be published to TFS and should not be exported to the Word specification document. You can use the ~ page name prefix to exclude your own Visio pages from being published to TFS or Word. To exclude a specific shape from publishing or export (as opposed to the whole page), uncheck the Publish menu option from the shape’s right-click or smart pop-up menu.

20. View the verification checks test case

Follow the Tested By link from POS Terminal to the Test Case shape called POS Terminal Verification Checks. Place the mouse over the POS Terminal Verification Checks shape and click the smart pop-up menu icon. Select the Open Test Case: n menu option (n is the WorkItemId). A window is opened containing the TFS test case details. The test case contains a series of verification checks based on the POS Terminal’s child requirements (entered earlier in section 10). The verification checks are listed under the Steps tab. Click Cancel to close the window. Go back to the first Visio page called Restaurant Ordering System and create a forwards traceability diagram for Kitchen Terminal. View the TFS test case details for the Kitchen Terminal Verification Checks test case.


Getting Started

21. View the test cases based on the use case flow

Go to the first Visio page tab called Restaurant Ordering System. Click the Kitchen Staff shape, place the mouse over the shape and click the smart pop-up menu icon. Note the WorkItemId displayed next to the Open Requirement: menu option, and then select the Elaborate… menu option.

The Kitchen Staff Visio page is opened. This contains the kitchen staff use case Fulfil Order. Earlier in step 14 we defined the use case using a process flow diagram. Click the Fulfil Order shape and select Define Process Flow… from the smart pop-up menu (or the right-click pop-up menu). The Fulfil Order Process Flow page is displayed. Look at the various paths through the flow diagram. On publishing to TFS, a test case was generated for each path through the flow diagram. Note that to generate test cases, you do not need to use any swimlanes or even the process container shape. All that is required is that the diagram contains at least one shape that has only outgoing connectors (i.e. the start point).

Go back to the Kitchen Staff Visio page and click the Fulfil Order shape. Select the Open Requirement: n menu option (n is the WorkItemId) from the smart pop-up menu (or the right-click pop-up menu). A window is opened containing the TFS work item details. Click the All Links tab to view the work item links. You can resize the window to view all the contents. A parent work item has been created for Kitchen Staff. Test cases have been created for each path through the flow diagram. Each test case has been given an appropriate name, such as “Fulfil Order Process Flow: Cancel order” and “Fulfil Order Process Flow: Display order details”. Earlier we noted the WorkItemId of Kitchen Staff. You can also see the Id in the links tab under the Parent goup. Click Cancel to close the window. Go to the Requirements ribbon bar and click the Trace Forwards button. Generate a forwards traceability diagram using the Kitchen Staff WorkItemId noted earlier. View the TFS test case details for each test case in the diagram using each shape’s Open Test Case: n right-click or smart pop-up menu option.


Getting Started

22. Generate a specification document

Press Ctrl+S to save the Visio file. Go to the Requirements ribbon bar and click the Word button. The Export To Word window is displayed. Click the … button next to the Word template box, select the “stpsoft Definer Template.dotx” Word template file and click the Open button. Change the text in the Document title box to “Restaurant Ordering System – High Level Requirements”. Click the OK button, wait for the export to complete and then click OK on the completion message. The generated document is opened in Word (you may have to click on the Word icon on the Windows Start bar). Browse the document. In Word go to section 1.1. of the document and highlight the text “Form Factor: 15 size tablet”. Go to the Review ribbon bar and click the New Comment button. Type the comment “Also provide A4 option”. Save and close the Word document. Note that the document can be uploaded to SharePoint for review and comments. You may want to resize some of the larger diagrams before circulating the document.

23. Update the specification document

In Visio go to the first page called Restaurant Ordering System and click the POS Terminal shape. Select Edit Details… from the smart pop-up menu (or the right-click pop-up menu). Change the text in the Form Factor field to “A5 size tablet as standard with A4 option”. Click the OK button. Press Ctrl+S to save the Visio file. Go to the Requirements ribbon bar and click the Word button. The Export to Word window is displayed. Notice that the Compare with previous version box is ticked and the field contains the path and filename of the previously generated document. Click OK to generate the document and when the export is complete click OK on the completion message. In Word go to section 1.1. Notice that the comment is still there and that the changed text is highlighted. Go to the Review ribbon bar and click the down arrow below the Accept button. Select the Accept All Changed in Document option to accept all the changes. Right-click the comment and select Delete Comment from the pop-up menu to delete the comment. Save and close the Word document.


Getting Started

24. Publish changes to TFS

In Visio go to the Requirements ribbon bar and click the Requirements List button to open the Requirements window. Look at the Visual Studio icon next to row labelled ”[POS Terminal] Form Factor: A5 size…”. The icon has a pen indicating that the requirement has changed since the document was last published to TFS. Press Ctrl+S to save the document. Click the Publish button on the Requirements ribbon bar to publish the changes to TFS. Click Yes on the confirmation message. When publishing is complete click OK on the completion message.

In the Requirements List window, double-click the row labelled ”[POS Terminal] Form Factor: A5 size…”. The work item details screen is opened. Notice that the work item Title has been updated and that the History section contains details of the update. Click Cancel to close the window.

Go to the Visio Page containing the forwards traceability diagram for POS Terminal. View the work item details for the POS Terminal Verification Checks test case. Notice that the Expected Results has been updated for the Check Form Factor action. Click Cancel to close the window.


Getting Started

Working with the TFS Scrum or MSF for Agile process templates

Following is a general guide on using the Scrum (stpsoft) and MSF for Agile (stpsoft) Visio templates. This section assumes that you have worked through the earlier sections in this guide and that you are familiar with using stpsoft Requirements Definer. Select the Visio template Start Visio and double-click the Requirements folder in the Template Categories section. Select either the MSF for

Agile (stpsoft) or Scrum (stpsoft) Visio template (depending on your team project’s TFS process template) and click the Create button.

Select the team project Click the Choose Team Project button on the Requirements ribbon bar to select the team project. Themes Related User Stories are grouped in to Themes. For example, all user stories related to stock control could be in the

“Stock Control” theme. Themes are represented by Visio pages containing a theme diagram, such as the initial Visio page. If you have more than one theme, use a separate Visio page for each theme. If you have many large themes or each theme is being worked on by a different person, then use a separate Visio document for each theme.

Name the theme Double-click the page tab and rename the “{theme name}” text appropriately. Describe the theme Ensure that no shapes are selected and click the Description Window button on the Requirements ribbon bar. Use

the Description Window to enter a high level description of the theme. Add / remove user stories

Depending on how many user stories your theme has, delete user stories from the diagram or add user stories from the Shapes stencil. Connect any new user stories to the Role shape using the Connector shape.

Rename the role Rename the Role shape appropriately (e.g. “Customer”). Rename the user stories Rename each User Story shape appropriately. Define the user stories The User Story shapes are pre-marked up. For each user story enter a description using the Description Window,

and select the Area and Iteration (e.g. “Release 1\Sprint 2”) using the Shape Data window. If the Shape Data Window is not open, select the Data ribbon bar and tick the Shape Data Window box.

Elaborate the user stories in the current iteration

Collaborate with stakeholder to elaborate each user story in the current iteration. For example, if you’ve completed Sprint 1 and are about to embark on Sprint 2, elaborate each user story under “Release 1\Sprint 2”. Elaboration could involve any of the following:

- expand description text (using Description Window) - add business rules (using Add Detail… smart menu option) - add technical notes (using Add Detail… smart menu option) - define process flow (using Define Process Flow… smart menu option) - add functional requirements (by marking up process shapes in the process flow) - define wireframes / storyboards with a sub-diagram (using Elaborate… smart menu option) - define more granular user stories with a sub-diagram (using Elaborate… smart menu option)

Publish to TFS Publish the document to TFS. Work items will be created for each user story, business rule, technical note and

marked up shape. Test cases will be generated for each user story with business rules and technical notes. Test cases will also be generated for each path through each process flow diagram. The work items will automatically be linked based on the information architecture in the Visio diagrams,

Export the user stories to PowerPoint

Click the PowerPoint button on the Requirements ribbon. The Export to PowerPoint options window is displayed. If you have your own PowerPoint template, select the PowerPoint template (this is optional). Select the current iteration/sprint from the Project iteration pick list. Click the OK button to generate a PowerPoint presentation for the current iteration/sprint. Wait until the process has completed and the PowerPoint window is maximised.

Present the planned work

At the start of the iteration/sprint, gather the team to present the planned scope and objectives using the generated PowerPoint slides.

Export the user stories to Word

If stakeholders require a specification of the planned work, export the stories to Word. Ensure that the current iteration is selected in the Export to Word options screen.

getting started stpsoft requirements definer€¦ · getting started 3. requirements ribbon bar...

Documents