DETAILED FUNCTIONAL DOCUMENTATION · It is to represent the identity of Spetco as specialized...
Transcript of DETAILED FUNCTIONAL DOCUMENTATION · It is to represent the identity of Spetco as specialized...
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 1
AL SAYER
RESPONSIVE CORPORATE WEBSITE WITH CMS
DETAILED FUNCTIONAL DOCUMENTATION
Version 1.0
09/10/2017
PREPARED BY:
FISAL HASSAN
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 2
VERSION HISTORY
Version #
Implemented
By
Revision
Date
Approved
By
Approval
Date
Reason
1.0 Fisal Hassan 09/10/2017 Initial Documentation
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 3
TABLE OF CONTENTS
1. INTRODUCTION................................................................................................................ 4
Purpose of The detailed Specification Document .............................................................. 4
PROJECT OVERVIEW ........................................................................................................... 4
2. SCOPE OF WORK.............................................................................................................. 5
3. WEBSITE STRUCTURE ................................................................................................... 5
4. WEBSITE STRUCTURE IN DETAIL .............................................................................. 6
5. COMMON FUNCTIONALITIES ................................................................................... 50
5.1 Email Notification ...................................................................................................... 50
5.2 Language ..................................................................................................................... 51
6. PROJECT DOCUMENTATION APPROVAL .............................................................. 52
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 4
1. Introduction
PURPOSE OF THE DETAILED SPECIFICATION DOCUMENT
This document provides a comprehensive and detailed architectural overview of the system design in order to give the development team guidance on architecture of the system to be developed. Its intended audience is the Business Sponsors, Project manager, project team and development team. Some portions of this document such as the user interface (UI) may on occasion be shared with the client/user, and other stakeholder whose input/approval into the UI is needed.
PROJECT OVERVIEW
Project title
Al Sayer – Responsive Corporate Website with CMS
Terminology
MAWAQAA – National Web Solutions Company
UI/GUI – User Interface/Graphical User Interface. Portion of the product where the
user sees and interacts with.
UX – User Experience
QA – Quality Assurance. A planned and systematic process necessary to provide
adequate confidence that the product optimally fulfills customer expectations
Admin – Administrator/Administrator Section
Project Owner – Mawaqaa Client or an authorized representative
Development Change – Not Covered under Current Scope
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 5
2. Scope Of Work
The Scope of work is to develop a responsive corporate website according to new design trends. It is to represent the identity of Spetco as specialized Kuwait Company in petroleum industry.It will be bilingual in both Arabic and English and it will be supported by a CMS for easier administration purposes.
3. Website Structure The following listed are the approved components for website structure for Al Sayer.
Main menu will be consist of the following:
1. Home
2. About us
Brief information about the company History, Strategy, CEO Message and
Management. The pages will be created based on size of information will be given by client
for this section
3. Brand Franchisee (All 4 Franchisee with different theme)
3.1 Caribou Coffee
3.1.1 About Caribou Coffee
3.1.2 Our Menu // showing Menu for Caribou coffee and with Menu of Delivery
Service
3.2 Five Guys
3.2.1 Our Menu
3.3 The Dream Factory // new theme which include about Dream Factory and Menu
4. Media Room
4.1 Events & News
4.2 Photo Gallery
4.3 FAQ // the FAQ will be for the Whole AlSayer Franchising and related Franchisee
5. Careers
5.1 Our Team
5.2 Our Culture
5.3 Available Job (need to choose brands Franchisee to apply job)
5.4 Application Form
6. Contact us
6.1 Contact us Form and location map
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 6
Footer Links:
1. Quick Links:
a. About Us
b. Brand Franchisee
c. Career
d. Media Room
e. FAQ
f. Contact Us
2. Privacy Policy
3. Site-map
Header Fixed Component:
1- AlSayer Logo
2- Menu
3- Website Search
4- Language switcher (Arabic / English/ and Turkey )
5- Linked-In Icon
Body Component:
1- The component in the web page body will be changed based on the information
for each page that will be given by client and suggested by Mawaqaa
2- The franchisee sections will have different theme colour and using the same page
layout of AlSayer Franchising Company.
Footer Fixed Component:
1- Quick links
2- AlSayer Contact information
3- Copyright information
4. Website Structure In Detail
1. Home
Home page will be the landing page for the AlSayer website. By default the landing
page will be in English version.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 7
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 8
Home Sliding Banner
The home sliding banner can be managed from admin panel.
All the inner page will have a non sliding banner instead of sliding banner, which should be managed
from page level set up.
Welcome Content
The welcome content also can be managed from admin panel.This section includes the below
Welcome Title
Welcome Message
Counters
The Counters can be managed from admin panel.
About Info Section
The about info can be managed from admin panel.This section includes the below
About Title
About Message
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 9
Our Strategy / History / CEO Message
These sections can be managed from admin panel. This section includes the below
Our Strategy
Our Strategy content can be managed from the admin panel. This section includes the
below fields
Title
Descriptions
History
This content can be managed from the admin panel. This section includes the below
Image
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 10
Title
Descriptions
Sort Order
The view all history link will be linked to details page.
CEO’s Message
This content can be managed from the admin panel. This section includes the below
fields
Title
Descriptions
Our Franchisee
This content can be managed from the admin panel. This section includes the below
fields
Image
Title
Descriptions
Sort Order
Social media icons
The read more link will be linked to the corresponding its page which is already mentioned
in main menu.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 11
Events & News
This will be showing about latest news and events . This content can be managed from
the admin panel. This section includes the below
Title
Date
Descriptions
Image
Sort Order
The read more link will be linked to the corresponding its details page which is already
mentioned in main menu.
Home FAQ & Location Map
Using the location map, the website’s users can search by the following terms: Brand Franchisee Country Area
The FAQ will be for the Whole AlSayer Franchising and related Franchisee. It contains
questions & answers. This section can be managed by admin panel and includes the below:
Title
Descriptions
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 12
2. About us
A Brief information about the company History, Strategy, CEO Message and
Management will be displayed here. The pages will be created based on size of information
received. This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Video & Images Screen shot will be here
The header and footer area will be same as in other pages. A non sliding banner instead of
sliding banner, which should be managed from page level set up.
3. Brand Franchisee (All 3 Franchisee with different theme)
The Brand Franchisee content can be managed from the admin panel.By default this
will be linked to Caribou Coffee page.
3.1 Caribou Coffee
The header and footer area will be same as in other pages.A sliding banner, which should be
managed from admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 13
There will be a separate sliding banner for this page and about us page.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 14
Below the banner, there will be a summary about Caribou Coffee, the detailed information
will be shown in a separate page.
The read more will be linked to about us page. All the coffees will be shown in a sliding
manner as like below.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 15
Below the coffee list, there will be a menu link as like below, which will be linked to Our Menu
page.
There will be a single video about Core Competencies as like below
On clicking it will play in a pop up.The video can be managed from admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 16
5 REASONS WHY RAINFOREST ALLIANCE CERTIFICATION IS BIG DEAL
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
The Caribou Coffee Quality Advantage
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 17
The Shop’s social media (Facebook, Twitter, Instagram and YouTube) presence will be
displayed, so the social media integration should be done using corresponding APIs.
As usual, the footer will be same as other pages.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 18
3.1.2 Our Menu
This will be showing the list of menu for Caribou coffee and with Menu of Delivery
Service. This content can be managed from the admin panel.
The banner image will be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 19
Classics
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 20
Signature
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image Blended
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 21
Food
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
The user can download the full menu of three countries
The countries and the menu link can be managed from the admin panel. This section includes
the below
Country Icon
Menu link - Download link for full menu
Display Order
‘Our delivery service available only in kuwait’ area can be managed from admin panel.
3.2 Five Guys
The header and footer area will be same as in other pages.A sliding banner, which should
be managed from admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 22
There will be a separate sliding banner for this page and it can be managed from admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 23
Below the banner, there will be a ‘Most popular Section’, the most popular item will be
displayed here.
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Below the Most pupular Section’, there will be a ‘Why to choose five guys burger’ section.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 24
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Background Image
This content can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
Background Image
The view full Menu link will be linked to Our Menu Page.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 25
The Shop’s social media (Facebook, Twitter, Instagram and YouTube) presence will be
displayed, so the social media integration should be done using corresponding APIs.
The Five Guys Fanatics can be managed from the admin panel. This section includes the below
Title
Descriptions
Image
As usual the footer will be same as other pages.
3.2.1 Our Menu
This will be showing the list of menu for Five Guys Restaurant . This content can be
managed from the admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 26
The banner image will be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 27
The menu section can be managed from the admin panel.
This section includes the below
Title
Descriptions
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 28
User can download nutrition and the allergen information as pdf file.
As usual the footer will be same as other pages.
4. Media Room
The latest news, events, photo gallery and FAQs are categorized under media room.
The Media content can be managed from the admin panel.
Based on the link clicked, corresponding list will be loaded
4.1 Events & News
This will be showing about latest news and events . This content can be managed from
the admin panel. This section includes the below
Title
Date
Descriptions
Image
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 29
The description in the list should be limited to a fixed length.The view more link will load
more news in the page.The read more link of the news will open its corresponding details
page.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 30
User can share any page with social media using share link at the bottom. The header and
footer area will be same as in other pages.A non sliding banner instead of sliding banner,
which should be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 31
4.2 Photo Gallery
This will be showing all photos related with specific events and news. This content can
be managed from the admin panel.
The photo gallery is as the order below.
Photo gallery Category -> Photo gallery images -> Full view of images
Each this section includes the below
Title
Date
Image
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 32
The view album link will load all the album images in another page as like below.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 33
By clicking on the image,user can see all the zoomed images of the album with sliding as like
below.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 34
The view more link will load gallery in the same page.The header and footer area will be
same as in other pages.A non sliding banner instead of sliding banner, which should be
managed from page level set up.
4.3 FAQ (Frequently Asked Questions)
The FAQ will be for the Whole AlSayer Franchising and related Franchisee.It contains
questions & answers.This section can be managed by admin panel.This section includes the
below
Title
Descriptions
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 35
The header and footer area will be same as in other pages.A non sliding banner instead of
sliding banner, which should be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 36
5. Careers
The career page can be managed by administrator. The header and footer area will be same
as in other pages.A non sliding banner instead of sliding banner, which should be managed
from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 37
The career message can be managed from administrator.
5.1 Our Team
This will be showing all the team members. This content can be managed from the
admin panel. This section includes the below
Title
Image
Description
Position
Sort Order
5.2 Our Culture
This will be showing about Company’s culture and purpose, vision, mission and values,
and framework and guidance.This content can be managed from the admin panel. This
section includes the below
Image
Title
Description
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 38
The user can apply for a job or can check available vacancies by selecting the company.
In the above screen, Apply for a job link will be linked to job application form. The available
vacancies link will be linked to job vacancies page.
5.3 Available Job
This will be showing all the available Jobs. This content can be managed from the
admin panel. This section includes the below
Job Title
Descriptions
Position
Company
Date
Sort Order
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 39
The view more link will load more jobs in the same page.The header and footer area will be
same as in other pages.A non sliding banner instead of sliding banner, which should be
managed from page level set up.
There are two buttons, one for viewing the details of the job, and other for applying for that
job.The user can apply for the job from the job detail page also.
The job detail page will be as below.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 40
User need to choose brands Franchisee to apply job.
5.4 Application Form
The user can apply for a job. Email will be sent to both admin and user.The application
can be also viewed in admin panel.The job application form includes the below fields.
First Name
Last Name
Email Address
Contact Tel
Interested Job Position
Upload Your CV - pdf or Doc format file
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 41
6. Contact us
6.1 Contact us Form and location map
Contact Us Form
Users will be able to fill-up his information in the fields such as : Name Email address Phone(Land line) Mobile Company Name Send To (All Franchisee will be listed here, he list can be managed from
the admin panel) Message
Then they press submit button to email and CMS(Data will be saved in the CMS.)
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 42
Location Map
The website’s users can search by the following terms: Brand Franchisee Country Area
The Head office address will be shown on the opposite side of the map.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 43
The header and footer area will be same as in other pages. A non sliding banner instead of
sliding banner, which should be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 44
Footer Links:
1. Quick Links:
a. About Us - This link will be linked to About us page.
b. Brand Franchisee - This link will be linked to Brand Franchisee page.
c. Career - This link will be linked to our team under the Career page.
d. Media Room - This link will be linked to events & news under the Media Room
page.
e. FAQ - This link will be linked to FAQ page under the Media Room page.
f. Contact Us - This link will be linked to Contact us page.
2. Privacy Policy
This page will have the privacy policy details of AlSayer website. There will be the
following details in the page
Title
Privacy policy details
The title and privacy policy details of the page can be managed from the admin panel by the
AlSayer Admin.
The header and footer area will be same as in other pages.A non sliding banner instead of
sliding banner, which should be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 45
3. Site map
It will list the pages on the website, typically organized in hierarchical fashion.The visibility
of the data can be managed from the admin panel.
The header and footer area will be same as in other pages.A non sliding banner instead of
sliding banner, which should be managed from page level set up.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 46
Header Fixed Component:
The header contains logo on left corner, main menu,search area, social media icon
and the language switcher on the right corner.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 47
1- AlSayer Logo
The AlSayer Logo will be on the left corner. The logo will be linked with the home
page of the website English/Arabic.
2- Menu
The main menu of the site,the name, display order and the visibility can be managed
from the admin panel.
3- Website Search
User can search website by typing keywords, the system will list matching search
result.
From the search results, the user can do the following:
Can search with new keywords
Can filter again with any search words, all search words or exact match
Can manage paging
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 48
4- Language switcher (Arabic / English/ and Turkey )
The can view the website in three different languages by using Language switcher.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 49
5- Linked In Icon
This icon and its link can be managed from the admin panel.
Footer Fixed Component:
The footer area fully can be managed from admin panel.
1- Quick links
The visibility of the quick links can be managed from admin panel.
2- AlSayer Contact information
The quick contact info can be managed from admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 50
3- Copyright information
The Copyright information can be managed from admin panel.
5. COMMON FUNCTIONALITIES
The following are the common functionalities or the AlSayer website
5.1 EMAIL NOTIFICATION
There will be email notifications from the system on user registration.
These email notifications will be in an email template that is matching with
the AlSayer website theme.
Email notifications will be sent using AlSayer SMTP, and so AlSayer will
provide their SMTP details during development phase.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 51
5.2 LANGUAGE
AlSayer website and customer profile pages will be in both English and
Arabic.
Administration sections will be only in English
Admin will have the option to manage the English & Arabic contents of pages
and areas details from the admin panel.
Mawaqaa. Tel: +965 22250008 Fax: +965 22970344 Page 52
6. Project Documentation Approval The undersigned acknowledge they have reviewed the AlSayer Functional Documentation document
and agree with the approach it presents. Any changes to this Requirements Definition will be
coordinated with and approved by the undersigned or their designated representatives.
Signature: Date:
Name:
Title:
Role:
Signature: Date:
Name:
Title:
Role: