SOFTWARE REQUIREMENT

SPECIFICATION

[CSC 207 Software Engineering]

WhereToEat?
VERSION: [1.1.0] REVISION DATE:
[1/3/2011]

Approver Name Title Signature Date

SCHOOL OF COMPUTER ENGINEERING

NANYANG TECHNOLOGICAL UNIVERSITY
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

Contents

[CSC 207 Software Engineering].................................................................................................. i

WhereToEat?.................................................................................................................................. i
1. Product Description........................................................................................................................... 1
1.1 Product Vision............................................................................................................................. 1
Business Requirements...................................................................................................................... 1
1.3 Stakeholders and Users................................................................................................................ 1
1.4 Project Scope............................................................................................................................... 2
1.5 Assumptions.................................................................................................................................2
1.6 Constraints................................................................................................................................... 2
2. Functional Requirements................................................................................................................... 2
3. Data Requirements.............................................................................................................................4
4. Non-Functional Requirements........................................................................................................... 5
5. Interface Requirements...................................................................................................................... 7
6. Use Case Model................................................................................................................................. 8
6.1 Use Case Diagram....................................................................................................................... 8
6.2 Use Case Description................................................................................................................... 9
7. Glossary........................................................................................................................................... 15
8. References........................................................................................................................................ 15
9. Revision History.............................................................................................................................. 15

i
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

1. Product Description

1.1 Product Vision

“WhereToEat?” is a restaurant locator and reservation site in Singapore. The user can
search for restaurants on the basis of various criteria like cuisine, proximity, name,budget
etc. The user has the option of browsing through the top user-rated and reviewed
restaurants too. Also, the user might leave a review himself if he is logged in as a
member. On going to a particular restaurant page, he shall be provided with the
description of the restaurant with the price range and shall be redirected to the official
page for delivery and reservations. The manager can log in and keep a check on the
various reservations and reviews whereas the administrator shall keep the site upto date
with ratings, reviews, new changes to restaurants and special offers and promos.

The product aims to reduce the effort and time put in by a user to search for a suitable
dining place,also making his job easier ten-fold. The site will have a simple yet appealing
graphic user interface.

Business Requirements

The website should be on the internet without errors within 3 months time since starting
of development.

The website should achieve a total number of 1000 members after the 1st month of
operation

The popularity must rise up to “50 best restaurant searching websites” within the 1st year.

The site should get advertisements and thus get start getting profits within 3 months of
going on the internet.

1.3 Stakeholders and Users

Types of Stakeholders Stakeholders
System Owner Management Team of WhereToEat
System Users - Members
- Manager
- Administrator
- Guests

System Designers Development Team

1
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

1.4 Project Scope

The current project will provide efficient software to meet users' needs. It should
help the user to find the perfect dining place according to the given criteria
suggested by him/her or should suggest dining places of their preffered choice with
special events and performances.

1.5 Assumptions
- Users are computer literate.
- Guests should have an email account.
- User is looking for restaurants in Singapore

1.6 Constraints

- The project should be developed using Java with JSP and servlets
- The project is to be built on MySQL database
- The website is to be set up within 10 weeks.
- Home Delivery cannot be taken care of, so user is redirected to
restaurants home page.

2. Functional Requirements

2.1 Administrator
2.1.1 The website must allow administrator to post new dining place.

2.1.2 The website must allow administrator to add, edit , and delete special event
in a dining place.

2.1.3 The website must allow administrator to read feedback from the user and
sort out restaurants according to rating.

2.1.4 The administrator should be able to make any changes to restaurant pages
and should be able to change ‘site rating’ according to reviews.

2
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
2.2 Guests
2.2.1 The website must allow guest to search dining place based on name, area,
vegetarian/non- vegetarian, environment, rating, buget and cuisine.

2.2.2 The website must allow guest to view info about a dining place.

2.2.3 The website must allow guests to login if they have an

existing account.

2.2.4 The website must allow guests to sign up as new users to

the website.

2.2.4.1 Guest must have read, understood and accept

the Terms of Use and Privacy Policy for this web
site.

2.2.5 Guest must login to post a review and rate

2.2.6 The website must allow guest to view review about a

dining place but cannot post reviews

2.2.7 The website must allow guest to give feedback only after the log in

2.2.8 The website must allow dining place owner to suggest a new dining place.

2.3 Member
\2.3.1 The website must allow a member to search dining place based on name,
area, veg/non- veg, environment, rating, buget and cuisine.

2.3.2 The website must allow member to view info about a dining place.

2.3.4 The website must allow members to sign in to the

website.

2.3.5 Members can post a rating of the restaurant

2.3.6 The website must allow guest to view review about a

dining place.

2.3.7 The website must allow a member to give feedback only after .

3
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

2.3.8 The website must allow dining place owner to suggest a new dining place.

2.3.9 The system must list not more than 10 restaurants per page

3. Data Requirements

