List of Version - Google Code

Document Sample
List of Version - Google Code Powered By Docstoc
					                        Software Institute, Nanjing University, China




Schematizing Map for Sports Events


Requirement
Specification
For the SCORE 2011 Contests




  Team: Kongfu

September 28th , 2010
 Team Kongfu,                                                                    For the SCORE 2011 Contests


                                   LIST OF VERSION


       No                        Time                                         Editor

       Version 1.0               September. 28th             , 2010           All members in Kongfu Team.




GLOSSARY



SRS                         Software Requirement Specification

SM                          Schematizing Map

TC                          Team Coach

TL                          Team Leader

TM                          Team Members

PE                          Project Evaluators




CONTENTS
List of Version ..................................................................................................................... 2

Glossary ............................................................................................................................... 2

Contents ............................................................................................................................... 2



 Software Institute, Nanjing University, China
                                                                                                                                             2
 Team Kongfu,                                                                   For the SCORE 2011 Contests

1. Introduction ................................................................................................................... 5

      1.1.      Purpose ............................................................................................................... 5

      1.2 Scope ....................................................................................................................... 5

      1.3 Team Information .................................................................................................... 6

      1.4 Target Audience ...................................................................................................... 6

      1.5. References .............................................................................................................. 7

2. Overall Description ....................................................................................................... 7

      2.1.      Product Prospective ............................................................................................ 7

      2.2. Users’ Characteristics ............................................................................................. 7

      2.3. Assumptions and Restrictions ................................................................................ 8

3. Specific Requirement .................................................................................................... 8

      3.1. Functional Specification......................................................................................... 9

             3.1.1 Diagram ......................................................................................................... 9

             3.1.2 Use Case ...................................................................................................... 10

             3.1.4 GUI Design .................................................................................................. 16

      3.2. Performance Specification ................................................................................... 23

             3.2.1 Accuracy ...................................................................................................... 23

             3.2.2 Requirements of the Response Time ........................................................... 23

      3.3. I/O requirements ................................................................................................... 24

      3.4. Performance of data Storage ................................................................................ 24


 Software Institute, Nanjing University, China
                                                                                                                                            3
 Team Kongfu,                                                                 For the SCORE 2011 Contests

     3.5. Exception Management ........................................................................................ 25

4. Running Platform Requirements................................................................................. 25

     4.1. Hardware .............................................................................................................. 25

     4.2. Software ............................................................................................................... 25

     4.3. Procotol ................................................................................................................ 26

     4.4. Control.................................................................................................................. 26




 Software Institute, Nanjing University, China
                                                                                                                                         4
Team Kongfu,                                        For the SCORE 2011 Contests




1. INTRODUCTION


1.1. PURPOSE


      Requirements engineering is the first step of software development.
      Requirements engineering helps the software engineers to have a better
       knowledge of the problems that are under consideration.
      This specification can be modified in practice, and of course, team members will
       discuss carefully before any modification.




1.2 SCOPE


      This SRS gives analysis and descriptions about the
         function ,
         capacity,
         I/O, network requirement
         data managing,
         exception handling, etc
         We can refer to this SRS later, when we deal with the development including
        architecture, design, implementation and test.




Software Institute, Nanjing University, China
                                                                                          5
 Team Kongfu,                                       For the SCORE 2011 Contests


1.3 TEAM INFORMATION


  Team Coach:


             Name                     Email                        Institute

        Guoping Rong       ronggp@software.nju.edu.cn       Software Institute,
                                                            Nanjing University,
                                                                    China



  Team Members


      Name              Abbr                        Email                           Institute

    Jinru Hua           JR.H              score.si.nju@gmail.com                   Software

   Shiying Ge           SY.G            gsy08@software.nju.edu.cn                  Institute,

    Yun Gao             Y.G             gaoy08@software.nju.edu.cn                 Nanjing

   Jinsheng Li          JS.L             ljs744955573@gmail.com                   University,

     Yingya             YY.Z            zyy081251208@gmail.com                      China

     Zhang




1.4 TARGET AUDIENCE



The target audience of this SRS are but not limited to:


a) The Program Committee of SCORE 2011
b) Team Coach (TC)

 Software Institute, Nanjing University, China
                                                                                                6
 Team Kongfu,                                          For the SCORE 2011 Contests

c) Team Leaders (TL)
d) Team Members (TM)




1.5. REFERENCES


1. Schematizing Maps for SCORE project (Preliminary Version) by Michal Young,
   University of Oregon
