lint formatting fixes
This commit is contained in:
William Sandner
78
Design-UI.md
78
Design-UI.md
@@ -1,13 +1,17 @@
|
||||
##### Project:
|
||||
::PROJECTNAME
|
||||
##### Project
|
||||
|
||||
::PROJECT-NAME
|
||||
|
||||
##### Internal Release Number
|
||||
|
||||
##### Internal Release Number:
|
||||
::X.Y.Z
|
||||
|
||||
##### Related Documents:
|
||||
##### Related Documents
|
||||
|
||||
- [Design](Design) > User Interface
|
||||
- ::LINKS TO RELEVANT STANDARDS
|
||||
- ::LINKS TO OTHER DOCUMENTS
|
||||
|
||||
---
|
||||
|
||||
### Overview
|
||||
@@ -29,7 +33,6 @@ text as needed.*
|
||||
|
||||
### Metaphors, Exemplars, and Standards
|
||||
|
||||
|
||||
#### What is the central metaphor of this UI design?
|
||||
|
||||
::PARAGRAPH
|
||||
@@ -88,38 +91,37 @@ interaction contexts. A use case that requires three interaction
|
||||
contexts could be hard to use. However, interaction contexts with too
|
||||
many components can also be hard to use.*
|
||||
|
||||
| Interaction Context --Abstract UI Components | Purpose | Contents / Constraints / Behavior |
|
||||
| Interaction Context --Abstract UI Components | Purpose | Contents / Constraints / Behavior |
|
||||
|------------------------------------------------|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| ::[Login dialog](LINK-TO-MOCKUP) | ::Verify that the current user is actually the person that they claim to be. | |
|
||||
| ::--Prompt | ::Tell the user that this dialog is to log in. | ::"Please log in". |
|
||||
| ::--Message area | ::Give the user some feedback about the login process. | ::Initially blank. Changes to "Checking username and password" when the user presses "Login". Changes to "Invalid username or password, please try again", if login fails. |
|
||||
| ::--Username | ::Identify the user account that the current user is trying to access. | ::The name of the user account. Regex: [-_a-z0-9]{1-16}. The application should not do anything that would help users guess usernames. E.g., this should not be a combo-box with recent users listed, and it should not offer auto-complete. |
|
||||
| ::--Password | ::Verify that the current user knows a secret password that only the true user of that user account should know. | ::The password of 4-16 characters. Do not display the password on the screen. The application should not do anything that would help users guess passwords. |
|
||||
| ::--Login | ::Allow the user to indicate that they have completed entry of their username and password. | ::"Login" Only enabled when Username != "". If the username or password is incorrect, delay a few seconds, and then clear all fields. |
|
||||
| ::--Lost Password | ::Allow the current user to start a process of generating a new password for a given username. | ::"Forgot your password? Click here." Only enabled when Username != "". |
|
||||
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[MAIN-WINDOW-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[Login dialog](LINK-TO-MOCKUP) | ::Verify that the current user is actually the person that they claim to be. | |
|
||||
| ::--Prompt | ::Tell the user that this dialog is to log in. | ::"Please log in". |
|
||||
| ::--Message area | ::Give the user some feedback about the login process. | ::Initially blank. Changes to "Checking username and password" when the user presses "Login". Changes to "Invalid username or password, please try again", if login fails. |
|
||||
| ::--Username | ::Identify the user account that the current user is trying to access. | ::The name of the user account. Regex: [-_a-z0-9]{1-16}. The application should not do anything that would help users guess usernames. E.g., this should not be a combo-box with recent users listed, and it should not offer auto-complete. |
|
||||
| ::--Password | ::Verify that the current user knows a secret password that only the true user of that user account should know. | ::The password of 4-16 characters. Do not display the password on the screen. The application should not do anything that would help users guess passwords. |
|
||||
| ::--Login | ::Allow the user to indicate that they have completed entry of their username and password. | ::"Login" Only enabled when Username != "". If the username or password is incorrect, delay a few seconds, and then clear all fields. |
|
||||
| ::--Lost Password | ::Allow the current user to start a process of generating a new password for a given username. | ::"Forgot your password? Click here." Only enabled when Username != "". |
|
||||
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[PAGE-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[MAIN-WINDOW-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::[DIALOG-NAME](LINK-TO-MOCKUP) | ::PURPOSE | |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
| ::--ABSTRACT-COMPONENT-NAME | ::PURPOSE | ::CONTENTS |
|
||||
|
||||
### Technical Constraints / Operational Context
|
||||
|
||||
|
||||
#### What are your assumptions about the output devices?
|
||||
|
||||
::We assume that the user has a 17-inch or larger screen with 1024x768
|
||||
@@ -159,7 +161,6 @@ may add or remove questions to fit your project.*
|
||||
|
||||
#### Understandability and learnability
|
||||
|
||||
|
||||
##### Are there any labels of icons that are likely to be misunderstood?
|
||||
|
||||
::1-3 SENTENCES
|
||||
@@ -169,6 +170,7 @@ may add or remove questions to fit your project.*
|
||||
::1-3 SENTENCES
|
||||
|
||||
##### Are advanced options clearly separated from the most commonly used options?
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
##### Are there no invisible options or commands? E.g., hold down the control key when opening a dialog box to see advanced options.
|
||||
@@ -177,7 +179,6 @@ may add or remove questions to fit your project.*
|
||||
|
||||
#### Task Support and Efficiency
|
||||
|
||||
|
||||
##### Which use cases force the user to work through more than two interaction contexts?
|
||||
|
||||
::1-3 SENTENCES
|
||||
@@ -188,7 +189,6 @@ may add or remove questions to fit your project.*
|
||||
|
||||
#### Safety
|
||||
|
||||
|
||||
##### Are there any dangerous or irreversible actions that are done with only one step?
|
||||
|
||||
::1-3 SENTENCES
|
||||
@@ -203,14 +203,10 @@ may add or remove questions to fit your project.*
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
##### Do all elements in your system that appear the same, actually function the same?
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
##### Are all elements share consistent visual characteristics such as font and color scheme, unless there is a reason for them to differ?
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
#####Are labels used consistently throughout the system? E.g., not "forward/back" in some contexts and "next/prev" in others.
|
||||
##### Are labels used consistently throughout the system? E.g., not "forward/back" in some contexts and "next/prev" in others.
|
||||
|
||||
::1-3 SENTENCES
|
||||
|
||||
Reference in New Issue
Block a user