3.1 Registration and Login page

3.1.1 Username must be alpha‐numeric

3.1.2 Username must not be more than 40 characters
3.1.3 Password must be between 5 to 15 characters long
3.1.4 System must check the age of users against the birth year
3.1.5 Name provided by user must not exceed 40 characters
3.1.6 Email address of user must contain ‘@’ and also ‘.’ in it
3.1.7 Postal code must be a positive 6 digit integer
3.1.8 Contact number must be a positive integer
3.1.9 Repeat password must match password entered

3.2 Restaurant page

3.2.1 Upcoming events must not be before the current date

3.2.2 System must check for user’s privilege
3.2.3 Cost of meal must not be less than 0
3.2.4 No reservations should be taken after time of closing

3.3 Contact page

3.3.1 Contact email must be a valid email

3.3.2 Date of Birth must be a valid date before current date
3.3.3 Postal code must be a positive 6 digit integer

4
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

4. Non-Functional Requirements

4.1 Accessibility

4.1.1 System is able to be viewed/used anywhere and at anytime as long there is an

internet connection and a workstation (e.g. PC, laptop, pda, and iPhone).

4.1.2 System is able to be viewed on any web browsers correctly.

4.2 Performance

4.2.1 Browser Compatibility

The web site must display correctly on any java-enabled web browsers
(i.e. Internet Explorer, Mozilla Firefox, Safari etc.) due to the large
amount of web browsers available, the system will mainly focus on
compatibility for Internet Explorer as it is most widely use.

4.2.2 Bandwidth Usage

The loading of the web site and the respond for any operation should be
less than 5 seconds.

4.2.3 Hardware Compatibility

The website must be optimized for low end systems in terms of CPU
usage (Flash animations can be CPU intensive).

4.2.4 System Stability

The system must be able to handle multiple logins for different group of
users concurrently.

The systems should be able to handle multiple searches all within the
minimum time required

4.2.5 System Maintenance

5
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

The system will be maintained monthly and will be unavailable to users

every first Monday of the month from 1am to 2am. The system will be
back up on a daily basis so as to deal with sudden unforeseen failure.

4.3 Reliability
4.3.2 The mean time between breakdowns should be between 30 minutes to 1 hour’s
time.

4.3.2 The system must be operational 99% of the time over 5 years.

4.3.3 The system must be able to auto backup its database every 3 days taking not more
than a few hours for each backup

4.3.4 Database must be able to store at least 500 restaurant records

6
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

5. Interface Requirements

5.1 User Interfaces

Choice of colors must be professional and project a harmonious look.

The user interface must be user-friendly for guest users to be able to fulfill their
needs within the least number of clicks and without the help of a manual.

Functionalities intended for staffs are hidden from guest and requires staff login
access to be seen.

There should be sufficient white spaces between content to ensure that it is

pleasant to human eye.

5.2 Hardware Interfaces

Web capable device that has java- enabled browses (notebook, mobile phones,
PDA) will be supported by the software.

5.3 Software Interfaces

Software application requires an internet browser to run, which does not restrict
the operating system to Microsoft Windows.

5.3.1 Google Map Server

The software will interact with google map server via google map api and api
key. The software will send its selected coordinates of the place of a dining place to
google map server and a map centered at the coordinates will be displayed

7
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

6. Use Case Model

6.1 Use Case Diagram

8
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

6.2 Use Case Description

Use Case ID: Use Case 1

Use Case Name: Login
Created By: Team WebMasters Last Updated By:
Date Created: 24-2-2011 Date Last Updated:

Actors: Guest, Admin, Manager

Description: Guest – To login as valid user
Admin – Login as a valid user and update the restaurant information
Manager – Login as a valid user and view website feedback and review

Trigger: Guest, Admin and Manager clicks on Login button

Preconditions: User is not logged in
Postconditions: User will be logged in
Normal Flow: 1. Guest, Admin and Manager enter valid username and password and
clicks login.
2. System authenticates user login credentials.
3. System stores user information in session and allows user to
review, rate or write feedback.
Alternative Flows:
Exceptions: System cannot verify the user id or password.
System displays an error message stating that the user id or password is
invalid.
Includes: Nil
Priority:
Frequency of Use:
Business Rules: • Valid user name is a valid email address
• Valid password must be alphanumeric of 6‐10 characters
• Valid login, user name must be present in the database

Special Requirements:
Assumptions:
Notes and Issues:

9
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]

Use Case ID: Use Case 2

Use Case Name: Search
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Member, Guest, Admin, Manager

Description: Search the restaurant according to the specification given by the user.
Trigger: Member, Guest, Admin, Manager clicks the Search button.
Preconditions: Nil
Postconditions: The restaurants information according to the user specification should be
displayed.
Normal Flow: • The user should select the criteria for search.
• The user clicks the Search button
• The results are displayed
Alternative Flows: No restaurant found.
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

Use Case ID: Use Case 3