2. IEEE Standards Description: 830-1998: for Software Requirement Specifications.
3. Google Map API
   (http://code.google.com/apis/maps/documentation/javascript/tutorial.html )




2.        OVERALL DESCRIPTION


2.1. PRODUCT PROSPECTIVE


     The main goal of our project is to help cities that hold big events, for instance, Youth
Olympic Games in Nanjing, 2012 or the World Expo in Shanghai, to design a useful
schematizing map for visitors.




2.2. USERS’ CHARACTERISTICS



 Software Institute, Nanjing University, China
                                                                                                7
 Team Kongfu,                                         For the SCORE 2011 Contests

       The designers of the Schematizing Map of the Events.
       Since the users of this program are ordinary people, whose nationality,
        educational background, age, gender, etc. can be totally different. We should
        approach for:
         A little knowledge in operating the computer is required when using this
             program.
         If the interface is friendly, the users can accept it easily. According to these,
             this tool should emphasize on the HCI design, such as conciseness and
             friendliness.
         Since the user may make mistakes by accident, the exception managements
             should be designed carefully and the software must be built as robust as
             possible.

Only in this way can the schematizing map creator satisfy different users.




2.3. ASSUMPTIONS AND RESTRICTIONS


a. Assume that we don’t have to take the functions of the hardware into consideration.
b. Assume that the state of the Internet is acceptable.
c. Assume that if the user close the window or disconnect the Internet, he or she would
   like to exit.
d. Assume that the form of the schedules (EXCEL files) satisfies the specific forms.
   (The detail form specification is mentioned at use case 4)




3. SPECIFIC REQUIREMENT

 Software Institute, Nanjing University, China
                                                                                              8
Team Kongfu,                                    For the SCORE 2011 Contests




3.1. FUNCTIONAL SPECIFICATION



3.1.1 DIAGRAM




USE CASE DIAGRAM




ACTIVITY DIAGRAM



Software Institute, Nanjing University, China
                                                                              9
Team Kongfu,                                    For the SCORE 2011 Contests




3.1.2 USE CASE




Software Institute, Nanjing University, China
                                                                              10
 Team Kongfu,                                         For the SCORE 2011 Contests

Use Case 1            Add significant features to determine the rough route
Scope                 User PC

Level                 User goal
Goal in context       Choose rough route as user’s wish
Actor                 User
Precondition          Start the program, and enter Google Map homepage
Trigger               Enter the Google Map web page of the application
Post-Condition        The rough route is determined.

Steps                 User is able to add 2 kinds of points: significant features
(Basic Flow):         (stadiums, etc) and landmarks, (hospitals, etc). This use case
                      refers to add significant features. To add landmarks, please
                      refer to Use Case 2.
                      1.   User clicks on the Google Map to choose the significant
                           features.
                      2.   User can drag the route to change the rough route.
                      3.   User right clicks on the key point and chooses to edit the
                           name or delete the key point.
                      4.     If the user chooses to edit the name of the key point, an
                           input text box appears which enables the user to edit the
                           name of the key point.
                      5.   When the user has got a rough route, if he/she clicks the
                           finish button, the schematizing map is produced
                           immediately, yet if user clicks the edit button, the slices
                           editing page is shown. (Use case 3)
                      6.   At any steps, user can click the reset button to reset the
                           route, and a new page with a fresh Google Map appears.
Exception/Extension 1a. If position which the user clicks isn’t on the Google map
                      the application won’t response to the user.


 Software Institute, Nanjing University, China
                                                                                         11
 Team Kongfu,                                         For the SCORE 2011 Contests

                       2a.Without the network, user can’t adjust the routes
Technology and         1. Every point consist the latitude, longitude and the name of
data variations list   the point and a Boolean value to indicate whether the point is
                       the key point or not.
                       2. The route is got from the Google Map API and is
                       represented by Jason.




Use Case 2             Add Landmark

Scope                  User PC
Level                  User goal
Goal in context        Allow users to add landmarks around the significant features
Actor                  User
Precondition           Start the program, and enter Google Map homepage
Trigger                User drags some icon of landmarks in the landmark panel.

Post-Condition         Add landmarks as protected features on the map.
Steps                  1. User clicks any icon of landmarks in the landmark panel.
(Basic Flow):          2. Drag the icon to where you want it to be placed.
                       3. Release the mouse, and set the icon.
                       4. Enter the name of this landmark in the input box above,
                          which is shown once the icon is put on some specific
                          location.
                       5. Right-click the mouse, choose to delete this landmark. Or
                          you can just press “delete” key to delete it.
                       6. At any steps, user can click the reset button to reset the
                          route, and a new page with a fresh Google Map appears.
Exception/Extension None
Technology and         None


 Software Institute, Nanjing University, China
                                                                                        12
 Team Kongfu,                                           For the SCORE 2011 Contests

data variations list




User Case 3            Use Slices to Edit Rough Route
Scope                  User

Level                  User goal
Goal in context        Providing user a convenient way to adjusting the relative
                       distance of significant features.
Actor                  User
Precondition           The rough route has been created.
Trigger                User clicks the “Edit” button.
Post-Condition         Through appropriate adjusting, user can obtain a satisfying
                       map which is ready for schematizing.

Steps                  There are two kinds of slices:
(Basic Flow):             White ones with significant features in it; white slices are
                           protected.
                          Gray ones without significant features in it. Gray slices
                           can be shrunk, stretched or deleted as a means of editing
                           the map.
                       1. The slices are cut by default size. User moves mouse to the
                           edge of a slice, the cursor will change to a two-way arrow,
                           and then user can shrink or stretch the slices.
                       2. User can right clicks the gray slices, and chooses to
                           protect/de-protect or delete item at the displayed menu.
                       3. At any steps, user can click the reset button to reset the
                           route, and the initial rough route reappears on the screen.
Exception/Extension
Technology and         JavaScript


 Software Institute, Nanjing University, China
                                                                                          13
 Team Kongfu,                                              For the SCORE 2011 Contests

data variations list




Use Case 4             Import schedules (EXCEL files)
Scope                  User PC

Level                  User goal
Goal in context        Import schedules in local machine
Actor                  User
Precondition           A simplified map with significant & landmarks has been
                       created
Trigger                User clicks the button of      “import schedules”
Post-Condition         An schematizing map is created finally

Steps                  1. User clicks the button of “import schedule”;
(Basic Flow):          2. User chooses the file he/she wants.
Exception/Extension 1a. The file that to be imported is broken, then the user have to
                       delete the file and import again;
                       2a.Errors happens when it is imported, then the user have to
                       delete the file and import again;
Technology and            Schedule form: (Refer to 3.3 I/O requirement)
data variations list        The first row of the file must be the category names of
                                 the schedule (such as Place, Time, Teams, Nations,
                                 etc)
                            The first line of the EXCEL must be the place names,
                                 and the program only displays the relevant
                                 information according to the place names, that is, the
                                 first line of the file.




 Software Institute, Nanjing University, China
                                                                                          14
 Team Kongfu,                                        For the SCORE 2011 Contests

Use Case 5            Search the schedule to get the information user wants
Scope                 User PC

Level                 User goal
Goal in context       The system displays the information which related to the key
                      words that the user inputs in the search box
Actor                 User
Precondition          The schedule has been imported correctly
Trigger               User selects the category of information and enters the key
                      words in the search box
Post-Condition        The system displays the information around certain significant
                      feature which related to the key words that the user inputs in
                      the search box

Steps                 1. In the first checkbox column, User selects the search items
(Basic Flow):             (such as time, nation, sports etc), and these kinds of
                          contents will show in different Combo-boxes (such as
                          Time-combo-box, Nation-combo-box, etc).
                      2. User selects some items in different combo-boxes, to
                          choose the corresponding information shown in the
                          schematizing map.
                      3. In the second checkbox column, user selects the showing
                          items (such as time, nation, sports etc). And these kinds of
                          information will be shown on the map. The system
                          displays the information around certain significant feature.
                      4. User can drag the information and put it at the right place.
Exception/Extension 1a. If the schedule does not follow the form referred in use
                      case 4, the user cannot get the information he/she wants.
                      3a. If the information is too much and there isn’t enough space,
                      then the user can drag the textbox to determine the size of the


 Software Institute, Nanjing University, China
                                                                                         15
 Team Kongfu,                                         For the SCORE 2011 Contests

                       box.
                       2a. If the key words are illegal, the system cannot get
                       information that user prefers to get.
Technology and
data variations list




Use Case 5             Help & About Us

Scope                  User PC
Level                  User goal
Goal in context        Show the help & about us information
Actor                  User
Precondition           User enters the program correctly
Trigger                User selects to see the Help or About Us label

Post-Condition         The system displays the relative information
Steps                  1. The user chooses to see a certain item of information.
(Basic Flow):          2. The information is shown according to user’s choice.
Exception/Extension None
Technology and         None
data variations list




3.1.4 GUI DESIGN




INITIAL IMAGE




 Software Institute, Nanjing University, China
                                                                                    16
            Team Kongfu,                                    For the SCORE 2011 Contests




                     We show a
                     Google Map




           ADD SIGNIFICANT FEATURES & LANDMARKS




Landmarks can be added by
dragging the icons
                                   Initially, we get a
                                   rough route by means
                                   of Google Map




     The space name are
     shown here

            Software Institute, Nanjing University, China
                                                                                          17
         Team Kongfu,                                           For the SCORE 2011 Contests

         USE SLICES TO EDIT ROUGH ROUTE



                                    User clicks “vertical” or
                                    “horizontal” to choose                         The purple parts
                                    the direction of slices.                       are the slices that
                                                                                   can change size.




User drags the edge
of the slice by mouse,
and the user can
shrink or stretch the
slice.




         IMPORT SCHEDULE & SEARCH FOR INFORMATION




         Software Institute, Nanjing University, China
                                                                                                         18
            Team Kongfu,                                    For the SCORE 2011 Contests




User can import an
EXCEL file which
has a particular format




            Software Institute, Nanjing University, China
                                                                                          19
              Team Kongfu,                                    For the SCORE 2011 Contests


The system will generate 2 groups
of check boxes according to the
titles of the table in the Excel file.




 first group for    Second group
 the filter         indicates whether
                    the information will
 condition
                    be displayed in the
                    final map




     User selects the
     wanted items in
     combo-box




              CREATE THE SCHEMATIZING MAP


              Software Institute, Nanjing University, China
                                                                                            20
              Team Kongfu,                                          For the SCORE 2011 Contests




                                                              The route of the
                   Landmarks
                                                              schematizing map


                                                                                 The kind points are the key points
                                                                                 and the names of the key points are
                                                                                 beside the points.




The corresponding schedule is
shown with the categories user
has chosen.




           HELP & ABOUT US




              Software Institute, Nanjing University, China
                                                                                                                       21
Team Kongfu,                                    For the SCORE 2011 Contests




Software Institute, Nanjing University, China
                                                                              22
    Team Kongfu,                                       For the SCORE 2011 Contests




3.2. PERFORMANCE SPECIFICATION


The system can be used by 1000 people at most at the same time.




3.2.1 ACCURACY


      Google Map Accuracy:It depends on the accuracy of Google Map.
      Algorithm accuracy: Ensure the correctness of topology.




3.2.2 REQUIREMENTS OF THE RESPONSE TIME



      The time used for interaction with Google Map: It depends on the quality of network.
    Software Institute, Nanjing University, China
                                                                                              23
    Team Kongfu,                                         For the SCORE 2011 Contests

      The time used to load the webpage: It depends on the quality of network.
      Get the schematizing map by algorithms: no more than 2s.
      Import Excel or other kinds of schedule: no more than 3s.
      The time for searching specific schedules: no more than 1s.




3.3. I/O REQUIREMENTS


      The main I/O requirements relates to the import of EXCEL files, which must follow
       the form of schedules.
      The form of schedules:
        The first row of the file must be the category names of the schedule (such as
           Place, Time, Teams, Nations, etc)
        The first line of the EXCEL must be the place names, and the program only
           displays the relevant information according to the place names, that is, the first
           line of the file.
       Model:




3.4. PERFORMANCE OF DATA STORAGE


    Software Institute, Nanjing University, China
                                                                                                24
    Team Kongfu,                                         For the SCORE 2011 Contests

Null




3.5. EXCEPTION MANAGEMENT


      If the imported EXCEL file does not satisfy the specific form, the user cannot get the
       corresponding information he/she is expected to get.
      More detail exception management is mentioned in Design Document.




4.        RUNNING PLATFORM
         REQUIREMENTS


4.1. HARDWARE


     PCs or notebooks that have the ability to surf the Internet.




4.2. SOFTWARE

The Development                OS: Windows Vista, Windows 7
Platform                       Language: JAVA 6.0
                               IDE: Eclipse Java EE
                               Server: Tomcat v6.0 Server at localhost


    Software Institute, Nanjing University, China
                                                                                                25
 Team Kongfu,                                        For the SCORE 2011 Contests

                            Test Tool: JUnit,
                            Other: SVN,

The Running Platform        Eclipse Java EE
                            Multiple kinds of browsers.




4.3. PROCOTOL


Network Transport Protocol: HTTP




4.4. CONTROL


Control the tool with mouse, when the user types in the place names or some notes, he/she
may use keyboard as well.




 Software Institute, Nanjing University, China
                                                                                            26

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:0
posted:5/19/2013
language:Unknown
pages:26
tang shuming tang shuming
About