VORD TOOLKIT: HOW TO

Transcription

1 VORD TOOLKIT: HOW TO REFERENCE GRAPH...1 GETTING STARTED...2 CREATING A VORD DOCUMENT...2 IDENTIFYING VIEWPOINTS...2 IDENTIFYING SUBCLASSES...3 IDENTIFYING ATTRIBUTES...3 IDENTIFYING REQUIREMENTS...4 ATTACHING NOTES...4 REQUIREMENTS REVIEW...4 SETTING PASSWORDS...5 SAVING AND LOADING PROJECT...5 NEGOTIATION AND ANALYSIS...5 REQUIREMENTS NEGOTIATION...5 REQUIREMENTS ANALYSIS...5 CONSTRAINT ANALYSIS...5 GENERATING REPORT...5 EDITING AND PRINTING...6 EDITING GRAPH NODES...6 EDITING VIEWPOINT DESCRIPTION...6 EDITING ATTRIBUTE DESCRIPTION...7 EDITING REQUIREMENT DESCRIPTION...7 PRINTING REPORT...7 Reference Graph

2 Getting Started Creating a VORD Document VORD is based on viewpoints that focus on user issues and organizational concerns. The model adopted by VORD is service-oriented where viewpoints are analogous to clients in a client-server system. The system delivers services to viewpoints and the viewpoints pass control information and associated parameters to the system. Viewpoints map to classes of end-users of a system or to other systems interfaced to it. The viewpoints that make up the core model are known as direct viewpoints. This will shown in light gray in the viewpoint editor. To model organizational requirements and concerns, viewpoints concerned with the systems influence on the organization are also considered. These are known as indirect viewpoints. There are four main steps in VORD: 1. Viewpoint identification 2. Viewpoint documentation (i) Document viewpoint attribute (ii) Document viewpoint requirements (iii) Describe viewpoint scenarios 3. Requirements analysis 4. Requirements analysis To start using the tool the user must first create a new project or load an existing one. To open new project do the following: 1. Click on the 'new project' icon [1st icon] 2. Enter project name 3. Click on viewpoint icon Abs-App to display abstract viewpoint tree 4. Identify root application viewpoints To load an existing project do the following: 1. Click on the 'load project' icon [3rd icon] 2. Select the required project file. All VORD projects have the extension '.vrd' Identifying viewpoints To identify root application viewpoints click on the viewpoint editor icon [4th icon] to display the abstract viewpoint tree. The do the following: 1. Select the required abstract viewpoint type by clicking on it. 2. Click on the identification icon [5th icon] to open an identification form 2

3 3. Type viewpoint description and press the 'Add' button Pressing the add button adds the viewpoint to the identification basket [18th icon] and clears the identification form. You may identify another viewpoint of the same type 4. Repeat 1-3 for other abstract viewpoint classes. When you have identified the required root viewpoints, click on the viewpoint editor icon to switch to the application canvas. The application canvas will be blank unless you previously placed some application viewpoints in it 5. Place the identified viewpoints on the application canvas by clicking once on the identification basket, followed by clicking on the application canvas. Repeat until all the root viewpoints have been placed. Identified viewpoints may be moved around the canvas using the left mouse button. 6. Identify viewpoint subclasses Identifying subclasses To identify viewpoint subclasses you need to be in the application canvas. The application canvas should contain previously identified viewpoints. Do the following: 1. Select the viewpoint to be subclassed by clicking on it. 2. Click on the subclass icon [6th icon] to open a subclass description form 3. Type the viewpoint description and press the 'Add' button Pressing the add button adds the subclass to the selected viewpoint and clears the subclass form. You may add more subclasses to the viewpoint using the same form 4. Repeat 1-3 for other viewpoints 5. Identify viewpoint attributes Identifying attributes To identify viewpoint attributes you need to be in the application canvas. The application canvas should contain previously identified direct viewpoints. These will be shown in light gray. Do the following: 1. Select the direct viewpoint to add the attribute to by clicking on it. 2. Click on the attribute icon [7th icon] to open the attribute description form 3. Type attribute description and press the 'Add' button Pressing the add button adds the attribute to the selected viewpoint and clears the attribute form. You may add more attributes to the viewpoint using the same form 3

