Search4Yummy
User Manual
Version 1.0
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
Revision History
Date
Version
Description
Author
2011-12-10
0.1
Initial Version
Yehui Wang
2011-12-30
0.2
Mobile application manual
Lovro Maričić
2011-01-03
0.3
Web application manual
Yehui Wang
2011-01-05
0.4
Add 3.1.8, 3.1.9
Yehui Wang
2011-01-12
1.0
Review
Muhammad Sulyman
Page 2
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
1.
Introduction ........................................................................................................................ 4
1.1 Purpose of this document ............................................................................................ 4
1.2 Document organization ............................................................................................... 4
1.3 Intended Audience ....................................................................................................... 4
1.4 Scope ........................................................................................................................... 4
1.5 References ................................................................................................................... 4
2. General overview ............................................................................................................... 5
3. Web Application ................................................................................................................. 6
3.1 Web application for Customer..................................................................................... 6
3.1.1 Customer Registration ......................................................................................... 6
3.1.2 Customer Login/Logout ....................................................................................... 6
3.1.3 Customer Modify Personal Information .............................................................. 7
3.1.4 Restaurant Search and View ................................................................................ 8
3.1.5 Restaurant Grade and Comment .......................................................................... 9
3.1.6 Menu View and Grade ....................................................................................... 10
3.1.7
Dish View, Comment and Grade........................................................................ 11
3.1.8 Save Dish and View Dish Wish List .................................................................. 14
3.1.9 News Registration/Unsubscribe for Restaurant Type ........................................ 14
3.2 Web application for Restaurant Staff ........................................................................ 15
3.2.1 Restaurant Staff Login/Logout........................................................................... 15
3.2.2 Setup a New Restaurant ..................................................................................... 15
3.2.3 Modify/Delete a Restaurant ............................................................................... 17
3.2.4 Add/Delete/Modify Menu for a Restaurant ....................................................... 18
3.2.5 Add/Delete/Modify Dish for a Restaurant ......................................................... 20
3.2.6 Add/Delete/Modify News for a Restaurant ....................................................... 22
3.3 Web application for Admin ....................................................................................... 23
3.3.1 Administrator Login/Logout .............................................................................. 23
3.3.2 Add/Delete/Modify Customer ........................................................................... 24
3.3.3 Add/Delete/Modify Restaurant Staff ................................................................. 26
3.3.4 Add/Modify Restaurant Types ........................................................................... 27
4. Mobile Application .......................................................................................................... 30
4.1 Home screen (Guest) ................................................................................................. 30
4.2 User registration ........................................................................................................ 30
4.3 User login .................................................................................................................. 31
4.4 Search 4 restaurant .................................................................................................... 32
4.5 Restaurant details ...................................................................................................... 33
4.6 Search 4 dish ............................................................................................................. 35
4.7 Dish details ................................................................................................................ 36
4.8 My Stuff page ............................................................................................................ 37
4.9 My Profile page ......................................................................................................... 38
4.10
Uploading a picture ............................................................................................... 38
4.11 Log out ...................................................................................................................... 38
Page 3
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
1.
Introduction
1.1
Purpose of this document
The purpose of this document is to explain functionalities of the Search4Yummy application to the
customers.
1.2
Document organization
The document is organized as follows:
 Section 1, Introduction of the system, describes contents of this guide, used documentation during
developing process etc.
 Section 2, General Overview, describes the general application purpose and intended usage scenarios
 Section 3, Web Application, describes the functionalities and the usages of the users.
 Section 4, Mobile Application, describes the functionalities and the usages of the users
1.3
Intended Audience
The intended audience is:

end users of the system

Project team members

Supervisors
1.4
Scope
This document covers the functionalities of Search4Yummy system: How to use this system both from
Web application side and Mobile application side.
1.5
References
For additional information the following documents can be used as reference:

Requirement Requirements Document

Design Description Documents

Development Environment Document

