ROADMAPPING TOOL USER INTERFACE SPECIFICATION

Transcription

1 ROADMAPPING TOOL USER INTERFACE SPECIFICATION Page 1 of 19

2 CHANGE HISTORY Version Description Author Date 0.01 Document created Räisänen 0.02 Change history- table added Männistö & Räisänen Document submitted to the delivery IM1 Männistö & Räisänen Print screen pictures added Räisänen Warning dialogs added Räisänen Tool bar updated, Print screen pictures updated Räisänen Document submitted to the delivery IM2 Männistö Functionality updated, new pictures added Räisänen Warning dialogs updated Räisänen Document submitted to the delivery IM3 Männistö Page 2 of 19

3 TABLE OF CONTENTS 1 INTRODUCTION SYMBOLS MENUBAR FILE-MENU EDIT-MENU VIEW-MENU INSERT-MENU TOOLS-MENU HELP-MENU PROPERTY DIALOGS TOOLBAR WARNING DIALOGS IRRELEVANT TIME FRAME SAVE CHANGES ROADMAP CAN NOT BE OPENED Page 3 of 19

4 1 INTRODUCTION The purpose of this document is to define and describe the graphical user interface (GUI) for the Roadmapping tool created for the T Software Project course at the Helsinki University of Technology (HUT), Computer Science department. It also defines the symbols used in user interface. 2 SYMBOLS Symbols used in user interface of Roadmapping tool are described in the table 1. Table 1. Symbols used in user interface. Name Activity Symbol (for example) Event Dependence Note A Feature 1 Page 4 of 19

5 3 MENUBAR Roadmapping tool includes following menus: File, Edit, View, Insert, Tools and Help. 3.1 FILE-MENU File-menu contains New, Open, Close, Save, Save As, Export roadmap, Properties and Exit menu items. Items are described in the table 2. Table 2. Menu items of File-menu Item Short cut Description New Ctrl-N Creates a new roadmap by using Create New Roadmap -dialog Open Ctrl-O Opens an existing roadmap Close Ctrl-F4 Closes an existing roadmap Save Ctrl-S Saves roadmap to disk Save As Saves roadmap by asking where to and with what name roadmap is saved. Export roadmap Exports roadmap Properties Opens Roadmap Properties -dialog Exit Alt-F4 Closes Roadmapping tool -program Items of File-menu are presented in the picture 1. Page 5 of 19

6 Picture 1. File-menu. When user starts to create a new roadmap by choosing File -> New, following Create New Roadmap dialog is displayed. Dialog asks the name of the roadmap, description, start year and number of quarters. All fields are editable. Create New Roadmap dialog is presented in the picture 2. Page 6 of 19

7 Picture 2. Create New Roadmap dialog If user wants to edit properties of the roadmap by choosing File -> Properties, following Roadmap Properties dialog is opened with old information. Name and description are editable, time frame not. Dialog is presented in the picture 3. Picture 3. Roadmap Properties dialog Page 7 of 19

8 3.2 EDIT-MENU Edit-menu contains Cut, Copy, Paste, Select All and Delete menu items. Items are described in the table 3. Table 3. Menu items of Edit-menu Item Short cut Description Cut Ctrl-X Cuts selected items to clipboard Copy Ctrl-C Copies selected items to clipboard Paste Ctrl-V Pastes items from clipboard Select All Ctrl-A Selects all items Delete Delete Deletes selected item(s) Items of Edit-menu are presented in the picture 4. Picture 4. Edit-menu Page 8 of 19

9 3.3 VIEW-MENU View-menu contains Editing, Presentation and Scale, menu items. Items are described in the table 4. Table 4. Menu items of View-menu Item Editing Presentation Scale Description Editing view Presentation view Changes the scale. Items of View-menu are presented in the picture 5. Picture 5. View-menu Page 9 of 19

10 3.4 INSERT-MENU Insert-menu contains Layer menu item, which is described in the table 5. Table 5. Menu item of Insert-menu. Item Short cut Description Layer Insert Inserts layer to roadmap by using Insert New Layer -dialog Item of Insert-menu is presented in the picture 6. Picture 6. Insert-menu If user selects Insert > Layer following Insert New Layer dialog is opened. Name and description are editable. Dialog is presented in the picture 7. Page 10 of 19

11 Picture 7. Insert new layer dialog. 3.5 TOOLS-MENU Tools-menu contains Activity, Event, Dependence and Note menu items. Items are described in the table 6. Table 6. Menu items of Tools-menu. Item Activity Event Dependence Note Description Inserts activity to layer Inserts event to layer Inserts dependence to layer Inserts note to layer Items of Tools-menu are presented in the picture 8. Page 11 of 19

12 Picture 8. Tools-menu Cursor looks different if Activity (Picture 9), Event (Picture 10), Dependency (Picture 11) or Note (Picture 12) is selected from Tools-menu. Picture 9. Cursor if Activity-item selected. Picture 10. Cursor if Event-item selected. Page 12 of 19

13 Picture 11. Cursor if Dependency-item selected. Picture 12. Cursor if Note-item selected. 3.6 HELP-MENU File-menu contains Help topics and About Roadmapping tool menu items. They are presented in the table 7. Table 7. Menu items of Help-menu Item Help topics About Roadmapping tool Description Opens HTML-help Opens window, which displays information about Roadmapping tool. Items of Help-menu are presented in the picture 13. Page 13 of 19

14 Picture 13. Help-menu About Roadmapping Tool dialog is presented in the picture 14. It displays name of the product, version number, name of the group and creating year. Page 14 of 19

15 Picture 14. About Roadmapping Tool -dialog 4 PROPERTY DIALOGS Property dialogs are opened by double-clicking layer, activity, event or note. Dialogs are presented in pictures 15, 16, 17 and 18. Picture 15. Layer Properties dialog Page 15 of 19

16 Picture 16. Activity Properties dialog Picture 17. Event Properties dialog Page 16 of 19

17 Picture 18. Note Properties dialog 5 TOOLBAR Toolbar of Roadmapping tool is presented in the picture 19. Picture 19. Toolbar of Roadmapping tool. Tools tips of menu bar are presented in the table 8. Item Tool tip 1 New roadmap 2 Open roadmap Page 17 of 19

18 3 Save 4 Copy 5 Delete 6 Add Layer 7 Add Activity 8 Add Event 9 Add Note 10 Add Dependency 11 Add Dependency 12 Cursor Table 8. Tool tips. 6 WARNING DIALOGS 6.1 IRRELEVANT START YEAR If user tries to give irrelevant value to start year (in Create New Roadmap -dialog) following Error dialog (picture 20) is presented. Picture 20. Error-dialog for irrelevant start year. 6.2 IRRELEVANT NUMBER OF QUARTERS If user tries to give irrelevant value to number of quarters (in Create New Roadmap -dialog) following Irrelevant Time Frame dialog (picture 21) is presented. Picture 21. Error-dialog for irrelevant number of quarters. Page 18 of 19

19 6.3 SAVE CHANGES If user tries for example to create a new roadmap or exit program without saving changes to previous roadmap following Save Changes dialog (picture 22) is opened. Picture 22. Save Changes dialog. 6.4 ROADMAP CAN NOT BE OPENED If user tries to open a roadmap and rmt-format is irrelevant following Error dialog (picture 23) is opened. Picture 23. Error-dialog for file reading error. Page 19 of 19