Requirements Analysis and Preliminary Design | CS 5150, Study Guides, Projects, Research of Software Engineering

Download Requirements Analysis and Preliminary Design | CS 5150 and more Study Guides, Projects, Research Software Engineering in PDF only on Docsity!                             Mann Library SmartMap  Requirements Analysis and Preliminary Design      The Client  Howard Raskin  hbr1@cornell.edu        Team Lasera  Amanda Li  Sara Lin  Evan Sperling  Andrew Tourtellot  Lisa Wang  Robert Xiao                  Table of Contents  Requirements ................................................................................................................................................ 3  General Overview ..................................................................................................................................... 3  Purpose and Scope ................................................................................................................................ 3  Objectives and Goals ............................................................................................................................. 3  Current Systems ........................................................................................................................................ 3  Proposed System Requirements ............................................................................................................... 4  Overview ............................................................................................................................................... 4  Functional Requirements ...................................................................................................................... 4  Usability Requirements ......................................................................................................................... 5  Non‐functional Requirements .............................................................................................................. 5  Requirements Models ............................................................................................................................... 6  Use Case Diagrams ................................................................................................................................ 6  Use Case Specifications ......................................................................................................................... 7  Scenario 1 – Student Browsing Library Map ....................................................................................... 14  Scenario 2 – Student Searching for Animal Psychology 2nd Edition .................................................... 14  Scenario 3 – Mann Librarian Changing Exhibit Information ............................................................... 15  Data Models  Simplified ER Diagram .................................................................................................. 16  Preliminary Design ...................................................................................................................................... 19  User interface .......................................................................................................................................... 19  Window ............................................................................................................................................... 19  Header ................................................................................................................................................. 19  Map ..................................................................................................................................................... 20  Tabs ..................................................................................................................................................... 21  Footer .................................................................................................................................................. 21  Mockup Design ................................................................................................................................... 21  System Design ......................................................................................................................................... 23  Model View Controller ........................................................................................................................ 23  Database Design.................................................................................................................................. 24                        Item Type  Extra Fields  Bailey Hortorium  None  Bird Watching Station  None  Bissett Collaborative Area  None  Café  menu URL, events URL, hours URL  Classroom  Class Schedule URL, Computer Type, no. of computers, software,      software URL, computer URL, seating capacity, hours URL, reserve URL  Drinking Fountain  None  Exhibit Case  exhibit ID  Lockers  locker type  Outdoor Patio  events URL  Photocopier  None  Printer  color, duplex, format  Public Computing  None  Rest Room  Gender  Seminar Room  seating capacity, schedule URL  Service Desk  hours URL, goHereFor, phone number, email address,   Stacks  start call num, end call num, collection type  Staff Offices  departments, contact name, contact phone number, contact email  Stairwell/Elevator  take me to floors, take me to POIs,   Student Expo Space  schedule URL, exhibitID  Study Area  soft seats, grad student  Study Room  Room #, study room type, view type, projector, BIB ID/Item ID    Usability Requirements  Accessibility   The technologies used to build the map must be supported by a typical  user’s web browser (a typical user is assumed to be a college student or  faculty member whose computer is relatively up‐to‐date).      Non­functional Requirements  Compatibility  The  application must  function  correctly when  ported  to  the  library’s  servers.    Extensibility  SmartMap  must  be  extensible  so  as  to  allow  administrators  to  add  features not available in the initial release.    Requirements Models Use Case Diagrams User «extends» «USES» Availability Database Use Case Specifications  NavigateMap  Summary  The user performs basic navigation of the library map, including zooming, scrolling, and  map item identification.  Preconditions  The SmartMap window must be open in a browser meeting the system requirements.    The map itself must be displayed.  Trigger  Certain types of mouse interaction with the map display or map controls.  Course of events  1. SmartMap retrieves and displays the initial zoomed‐out map.  2. SmartMap begins an iteration of the user interaction loop. The user initiates any of the following   actions:  a. Zoom: The user selects a "zoom in" or "zoom out" option.  b. Scroll: The user instructs the map to scroll its display via a selectable option or a dragging  action with the mouse.  c. Identify: The user requests the identity of a map item.  3. SmartMap responds to the user request. The following responses correspond to the actions above:  a. The system fetches the map data required to display the new floor, changes the display  parameters to correspond to the new zoom level, and redraws the map.  b. The system changes the display parameters so the map is shifted according to the scroll  action performed, and redraws the map.  c. The system displays an unobtrusive label for the item chosen by the user that identifies it  and possibly includes other useful, concise information. The label does not interfere with  further map viewing and navigation.  4. The user continues interacting with the map.  a. Return to step 2.  b. Return to step 2.  c. When the user de‐selects the map item, the sytem removes the label for it from the display.  Return to step 2.  Alternate paths  Map display limits  Depending on the current state of the map, the map may not respond as described in step 3 above:  3. SmartMap response:  a. If the map is at maximum or minimum zoom and a "zoom in" or "zoom out",  respectively, was requested, then the map will do nothing.  b. If the requested display of the map goes beyond the maximum scroll range of the map,  the SmartMap will adjust the display so it is bounded by the scroll range.                    GetRoomDetail  Summary  The user views more information on a selected map item.  Preconditions  The SmartMap window must be open in a browser meeting the system requirements.  The map itself must be displayed.  Trigger  Certain types of interaction with a map item or map controls.  Course of events  1. The user selects a room or other map item about which to get more information.  2. SmartMap retrieves the room information from the server.  3. SmartMap shows room information in a new display section. Information displayed may include:  a. Images, possibly thumbnails.  b. Item name and description.  c. Item availability.  d. Additional item information depending on the item type.  e. External link(s) relevant to the item.  4. The user closes the information display section.  Alternate paths  Text scrolling  4b. Depending on the amount of item information, the user may scroll through the text. Continue to 4.  Thumbnail expansion  4c. The user selects a thumbnail to expand.  5c. SmartMap displays the full image corresponding to the thumbnail.  6c. The user closes the image. Return to 3.    Login  Summary  An administrator securely logs into the system.  Preconditions  The SmartMap window must be open in a browser meeting the system requirements.  Trigger  The administrator selects the login option.  Course of events  1. SmartMap prompts the administrator for a username and password.  2. The administrator enters said information.  3. SmartMap checks the information against its database of accounts.  4. If the information matches, continue to 5. If it does not, return to 1.  5. SmartMap sets the system to administrator mode and redisplays the same screen as before login  but with administrator options. Options displayed in administrator mode are:  a. An edit option added to the main map window.  b. An edit option to each item information window.  c. An option to edit administrator accounts.  d. The login option changes to a logout option.  6. The administrator may navigate the system and make editing changes as desired before continuing.  7. The administrator selects logout.  8. SmartMap disables administrator mode and removes administrator options from screen.          EditMap  Summary  An administrator changes layout of map items.  Preconditions  The SmartMap window must be open in a browser meeting the system requirements.      The map itself must be displayed.  Trigger    The administrator logs in and selects edit mode.  Course of events  1. SmartMap displays editing controls and locks out other administrators from editing the map.  The path branches here:  A. Editing an existing item.  2. The administrator selects an item to edit.  3. SmartMap displays the item as highlighted (possibly by a color change or special display of  edges or vertices).  4. The administrator changes the location or shape of the selected item, or selects the delete  option.  B. Adding a new item.    2. The administrator selects the add new item option.    3. The administrator defines the new item's shape and location.    4. SmartMap prompts the administrator for the new item's name and description.  The branches merge back together here:  5. Return to 2 if there are more changes, or continue to 6.  6. The administrator selects a preview option.  7. SmartMap displays map as it would appear to a user viewing the map with all the edits made.  8. The administrator selects to return to editing (return to 1) or save changes (continue to 9).  9. SmartMap saves the changed data to the server and unlocks editing for other administrators.  10. SmartMap displays the new map to the screen. The system is still in administrator mode, but not  map edit mode.    Alternate paths  Cancel edit  This branch could occur in place of any step where the administrator gives any input  1b. The administrator selects a cancel editing option  2b. SmartMap displays the old map. It exits edit mode but remains in administrator mode.  Editing in progress  1c.  If another administrator has a lock on map editing, SmartMap displays a message to that effect and  does not enter edit mode.                        EditAccounts  Summary  An administrator makes changes to the list of administrator accounts.  Preconditions  The SmartMap window must be open in a browser meeting the system requirements.  Trigger  The administrator logs in and selects the option to edit accounts.  Course of events  1. SmartMap retrieves a list of administrator accounts from the server.  2. SmartMap displays the login and real name of each account.  3. The administrator selects an account to edit or selects to create a new account.  4. SmartMap acquires a lock on the account.  5. SmartMap displays a full listing and options for the account:  a. Login name  b. Real name  c. Reset or set password option  d. (Under consideration) Permissions options  e. Delete account option  f. Save changes option  6. The administrator makes changes to the account and saves changes.  7. SmartMap saves changes to the server and releases the account lock.  8. Return to 2.    Alternate paths  Editing in progress  4b.  If the selected account is in use (unless by the administrator that is logged in) or is being edited,  return to 2.  Deleting account  6c.  The administrator selects the delete account option.  7c.  If the administrator is not editing his own account, SmartMap prompts for a delete confirmation;  otherwise return to 5.  8c.  The administrator selects confirm or cancel.  9c.  If the deletion was confirmed, SmartMap saves changes to the account listing; return to 2. If it was  cancelled, return to 5.  Cancelling account changes  6d. The administrator selects cancel, possibly after making changes.  7d. SmartMap releases the account lock; return to 2.  Cancelling account editing  3e.  The administrator closes the account edit display.  4e.  SmartMap returns the display to the main map.                    Scenario 3 – Mann Librarian Changing Exhibit Information  Individual  Emily Carr, Mann Library Librarian, location Man Library    Equipment  Library desktop in Admin Office in Mann    Scenario  1. EC opens her IE7 browser  2. Mann Library homepage appears  3. EC clicks on the SmartMap link on the homepage  4. SmartMap application is displayed with a floor plan overview of Mann Library  5. EC clicks on Admin link on SmartMap  6. Admin sign in form appears  7. EC types her username and password, the database authenticates her  8. SmartMap changes to Admin mode  9. EC selects the first floor plan in the floor overview map  10. First floor expands  11. EC selects the exhibition button  12. Exhibition information area shows the current information  13. EC selects to edit the exhibition information  14. Now each entry in the tab becomes an editable input area  15. EC changes the name, date, and description of the new exhibition and uploads two new images  16. EC submits the changes  17. EC receives a preview of the changes  18. EC confirms the changes  19. The new information is submitted to the database  20. EC signs out and closes the application    Data Models    Simplified ER Diagram  DrinkingFountains OutdoorPatios Restrooms Lockers ServiceDesks Stacks StudyAreas StaffOffices StudyRooms Exhibits Printers Photocopiers onFloor Floor Number isA Item Id xCoordinate name StairwellsElevators BaileyHortorium BirdWatchingStation Cafes ExhibitCases StudentExpoSpaces BissetCollabAreas Classrooms PublicComputingAreas SeminarRooms yCoordinate mannURL addURL image2 image1 description collabSpace Equipment Equipment Services POIs Collections PrinterFormats LoanableItems Views StudyRoomTypes LockerTypes   Breakdown of Simplified ER Diagram        An Item is an object that can be visible on the SmartMap.  Each Item will have a set of core  characteristics, such as X and Y coordinates, a name, and a description.            There will be many subclasses of Items: Café’s OutdoorPatios, etc.  Some of these subclasses will have  addition attributes unique to that object, such as gender for a Restroom or an hoursURL for a Café.        Each Item will be mapped to a floor.  The only exceptions to this are Stairwells and  Elevators, which will be mapped to all the floors they span.             There are several types of entities which will not be directly visible on the SmartMap.  They are shown  on the large ER Diagram as orange.  These entities will most likely be used or linked to by other Items or  entities.  For example, an Exhibit will not show up on the SmartMap but the ExhibitCase or  StudentExpoSpace that houses the exhibit will be visible and have more information about the Exhibit.        A View will be the type of view available from a room.  For example, a StudyRoom  could have a View of the woods or the parking lot.  These Views will be available to    those Items that are literally rooms that have a view.    o n F lo o r F lo o r N u m b e r Views Map    Color‐coding  Each room type should be associated with a color.  All rooms in the library are  divided into the following four categories: public area, private offices,  collaboration area, and facilities.  There colors to represent these areas will be  green, yellow, blue, and brown respectively.    Labeling  Most rooms are labels on the map.  However, smaller item will have easily  identifiable icons.    Hovering  When the user hovers over an item, a dialogue box will appear on top of the  room with basic information.    Clickability  When a user clicks on a room, facility, or piece of equipment on the map, the  map will bring up a display showing more in‐depth information.  The display is  represented as a tab which will be elaborated in the next section.    Toolkit  A toolkit will be provided on the left side of the map area.  It will include a  home, zoom buttons, and navigation buttons.  It will also include a legend with  description of the map color code.    Mockup          Tabs    Label  The upper left corner of the tab will contain the room name in its color code.    Photographs  Photographs of the room will be shown here if they are provided.  Otherwise, the area  will be replaced by the details section.    Details  This section contains detailed room information such as the item type, description,  hours, additional fields, and links.    Buttons  The upper right corner may have several buttons, such as maximize and minimize  buttons.  In the admin mode, it will also have editing buttons.        Footer  The footer will have additional links: Mann Library Homepage, Help, Admin, Contact, About, and  Feedback.  A new tab will appear for each one of these links with the exception of the Mann Library  Homepage link.     Mockup      Mockup Design  The colors on the mockup page are chosen to match the current Mann Library color scheme.  In  addition, different shades of gray will be used to differentiate between areas of the application.   SmartMap visitors will immediately be attracted to the map area because it will have more vibrant  colors in comparison with the background.  Pete bese © Ores Mela W Mls) Kol sea toa\\ (oo Ml sre =i lh i norronium a STUDY AREA Photographs Dy-o1/k3 nat Poe er en] DESCRIPTION: Sega ee Library Collaborative Learning Computer Laboratory (CL) teat | ee De ee ee eed ce Rd ae ced Ce ey ce nd BN te ea Ns ene nent aE ere occa CR raed ron foros ries ey