Acceptance Test Plan Document
Page 4
Search4Yummy
User Manual
2.
Version:
1.0
Date: 2011-01-12
General overview
The project aims at creating a web site and a mobile application specializing at selecting the best
restaurant/coffee bar depending on user’s preferences. One of the main goals of building this kind of an
application is to help users in finding and/or managing restaurant/coffee bar and their services e.g.
insight in some basic restaurant/coffee bar information, its menu and gallery and so on. The basic
concept of using application in this project is that there will be two main profiles of users who will be
using the application.
User profile that includes restaurant/coffee bar staff including a restaurant owner will be changing
information of their restaurant in which they work or they are owner of, depending on which user of
this profile has privileges to change certain info. This information includes managing photos of their
restaurant/coffee bars, basic info about the restaurant/coffee bar such as location, name, contact info
and so on, managing offers of their dishes e.g. prices, adding a new dish and so on.
The mentioned information will be available to see to the common registered user which is the second
user profile. This profile of user will have an option to find a restaurant of their choice based on various
criteria which application will offer e.g by certain type of dish, by how far the restaurant/coffee bar is –
the app will have an option to search the restaurant/coffee bar based on the user's location, or
rating/popularity of that restaurant/coffee bar . If the user likes or dislikes particular restaurant/coffee
bar he can leave feedback for that restaurant/coffee bar in a form of comment, photo or recommend a
certain dish in form of leaving a grade or maybe even leaving a constructive review. Also there is an
option of subscribing to a newsletter for a certain restaurant/coffee bar which he favors.
Page 5
Search4Yummy
User Manual
3.
Version:
1.0
Date: 2011-01-12
Web Application
We divide the web application into three parts: one is for customers who could interact with the system.
Second one is for staff members who could mange their restaurant's information. The last one is for
administrator who could manage and configure the system.
3.1
Web application for Customer
3.1.1
Customer Registration
1. Guest fills a form for new user registration (username, password, e-mail, first and second
name, phone, address).
3.1.2
2.
System creates new user.
3.
System informs user about successfully created user account by registered e-mail.
4.
User needs to confirm registration information on email.
5.
Then user could login as a registered customer.
Customer Login/Logout
1.
User input username and password into login box;
a.
2.
If user wants system to remember his password, he could check “Don't ask for my
password for two weeks”.
Login.
Page 6
Search4Yummy
User Manual
3.
3.1.3
Version:
1.0
Date: 2011-01-12
Login users can also logout by click “LOGOUT”, then user exits successfully.
Customer Modify Personal Information
1. Login users can modify their profile by click “MY PROFILE”, and save it.
Page 7
Search4Yummy
User Manual
3.1.4
Version:
1.0
Date: 2011-01-12
Restaurant Search and View
1. User can input keywords for search restaurant, and system shows list of restaurants that have
met chosen keywords.
2.
Click selected restaurant and system shows its details (name, popularity, location, comments,
photos, menu, grade of restaurant, available seats, news)
Page 8
Search4Yummy
User Manual
3.1.5
Version:
1.0
Date: 2011-01-12
Restaurant Grade and Comment
1. User can clicks on “five starts” to grade the selected restaurant on the restaurant page. Then
system saves grade and displays the result after user grading.
2.
Login user can write a comment about restaurant, and then system saves comment and
displays user’s comment.
Page 9
Search4Yummy
User Manual
3.
3.1.6
Version:
1.0
Date: 2011-01-12
Also user can clicks on “five starts” to grade the comments of other users. System saves grade
and displays the result after user grading
Menu View and Grade
1. User could view menu from the “Top Menu” on the main page or from the “Most popular
menu”/“View all menus” on the selected restaurant page.
Page 10
Search4Yummy
User Manual
2.
3.1.7
Version:
1.0
Date: 2011-01-12
Then system shows list of dishes. And user can also click on “five starts” to grade the selected
menu. System saves grade and displays the result after user grading.
Dish View, Comment and Grade
1. User could view dish from the “Top Dishes” on the main page or from the “Most popular
Dishes”/“View all Dishes” on the selected restaurant page or from the selected menu.
Page 11
Search4Yummy
User Manual
2.
Version:
1.0
Date: 2011-01-12
Then system shows list of dishes. User can click any dish of them to see the details. And user
also can click on “five starts” to grade the selected dish. System saves grade and displays the
result after user grading
Page 12
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
3.
Login user can write a comment about dish, and then system saves comment and displays
user’s comment.
4.
Also user can clicks on “five starts” to grade the comments of other users. System saves grade
and displays the result after user grading
Page 13
Search4Yummy
User Manual
3.1.8
Save Dish and View Dish Wish List
1. User clicks on “Save dish” option for the selected dish, then System saves dish on wish list. If
you want to remove it from wish it, just click “Remove dish”
2.
3.1.9
Version:
1.0
Date: 2011-01-12
User click “My dishes” on the main page to view the list of user’s saved dishes.
News Registration/Unsubscribe for Restaurant Type
1.
User chooses type of restaurants on the main page and click “Subscribe” to register news.
Then, if news of this type of restaurant updated, user will receive its news by clicking
“SUBSCRIPTIONS” on the main page.
Page 14
Search4Yummy
User Manual
2.
Version:
1.0
Date: 2011-01-12
User chooses restaurant type that he wants unsubscribe. After that, if news of this type of
restaurant updated, user will not receive any of its news.
3.2
Web application for Restaurant Staff
3.2.1
Restaurant Staff Login/Logout
3.
3.2.2
It’s similar with User Login/Logout, just input related restaurant’s username and password.
Setup a New Restaurant
1. Click “EDIT RESTAURANT” on the main page, and then click “Create New”.
Page 15
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
2.
Naming this new restaurant by clicking “Click here to add text”.
3.
Click “+ More settings” Input Restaurant information, including Name, Address, City, Seat
Availability, Seat Capability, etc. Then “save”.
Page 16
Search4Yummy
User Manual
4.
3.2.3
Version:
1.0
Date: 2011-01-12
Restaurant staff can add images for this restaurant by clicking “Images”. And select images
then “Submit”
Modify/Delete a Restaurant
1. In the “EDIT RESTAURANT” page, restaurant staff can edit this restaurant information. Then
“Save” the modification.
Page 17
Search4Yummy
User Manual
2.
3.2.4
Version:
1.0
Date: 2011-01-12
Restaurant staff also could delete this restaurant information by clicking “Delete”, and click
“YES DELETE” to confirm deletion or click “Cancel” to cancel this action.
Add/Delete/Modify Menu for a Restaurant
1. Restaurant staff click “Menus” on the “EDIT RESTAURANT” page, And “Create new”
2.
Add related information, if this restaurant already setup dishes, you could move related dishes
in the “Dished to select” to the right blank “Dishes in menu”. And “Save”.
Page 18
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
3.
Restaurant staff can add image for this menu after setup by clicking “Images”.
4.
Restaurant staff can delete this menu by clicking “Delete”.
5.
Restaurant staff can edit this menu that is similar with setup a new one by clicking “Edit”.
Page 19
Search4Yummy
User Manual
3.2.5
Version:
1.0
Date: 2011-01-12
Add/Delete/Modify Dish for a Restaurant
1. Restaurant staff clicks “Dishes” on the “EDIT RESTAURANT” page, And “Create new”.
2.
Add the information and “Save”.
Page 20
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
3.
Restaurant staff can add image for this dish after setup by clicking “Images”.
4.
Restaurant staff can delete this dish by clicking “Delete”.
5.
Restaurant staff can edit this dish that is similar with setup a new one by clicking “Edit”.
Page 21
Search4Yummy
User Manual
3.2.6
Version:
1.0
Date: 2011-01-12
Add/Delete/Modify News for a Restaurant
1. Action to about “Add/Delete/Modify News for a Restaurant” is similar with
“Add/Delete/Modify Dish for a Restaurant”. Staff member enters new news about its
restaurant.
Page 22
Search4Yummy
User Manual
2.
Version:
1.0
Date: 2011-01-12
System confirms that news was successfully added.
3.3
Web application for Admin
3.3.1
Administrator Login/Logout
1.
It’s similar with User Login/Logout, just input Administrator’s username and password. Click
“Admin” on the main page.
Page 23
Search4Yummy
User Manual
3.3.2
Version:
1.0
Date: 2011-01-12
Add/Delete/Modify Customer
1. Administrator clicks “Customers” on the “Admin area” page, input customer’s information in
the right part of page. Make sure to check “Email confirmed”, Then “Save”. A new user will
be setup right away.
Page 24
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
2.
Administrator can delete this Customer by uncheck “Email confirmed”, and then this
customer couldn’t logon by this user name.
3.
Administrator can edit this Customer‘s information by selecting customer listed in the form of
“Customers users”. Then Administrator can modify and save his information in the below
“Update” part.
Page 25
Search4Yummy
User Manual
3.3.3
Version:
1.0
Date: 2011-01-12
Add/Delete/Modify Restaurant Staff
1. Administrator clicks “Staff” on the “Admin area” page, input customer’s information in the
right part of page. Make sure to check “Email confirmed”, Then “Save”. A new user will be
setup right away.
Page 26
Search4Yummy
User Manual
3.3.4
Version:
1.0
Date: 2011-01-12
2.
Administrator can delete this Staff by uncheck “Email confirmed”, and then this Staff couldn’t
logon by this user name.
3.
Administrator can edit this Staff‘s information by selecting Staff listed in the form of “Staff
users”. Then Administrator can modify and save his information in the below “Update” part.
Add/Modify Restaurant Types
1. Administrator clicks “Restaurant types” on the “Admin area” page, input restaurant type’s
information in the right part of page, then “Save”. Then the new restaurant type is listed in the
form of “Restaurant types” in right part of page.
Page 27
Search4Yummy
User Manual
2.
Version:
1.0
Date: 2011-01-12
Administrator can edit this Restaurant type’s information by selecting Staff listed in the form
of “Restaurant types”. Then Administrator can modify and save its information in the below
“Update” part.
Page 28
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
Page 29
Search4Yummy
User Manual
4.
Version:
1.0
Date: 2011-01-12
Mobile Application
The mobile application is designed only for customers. The functionalities are very similar to the
customer web application in that the user can log in, grade dishes and restaurants and comment.
4.1
Home screen (Guest)
This is the home screen the user sees if he is not logged in.
4.2
User registration
1.
User clicks on the Registration button
2.
User fills the required fields in the registration form
Page 30
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
3.
If the data that was input is correct the system reports that an activation mail has been sent to
the provided e-mail address.
4.3
User login
1.
User clicks on the Login button.
2.
User enters his username and password and has the option of checking the Remember me box
so he will be automatically logged in the next time he starts the application.
3.
If the login is successful the system will redirect to the user home screen where the
Registration button has been replaced with the My Profile button and the Login button is replaced for
the Logout button.
Page 31
Search4Yummy
User Manual
4.4
Version:
1.0
Date: 2011-01-12
Search 4 restaurant
1.
User clicks on the Restaurants button
2.
User inputs search parameters in the search form.
3.
4.
The system gives the user a list of restaurants that match the search criteria.
The user can select one of the restaurants for a more detailed description of the restaurant.
Page 32
Search4Yummy
User Manual
4.5
Version:
1.0
Date: 2011-01-12
Restaurant details
1.
The user is presented with basic information about the restaurant. He can check into the
restaurant, grade it and subscribe to it. To move to other pages the user needs to swipe his finger over
the screen.
2.
The Restaurant dishes page shows all dishes available in the selected restaurant and the
Restaurant menu shows all available menus.
Page 33
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
3.
Map shows the location of the restaurant on Google Maps.
4.
Gallery displays all pictures pertaining to the restaurant
Page 34
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
5.
Comments page gives the user all comments from other users and allows him to leave his own
comment as well as grade other comments.
4.6
Search 4 dish
1.
User clicks on the Dishes button.
2.
User enters the desired search parameters.
3.
The system displays a list of dishes matching the given criteria, similar to the one in the
restaurant details part.
Page 35
Search4Yummy
User Manual
4.7
Version:
1.0
Date: 2011-01-12
Dish details
1.
In the Dish details page the user can see additional information regarding the dish, can vote on
the dish, add it to his wish list and view the restaurant details that offers this dish. To view other pages
the user must swipe with his finger.
2.
Description gives a detailed description of the dish
3.
In the Comments page the user can see other comments as well as give his own comment and
grade other comments.
Page 36
Search4Yummy
User Manual
4.
4.8
Version:
1.0
Date: 2011-01-12
Gallery shows the user pictures of the selected dish.
My Stuff page
1.
The user clicks on the My Stuff button to go to the My Stuff page. There he can view his wish
list, subscriptions and news.
2.
Dish wish list is a list of dishes the user has added and he can view details or remove them
from the wish list.
3.
Subscription page shows all the restaurants that the user is subscribed to and the user can
unsubscribe from a restaurant on this page.
Page 37
Search4Yummy
User Manual
Version:
1.0
Date: 2011-01-12
4.
The News page shows a list of news from restaurants the user is subscribed to. By clicking on
a certain headline the user can view the news details.
4.9
My Profile page
1.
The user clicks on the My profile button.
2.
The user is given his profile details which he can edit.
3.
By clicking Save Changes the user saves any changes made to his profile.
4.10
Uploading a picture
To upload a picture the user must click on the button in the restaurant details page. Afterwards the user
will be redirected to the camera. When the user takes a picture the system will ask if he wishes to
upload the picture. For the picture to be added to the restaurant gallery a staff member must first add it.
4.11
Log out
To log out the user simply clicks on the Logout button and confirms he wants to log out.
Page 38