4 4. Repeat 1-3 for other direct viewpoints 5. Identify viewpoint requirements Identifying requirements To identify viewpoint requirements you need to be in the application canvas. The application canvas should contain previously identified viewpoints. Do the following: 1. Select the desired viewpoint by clicking on it. 2. Click on the requirement icon [11th icon] to open a requirement description form. 3. Type requirement description and source(s). Press the 'Rationale' button to open a rationale and requirement description form 4. Complete the requirement rationale and press the add button to return to main requirement description form. 5. Press the add button to add the requirement to the viewpoint. This also clears the form ready for the more requirement descriptions 6. Repeat 1-5 for all identified viewpoints 7. Perform constraint analysis: click on the constraint analysis icon [14th icon] 8. Describe event scenarios Note: Describing scenarios is not supported in this version of the VORD Tool Attaching notes The tool allows a user to attach textnotes to viewpoint and requirement components during edit operations. In application the canvas, select the desired viewpoint followed by clicking on the note icon [13th icon]. On edit forms, open a textnote by clicking on the 'note' button. Notes appear in the requirements report under 'Notes' and may also be viewed during requirements review Requirements review To open a requirements review form click on the review icon [17th icon]. The review form allows the user review specific viewpoint components based on a set of checklist questions. At the end of the process, the tool automatically associates each reviewed item with relevant checklist question, and the review document with the relevant state of system at that particular point in time 4

5 Setting passwords To set passwords select 'Set passwords' in the Settings menu. If an administrator password is set, then only the administrator can modify the user passwords Saving and loading project To save project select the save icon [2nd icon] To load saved project select load icon [3rd icon] To load new project select new project [1st icon] Negotiation and Analysis Requirements negotiation To open a requirements negotiation form click on the review icon [16th icon] [added note: I have not tested it; but hopefully it works]. The negotiation process allows the user(s) review recommended changes in requirements, and to decide on the best way to accommodate the changes. It is also intended to ensure that there are no conflicts amongst the proposed changes, and that the changes are feasible. The decision from the negotiation process is automatically added to the appropriate section of the conflict report. Requirements analysis This version of VORD allows the user to perform limited conflict analysis. To do this select the requirements analysis icon [15th icon]. The user indicates that a requirement has been inspected by pressing the 'check' button. The tool automatically sequences to the next requirement when the button is pressed Constraint analysis 1. To perform constraint analysis click on the constraint analysis icon [14th icon] 2. Describe event scenario Generating report The tool automatically generates reports based on a set of pre-selected viewpoint components. To open a report form click on the report icon [10th icon] 5

6 Editing and Printing Editing graph nodes To edit a graph node, select the required node by clicking on it followed, by clicking on the node edit icon [9th icon]. This opens an edit form. The edit form allows the user to: (i) change a viewpoint type (ii) unsubclass a viewpoint (iii) move viewpoint tree from one parent to another (iv) delete viewpoint You may also use this icon to delete viewpoint attributes The form also allows the user to attach a change rationale to the edit operation. Change rationale is enabled for all edit operations by default, but can be disabled by unselecting the 'Major change' radio button: 1. To change viewpoint type select 'Change type' radio button followed by the required type from the type list. Press the OK button 2. To unsubclass a viewpoint select 'Unsubclass' radio button. You may optionally choose a new viewpoint type from the type list. Press the OK button 3. To move viewpoint to a new parent select 'Move' radio button followed by the required parent from the destination list. Press the OK button 4. To delete a viewpoint select 'Delete' radio button. Press the OK button Editing viewpoint description To edit a viewpoint description, select the required viewpoint by clicking on it followed, by clicking on the viewpoint/attribute edit icon [8th icon]. This opens an edit form. The edit form allows the user to attach a change rationale to the edit operation. Change rationale is enabled for all edit operations by default, but can be disabled by unselecting the 'Major change' radio button 6

7 Editing attribute description To edit an attribute description, select the required viewpoint [added note: click on the attribute of the specific viewpoint] by clicking on it followed, by clicking on the viewpoint/attribute edit icon [8th icon]. This opens an attribute edit form. The attribute edit form allows the user to attach a change rationale to the edit operation. Change rationale is enabled for all edit operations by default, but can be disabled by unselecting the 'Major change' radio button Editing requirement description To edit a requirement description, select the requirement edit icon [12th icon]. This opens a requirements edit form that show a list of all the identified requirements. Select the required requirement The requirement edit form allows the user to attach a change rationale to the edit operation. Change rationale is enabled for all edit operations by default, but can be disabled by unselecting the 'Major change' radio button Printing report To print a report select 'Print' from the File menu. This will open a print dialog similar to the viewpoint report form: 1. Enter the report header information and select the required components. 2. Press the print button to open a normal printer dialog and proceed normally. 3. If one of your selected print components is the viewpoint diagram, you will see the printer dialog appear again during printing. When the printer dialog appears for the second time, change the paper orientation to 'Landscape' on the properties menu. This is a better paper orientation for the viewpoint graph Gathered and edited from online help section of VORD Tool, Demo Version, by Gerald Kotonya / for only educational use to assist student gets a better understanding of the this software functionalities./no commercial distribution is allowed./editor of this document releasing himself/herself from any legalities that are involved because of further usage of this document. 7