UI GoogleCode

Document Sample
UI GoogleCode Powered By Docstoc
					          User Interface Document
                           GRAD9001


                     Double Rainbow Software

                             Timur Asanov

                            Michael Gardner

                              Daniel Joyce

                             Eliana Feasley

                              Michael Sola



                   prepared for Ms. Dee Ann Drummey



March 16th, 2011

                                                      V1.0




                                   1
                                                   GRAD 9001
                                        User Interface Design Document



                                                  Table of Contents


                                                                                                             Page

1. Introduction...............................................................................................3

         1.1 Purpose of This Document...........................................................3
         1.2 References...................................................................................3


2. User Interface Standards...........................................................................4


3. User Interface Walkthrough.......................................................................6


4. Data Validation...........................................................................................8


5. Report Formats – Omitted


Appendix A - Agreement Between Customer and Contractor........................9

Appendix B – Peer Review Sign-off...............................................................10

Appendix C – Document Contributions..........................................................11




                                                               2
1. Introduction

1.1 Purpose of This Document

       This document shall help the designers and customer of this system understand
how the user interface will look and function. It shall enumerate the standards to which
our user interface shall comply–how the screens, buttons, and alerts will look. It shall
provide a walkthrough of the user interface so the workflow is fully modeled and the
purpose of each component of the system is fully documented. It shall provide an
account of the data the user must enter, and how all data shall be formatted and
validated. Finally, it shall provide a forum for documentation of the formal agreement
between Double Rainbow Software and Ms. Dee Ann Drummey to provide the system
specified below.

1.2 References

       The following references were used by Double Rainbow Software while making
this document.

CMSC 345, Document Contributions Appendix. UMBC; By Susan Mitchell.
Accessed 2/23/11
[http://www.csee.umbc.edu/courses/undergraduate/345/spring11/mitchell/
Documents/contributionsAppendix_S11.doc].

CMSC 345, General Product Description. UMBC; By Susan Mitchell. Accessed
2/23/11
[http://www.csee.umbc.edu/courses/undergraduate/345/spring11/mitchell/
CourseInfo/productDescription_S11.html].

CMSC 345, Sample UI Navigation Diagram. UMBC; By Susan Mitchell. Accessed
3/15/11
[http://www.csee.umbc.edu/courses/undergraduate/345/spring11/mitchell/Documents/ui
NavigationExample_S11.doc].

CMSC 345, Sample Walkthough and Data Validation. UMBC; By Susan Mitchell.
Accessed 3/15/11
[http://www.csee.umbc.edu/courses/undergraduate/345/spring11/mitchell/Documents/ui
WalkthroughAndDataValExample_S11.doc].

CMSC 345, User Interface Template. UMBC; By Susan Mitchell. Accessed 3/15/11
[http://www.csee.umbc.edu/courses/undergraduate/345/spring11/mitchell/Documents/ui
Template_S11.doc].

GRAD9001 SRS Document V1.0. Double Rainbow Software; By Double Rainbow
Development Team.




                                            3
2. User Interface Standards




                                           Figure 1

        The illustration above is about what the main screen is expected to look like.
This illustration is subject to change, but covers all the primary functionalities of the
application.


File Menu:

       The file menu allows the user to perform basic operations that are commonly
found in most desktop-based applications.

       The File menu contains selections for the following operations:

      Creating a new user profile.
      Opening an existing user profile.
      Saving an existing user profile.




                                              4
View Menu:

      The View menu allows the user to select several of the offered views that assist
the user when planning their graduation.

       The View menu contains selections for the following operations:

      Displaying the yearly view.
      Displaying the career view.
      Displaying the degree audit.
      Displaying the unofficial transcript.


Filter by Degree Type:

       The selection options associated with this field provide the user with the
necessary functionality to find a class based on a specific major, minor, GEP
requirements, math courses, or science courses. This field is not limited to a single
selection; the user can select any number of options.

      By default, the user’s major and minor (if applicable) will be the only options
       checked on startup.
      The dropdown menu will remain inactive unless the GEP option is checked.


Search for Classes:

       This field allows the user to search for a course name, course id, major, or
number of credits. This feature can be used in addition to the “Filter by Degree Type”
functionality.