Use Case Name: View Restaurant
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Member, Guest, Admin, Manager

Description: Displays the details of the particular restaurant that the user selects from
the search results.
Trigger: The user clicks on one of the restaurant in the search results
Preconditions: The user should give the search criteria and clicks the search button
Postconditions: Displays the details about the restaurant
Normal Flow: From the search results the user clicks one of the restaurant.
Alternative Flows: Nil
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:

10
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
Notes and Issues:

Use Case ID: Use Case 4

Use Case Name: Sign Up
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Guest
Description: The guest give their details to become a member of the website
Trigger: The guest clicks on the sign up button
Preconditions: • The guest should not be a member of the website
• The guest should have a valid e-mail ID
Postconditions: The guest will become a member of the website
Normal Flow: • The guest clicks on the sign up button
• Gives a valid e-mail ID and password
• The guest clicks on the confirm button
Alternative Flows: The E-mail ID given is invalid
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

Use Case ID: Use Case 5

Use Case Name: Write Feedback
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Member
Description: The members can give the feedback about the website
Trigger: Member clicks on the write feedback button
Preconditions: The member should be logged in
Postconditions: The feedback will be displayed in the website
Normal Flow: • The member logs in
• Write the feedback
• Clicks submit button
Alternative Flows:
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:

11
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
Notes and Issues:

Use Case ID: Use Case 6

Use Case Name: Rate, Review
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Member
Description: To rate and review the restaurant
Trigger: The Member clicks on the rate or review button
Preconditions: The member should be logged in
Postconditions: Review or Ratings should be displayed on the restaurant’s page
Normal Flow: • The member logs in
• Go to the restaurant’s page
• Rate or Review the restaurant
• Clicks submit button
Alternative Flows: Nil
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules: This use case would accumulate guest feedbacks
and make improvement so that the hotel will be
able to function more efficiently.
Special Requirements:
Assumptions:
Notes and Issues:

Use Case ID: Use Case 7

Use Case Name: View Feedback, View Review
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Admin, Guests, Member and Manager

Description: Users can view the feedback of the website and review of the restaurants
Trigger: Go to the restaurant page for the review and feedback section
Preconditions: Feedback or review should be available
Postconditions: Feedbacks and reviews should be displayed
Normal Flow: • The user will go to the restaurant page and review section
• And view the feedback or review
Alternative Flows:
Exceptions: Nil
Includes: Send Email
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

12
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
Use Case ID: Use Case 8
Use Case Name: Update Restaurant, Add New Restaurant
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Admin
Description: Update the details of the restaurant and add new restaurant to the database.
Trigger: Admin clicks the Update restaurant or Add new restaurant button
Preconditions: Admin should be logged in
Postconditions: The details should be updated in the website
Normal Flow: • Admin clicks on the Update restaurant or Add new
restaurant button.
• Admin updates the details
• Clicks the submit button
Alternative Flows: Nil
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

Use Case ID: Use Case 9

Use Case Name: Send E-mail
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Email Server

Description: Sends email about the review of the restaurant to the respective restaurant
manager
Trigger: When a user reviews a restaurant
Preconditions: Admin should be logged in
Postconditions: The restaurant manager will be notified
Normal Flow: • User submits a review
• Admin will log in and view the review
• Email server will send the review
Alternative Flows: Nil
Exceptions: Nil
Includes: NIl
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:
Use Case ID: Use Case 10
Use Case Name: Retrieve Map Location

13
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Google Server

Description: To see the restaurant’s location
Trigger: User clicks on the retrieve map location button
Preconditions: Nil
Postconditions: The location will be displayed
Normal Flow: • User clicks on the retrieve map location button
• Location will be displayed
Alternative Flows: Nil
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

Use Case ID: Use Case 11

Use Case Name: Logout
Created By: Team WebMasters Last Updated By:
Date Created: 24-02-2011 Date Last Updated:

Actors: Guests, Member, Admin, Manager

Description: To logout from the website
Trigger: Actor clicks on the logout button
Preconditions: Actor must have logged on to the system.
Postconditions: Actor is logged out of the system
Normal Flow: • Actor clicks the “Logout” button
• System logs the user out.
• System displays a message stating that the
actor is being logged out of the system.
Alternative Flows: Nil
Exceptions: Nil
Includes: Nil
Priority:
Frequency of Use:
Business Rules:
Special Requirements:
Assumptions:
Notes and Issues:

14
 SOFTWARE REQUIREMENTS
SPECIFICATION
[Project Name] [Version Number] | [Revision Date]
7. Glossary

Define all terms and acronyms required to interpret the SRS properly. This is the
(problem) domain dictionary.

8. References

Provide a list of all documents and other sources of information referenced in the
SRS and utilized in developing the SRS. Include for each the document number,
title, date and author.

Document No. Document Title Date Author

9. Revision History

Identify changes to the SRS.

Version Date Name Description

15