XXX UI Specification
Author: XXX
$Revision: 1.11 $
$Date: 2005/03/24 15:01:51 $
Note: See also how this template is used in a UI Spec Example.
<Use case description> Describe high level task the user wants
to do. For example "Commit bug fix (multiple files) into repository", not low
level task like "Invoke commit action on one file".
Scenario:
- <Scenario step> Scenario step should point to menu, dialog or window in specification.
-
<Use case description>
Scenario:
Provide ascii-art or PNG of every UI change in the IDE introduced by this
spec.
Figure: <Menu name>
<Ascii-art, or PNG>
Components:
- <Menu item name and description> If not obvious, desribe
function and behavior of menu item.
-
Figure: <Figure description>
<Ascii-art, or PNG>
Components:
- <Component name and description> If not obvious, desribe
function and behavior of component.
-
Figure: <Figure description>
<Ascii-art, or PNG>
Components:
- <Component name and description> If not obvious, desribe
function and behavior of component.
-
Error Conditions:
Figure: <Figure description>
<Ascii-art, or PNG>
Components:
- <Component name and description> If not obvious, desribe
function and behavior of component.
-
If ascii-art is not illustrative enough, provide PNG of window.
Figure: <Figure description>
<PNG> Window on XP or Win Classic LaF
Follows ascii-art templates.
Main Menu
| Menu |
--------
Item 1
Item 2
Item with Shortcut Ctrl-X
...
Contextual Menu
Item 1
Item 2
Item with Shortcut Ctrl-X
...
Dialog
+---------------------------------------------------------------------------------+
| Dialog Title |
+---------------------------------------------------------------------------------+
| |
| List: |
| +------------------------------------------------------------------+ |
| | example or default value | [ Add... ] |
| | example or default value | [ Remove ] |
| | example or default value | |
| | | |
| +------------------------------------------------------------------+ |
| |
| Table: |
| |________Column 1___________|_____Column 2_____|_____Column 3______| |
| | example or default value | [ Add... ] |
| | example or default value | [ Remove ] |
| | example or default value | |
| | | |
| +------------------------------------------------------------------+ |
| |
| |
| [[ Default Button ]] [ Cancel ] |
+---------------------------------------------------------------------------------+
Wizard
+---------------------------------------------------------------------------------+
| Wizard Title |
+---------------------------------------------------------------------------------+
| Step Name |
| ------------------------------------------------------------------------------- |
| |
| Optional step instruction. Usually starting with Specify... |
| |
| Combo: |_default or example value________________________v_| |
| Text Field: |___________________________________________________| [ Browse... ] |
| |
| Radio: (o) Selected Button |
| ( ) Not Selected Button |
| |
| Checkbox: [x] Selected Button |
| [ ] Not Selected Button |
| |
| |
| [ Back ] [[ Next> ]] Finish [ Cancel ] [ Help ] |
+---------------------------------------------------------------------------------+
Window (Explorer)
+-----------------------------------------------------+
| Window Title |
+-----------------------------------------------------+
| [a] Node |
| - [t] Node |
| | + [p] node |
| | + [p] node |
| | + [p] node |
| | + [p] node |
| - [t] Node |
| + [p] node |
| - [p] node |
| | + [f] node |
| | + [f] node |
| | + [f] node |
| | + [f] node |
| + [p] node |
| + [p] node |
| [a] Node |
| - [t] Node |
| | + [p] node |
| | + [p] node |
| | + [p] node |
| | + [p] node |
| - [t] Node |
| + [p] node |
| + [p] node |
| + [p] node |
| + [p] node |
| |
+-----------------------------------------------------+