Classes:

        This field displays all courses shown based on the search for classes and filter by
degree type functionalities. When the user selects a class, a pop-up will be displayed
with all of the details about the course and the option to add the class to the current
year displayed.

      Any course available to take by the user can be clicked on for more details and
       the option to add the course to a semester within the current year.
      Any course unavailable to be taken by the user can be clicked if the “Show
       Available Courses Only” option is not selected and will give the user more details
       about the course.
      The course name, course title, and number of credits will always be displayed.



                                               5
      This list will repopulate whenever there is any change to courses, the user
       profile, search, or filters.


Show Only Available Classes:

       When this option is selected courses that the user does not have the
prerequisites during the current year will not be displayed in the Classes section. When
this option is not selected courses that cannot be taken for the current year are grayed
out; the course can be selected for more detailed information, but cannot be added to
the “Course Planner”.

      By default, the “Show Only Available Courses” option will be unchecked on
       startup.


Course Planner:

       This is the largest section of the main screen and displays all of the scheduled
classes for the current year. All of the classes are displayed within the semester the
user plans to take such a course. A tab can select each year that is a part of the
Graduation Plan. Each year has the course list by semester of all the courses the user
plans to take.

      There is one tab for every year that is part of the Graduation Plan.
      The Course Planner defaults to four years, and the user may choose to add
       years to the plan as needed.
      Contains a course list for each Semester of the selected year.


3. User Interface Walkthrough

       The UI has two screens, Yearly View (see Figure 1 above for illustration) and
Career View (see Figure 2 below for illustration), each of which can be navigated to
from the other.

      Many of the buttons and features in Yearly View (Figure 1) are detailed
extensively in Section 2, as they incorporate important design standards. The following
are important features that do not have a standard.


Career View Button (Located at bottom of Yearly View, Figure 1):

     When clicked, Yearly View (Figure 1) is hidden and Career View (Figure 2) is
shown within the same window.




                                            6
       An illustration of Career View can be found below (Figure 2). As is the case with
Yearly View (Figure 1), the final layout is subject to change.




                                         Figure 2

      Career View (Figure 2) shows organized lists of all courses the user has
scheduled in 4 year increments.


Yearly Schedules:

       Every year that a student has added to their schedule shall be viewable in Career
View (Figure 2). Yearly Schedules shall show a list of classes the student has already
added to their schedule. These displays shall be non-editable, however, clicking on one
shall navigate the user to the corresponding tab in the Yearly View Course Planner
(Figure 1) where the user may edit that year.




                                            7
Left Arrow Button:

       This button shall be used to move the display backward by 4 year increments.
For instance, if schedules for Years 5, 6, 7 and 8 are showing, pressing this button
would hide those from view and show Years 1, 2, 3 and 4.

      When entering Career View (Figure 2) this button is inactive, but becomes active
       if the Right Arrow Button is pressed.


Right Arrow Button:

       This button shall be used to move the display forward by 4 year increments. The
functionality is similar to the Left Arrow Button, but with some key differences.

      This button is inactive if the user has 4 or less years added to their schedule.
      If a user has scheduled more than 4 years, this button shall allow the user to hide
       the currently displayed yearly schedules and instead show the next set of yearly
       schedules (i.e. hide Years 1, 2, 3 and 4 and then show Years 5, 6, 7 and 8).


Yearly View Button (Located at bottom of Career View, Figure 2):

       Clicking this button shall bring the user back to the previous Yearly View (Figure
1) screen, hiding all Career View functionality. Furthermore, this button shall return to
the state Yearly View (Figure 1) was in before entering Career View (Figure 2).


4. Data Validation

        This section describes all information that a user is able to input into the system
by typing in text. Each input is described with its label, data type, input format and its
size limit.


Label                  Type                      Input Format          Size Limit
Student’s Name         String                    Textbox               No limit

Student’s ID           Int                       Textbox               7 characters

Search Criteria        String                    Textbox               100 characters

File Name              String                    Textbox               No limit




                                             8
                                   Appendix A
      Eliana Feasley, Timur Asanov, Mike Sola, Michael Gardener, and Daniel Joyce
(The Team) and Ms. Dee Ann Drummey (The Customer) have read and agree on the
contents on the document and understand that The Team will implement the software
and deliver each deliverable as described in the GRAD 9001 SRS Document.

        Any modifications to this document must be agreed to by both The Team and
The Customer. When a change to the document is requested by a member of The
Team, each other member of The Team must sign off on the change within 5 business
days. The request for the change will be sent to the customer, who will have up to 5
business days to confirm or deny the request, and sign her approval if she grants it.
Should The Customer wish to change this document, she may contact the Team
Facilitator, and the Team will then have 5 business days to confirm or appeal the
request. Any changes must be signed off by each member of the team and the
Customer.

Dee Ann Drummey           _____________________________________________

      Comments:           _____________________________________________

      _____________________________________________________________

      _____________________________________________________________

      _____________________________________________________________

      _____________________________________________________________

      _____________________________________________________________


Timur Asanov              _____________________________________________

Eliana Feasley            _____________________________________________

Michael Gardner           _____________________________________________

Daniel Joyce              _____________________________________________

Mike Sola                 _____________________________________________




                                          9
                                  Appendix B
      All members of the team have reviewed the document and agree on both its
content and format. Any minor contentions members of the team may hold are noted in
the comments below, but all members of the team agree on all major points.


Timur Asanov       _____________________________          Date: ______________

      Comments: ____________________________________________________

                   ____________________________________________________



Eliana Feasley     ______________________________          Date: ______________

      Comments: ____________________________________________________

                   ____________________________________________________



Michael Gardner    ______________________________         Date: ______________

      Comments: ____________________________________________________

                   ____________________________________________________



Daniel Joyce       ______________________________          Date: ______________

      Comments: ____________________________________________________

                   ____________________________________________________



Mike Sola          ______________________________          Date: ______________

      Comments: ____________________________________________________

                   ____________________________________________________


                                         10
                                                         Appendix C

                                                Document Contributions

   Name of Contributor           System Requirements                  System Design Document            User Interface Design
                                     Specification                                                            Document


Timur Asanov                  Functional Requirements #1 - #7,
                                                                  Introduction                       Data Validation
                              #10 - #13

Eliana Feasley                                                    System Architecture, Logical
                              Deliverables, Open Issues,          Diagram (Figure 2.1),
                                                                                                     Introduction
                              Appendices                          Decomposition Diagram (Figure
                                                                  2.2)

Michael Gardner               Functional Requirements #8 - #9     Requirements Matrix                User Interface Standards

Daniel Joyce                  Non-Functional Requirements,        Persistent Data Design, Database
                                                                                                     Report Formats, Appendices
                              Top-Level Diagram (Figure 1)        Diagram (Figure 3.1)

Mike Sola                                                                                            User Interface Walkthrough,
                                                                  Appendices, Logical Diagram
                              Introduction                                                           Yearly View (Figure 1), Career
                                                                  (Figure 2.1)
                                                                                                     View (Figure 2), Appendices


I have read and agree with the contributions stated above.

Printed Name                                 Signature                                  Date

Timur Asanov                     ______________________________                  ___________________
Eliana Feasley                   ______________________________                  ___________________
Michael Gardner                  ______________________________                  ___________________
Daniel Joyce                     ______________________________                  ___________________
Mike Sola                        ______________________________                  ___________________

                                                                 11
                                       Document Contributions (continued)

   Name of Contributor          Code Inspection Report            Testing Report       Administrator Manual


Timur Asanov                               N/A                         N/A                     N/A

Eliana Feasley                             N/A                         N/A                     N/A

Michael Gardner                            N/A                         N/A                     N/A

Daniel Joyce                               N/A                         N/A                     N/A

Mike Sola                                  N/A                         N/A                     N/A


I have read and agree with the contributions stated above.

Printed Name                              Signature                          Date

Timur Asanov                     ______________________________        ___________________
Eliana Feasley                   ______________________________        ___________________
Michael Gardner                  ______________________________        ___________________
Daniel Joyce                     ______________________________        ___________________
Mike Sola                        ______________________________        ___________________




                                                             12

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:3
posted:9/24/2012
language:English
pages:12