Functional Specification Document

For

Project Name
Version 1.0
Prepared by

Differentiator Technologies
5th Sep15

Submitted to

Mr. Ramraj Pandey

Revision History
Page | 1

Versio
n
1.0

Date
7th Sep15

Author(s)
Manohar

Reviewer(s
)
Ramraj

Change Description
-

Point of Contact
Page | 2

No.
1
2
3
4

Department
Project Manager
Team Lead
Designer
Developer

Name
Shailendra Jadhav
Manohar Khokle
Pradip Misal
Swapnil Akolkar/Ajinkya Naik

Table of Content
1

Introduction......................................................................................................

Page | 3

Scope of Work..................................................................................................
2.1

Users..........................................................................................................

2.2

Website functionality..................................................................................

2.2.1 Navigation Menu (The same for all the pages)........................................

2.2.2 Home Page..............................................................................................
2.2.3 Registration Page/Process.......................................................................
2.2.4 Login Page...............................................................................................
2.2.5 Forgot Password Page............................................................................10
2.2.6 Reset Password Page.............................................................................10
2.2.7 Project Listing Page...............................................................................10
2.2.8 Project Detail Page................................................................................10
2.2.9 Forum Page...........................................................................................11
2.2.10..............................................................................................Chat Module
11
2.2.11.......................................................................................Contact Us Page
11
2.2.12..............................................................................................Static Pages
12
2.3

User Functionality.....................................................................................12

2.3.1 Visitor....................................................................................................12
2.3.2 Student functionally..............................................................................12
2.3.2.1

Activate Email/Mobile Number...................................................................12

2.3.2.2

Manage Profile........................................................................................... 13

2.3.2.3

Search For Projects.................................................................................... 13

2.3.2.4

Request A Project....................................................................................... 13

2.3.2.5

Review Project........................................................................................... 13

2.3.2.6

Post Feedback About Project......................................................................14

2.3.2.7

Forum Functionality................................................................................... 14

2.3.2.8

Chat Functionality...................................................................................... 14

2.3.3 Industrial Sponsors and Institutions functionality..................................14

2.3.3.1

Manage profile........................................................................................... 14

2.3.3.2

Create Project............................................................................................ 14

2.3.3.3

Edit Project................................................................................................. 16

Page | 4

2.3.3.4

Manage Projects......................................................................................... 17

2.3.3.5

Review Project........................................................................................... 17

2.3.3.6

Generate Reports....................................................................................... 17

2.3.3.7

Post Feedback About Student....................................................................18

2.3.3.8

Forum Functionality................................................................................... 18

2.3.3.9

Chat Functionality...................................................................................... 18

2.3.4 Expert Advisors Functionally.................................................................18

2.3.4.1

Activate Email/Mobile Number...................................................................18

2.3.4.2

Manage Profile............................................................................................... 18

2.3.5 Administrators Functionally...................................................................19

2.3.5.1

Manage static pages........................................................................................ 19

2.3.5.2

Manage Users................................................................................................ 19

2.3.5.3

Manage Projects............................................................................................. 19

2.3.5.4

Generate Reports....................................................................................... 20

2.3.5.5

Manage Homepage Slider..........................................................................20

2.3.5.6

Manage Contact Us Requests....................................................................20

2.3.5.7

Forum Functionality................................................................................... 20

2.3.5.8

Chat Functionality...................................................................................... 21

2.5

Development Technology.........................................................................21

STEPS FOLLOWED WHILE DEVELOPING THE WEBSITE......................................................22

FEES AND EXPENSES......................................................................................23

3.1

Time estimate..........................................................................................23

3.2

Cost Estimates.........................................................................................23

Page | 5

1.Introduction
Mr. Ramraj Pandey (Clients) want to create a where college or industrial
sponsors can post their academic projects online and the other sides of user will
request to allocate that project to them.

1.1.

Purpose

Purpose of this document is to define the scope of the project.

Project Name website will be developed with the help of PHP & MySQL. This
document will contain all detailed technical functionalities and layout designs
(wireframes) which will be developed in the Project.

1.2.

Intended Audience

Differentiator Technologies has created the FSD document for the client: Mr.
Ramraj Pandey on Project Name project.
This document will serve as a benchmark document for the project requirements
and quality measurements for the technical & Quality Assurance team.

Page | 6

2.Scope of Work
Mr. Ramraj Pandey (Clients) wants to develop a website where college or
industrial sponsors can post their academic projects online and the other sides of
user will request to allocate that project to them. Site will allow student,
institutions, industrial sponsors and expert advisors to register themselves on the
site. Here Institutions and industrial sponsor will have the ability to post their
project on the site.
Once project is posted it will be reviewed by the administrator and open to
all. On the other hand student or guest user will visit the site and will have the
ability to search the projects by category or some of the filters (will be mentioned
below). And then they can visit any of the projects detail page. Once they gone
through the requirement then they can request for the allocation.
Project creator will have all the requests by the different users, then he/she
can select any of the student or group of the student or may select multiple
student to allocate their project. While creation of the project there will be certain
criteria are defined like milestones (depiected in detail below), so for the
completion of the project student needs to fulfill all those milestones defined by
the creator of the project. After completion of the all the milestone in the project
the project will be consider as completed, and then both sides of the parties can
leave their reviews about each other.

2.1 Users
The portal will have the following user categories:
1) Casual Visitor Is a general visitor who is simply visiting the portal on
internet. Everything marked and intended for public reading is visible to such
users.
2) Registered User (student) who can register via student registration link
where he can have the opportunity to register as individual or register as
team or group.
3) Registered User (Institution) Who can register via college registration
link where a Institution representative can register by providing institutions
details.

Page | 7

4) Registered User (Industrial Sponsor) Who can register via industrial

sponsors registration link where he will provide some basic information
(parameters yet to be decided).
5) Registered User (Expert Advisors) Can advise and help in resolving
technical issues/questions.
6) Administrator This is the super user of all users this user will have control
over all of the other users and every functional aspect of the website.

2.2 Website functionality

The following is a list of functionalities for the website with their detail:

2.2.1

Navigation Menu (The same for all the pages)

Header

Logo it will be provided by the client

Sign-in
o Forgot password
Register

Navigation bar

Courses - Submenu for courses available

Certificates - Submenu for courses available
Search
My account
o My courses - Current and past courses with a grade history
o Account settings - besides email and password info, student
should be able to update personal info, ex: address, phone
number, etc.

Footer

About us
How it works
FAQs
Privacy policy
Terms and conditions

Page | 8

Social media integration

2.2.2 Home Page

The home page will consist of a welcome message to the user. The home
page will also consist of an image slider. On the image slider there will be
changing images at a particular a time span. There will be quick links for different
registration/login portal like student, institution etc. There will be placeholder to
show latest 10 (or so) open projects and basic search functionality for the user,
where user can search it by project name.

2.2.3 Registration page/Process

This can be one simple page where all type of users can register and select
their user type. Following fields will be required for all type of usersFollowing are common fields for the Institutions, industrial sponsors and
expert advisors and students
Field Name

Field Type

Description/Comment

User name
First Name
Last name
Institute/Company name
Address
Full
City/Zip
Country
Mobile number
Date of birth
Telephone

Textbox
Textbox
Textbox
Textbox
Textarea
Textbox
Dropdown
Textbox
Datepicker
Textbox

User
User
User
User
User
User
User
User
User
User

will enter desire user name

will enter first name (required)
enters last name (required)
will enter their company or institutes name (optional)
will enter full mailing address (required)
will enter city and zip code (required)
will select country from drop down (required)
will enter mobile number (required)
will select date of birth from the date picker (required)
will enter telephone number (optional)

Student will have following additional fields while registration

Field Name

Field Type

Description/Comment

Course name

Textbox/Dor

User will enter course name (required)

Course year
Course batch start year

pdown
Dropdown
Dropdown

User will select course year from drop down

User will select course start year from drop down

By providing the above details user will register to the system as per role.
After registration user will get an email which will consist of two links one for email
verification and another for the mobile phone verification.
An verification code will be sent to the registered mobile, on clicking the
verify mobile number link in email user just need to enter the code received on
registered mobile and need to activate his/her account. After activating it user will
be able to login to the system

Page | 9

2.2.4 Login page:

There will be different login portal for each user like student, institutions,
industrial sponsors and expert adviser. There will be login form where they will
enter their username/email address and password. There will be forgot password
and reset password link on every set of page.

2.2.5 Forgot password page:

This page will contain a form with email field, here user have to provide
email address to be received the password for the user. After entering the email
user will get notified with email with his/her login password.

2.2.6 Reset password page:

This page will only be accessible after login to each of the users. Where this
page contain form with the two fields which will be old password and new
password. After submitting the button that user will be get logged out and
redirected to the login page to re login to the system.

2.2.7 Project listing page:

This page will have lists of all projects submitted by students, expert advisors,
college and industrial sponsors and approved by administrator. This page will have
opportunity of advance search by category or some of the filters (yet to be
defined). Student user can easily search for the projects and click on the view
detail link to request the individual project.
Every project will have an associated technology area (Like VLSI, Automotive
engineering, Electronics Engineering etc). Visitors should be also able to
browse/filter through such technology areas.
Also, some of the industrial projects marked as "private" can only be visible to
the respective project members. The project will be hidden from everyone else.
The list should have columns like- Name, Technology Area, Company name (If
sponsored by a company) , Institution name if already assigned to a specific group
of students, and 1st 10 words of the project description.

2.2.8 Project detail page:

This page will have all the project detail where end user can view and read all
the project requirement and then he can request for the allocation, after he clicks
for the allocate, the notification will sent to the administrator as well as the project
Page | 10

creator. If project creator likes the student profile then can select or allocate this
project to that student or group of students.
This page will also have all the project documents listed, so that students can
read more about the project. This page also lists a high level work-break-down
structure of the project including the milestones with timelines. Every milestone
also indicates the required deliverable to complete the milestone.

2.2.9 Forum page:

This will simple forum page accessible by the every registered users to post
topics and discussion. The forum page will be accessible from the project detail
page, and the linked page will have discussions about that project only. This page
will have the ability to search forum topics or search by project.
Visitors should be able to bookmark a forum and go too directly to the
forum, without navigating through the project search and detail pages.
Since there will be lot of discussions on technology subjects, some kind of
formula editor, drawing tool, and file upload functionalities are needed in the
forum post.

2.2.10 Chat module integration:

Online project members in a project group (Including any industrial expert,
expert advisor associated with the project etc) can get into a secure instant
messaging session.
The chat option will be available on the website. For the chat the cometchat
will be used. The functionality of the comet chat will depend on the version bought
by the client. No customization will be done in the CometChat. The module of the
CometChat will be only integrated with the system as it is.

2.2.11 Contact us page

The contact us page consists of the following fieldsField Name

Field Type

Description/Comment

Name
Email
Phone number

Text Box
Text Box
Text Box

User will enter the name

User will enter the email address
User will enter the phone number

Country
Message

Text Box
Text Box

User will enter the related order

User will enter the message

CAPTCHA code

Text Box

Code generated to be entered at the time of registration

Page | 11

Once the contact us form is submitted, there will be a pop up saying Thank
you message and admin will be notified through an email.
Note: The admin will be able to add/edit/delete all the information on the
contact us page.

2.2.12 Static pages

There will be different static pages on the site for the user such asField Name

Field Type

Description/Comment

About us

Link

User will be redirected to the all information regarding the website

How it works

Link

User will be redirected to the how it works page

FAQ
Privacy Policy

Link
Link

User will be redirected to the FAQ page

User will be redirected to the privacy policy page of the website

Terms
and
conditions

Link

User will be redirected to the terms and condition page of the

website.

Note: Please provide the list of the pages which you want to be manageable
by admin.

2.3 Users Functionality

2.3.1 Visitors functionality
The visitor is the one who only visits the websites and do not register on the
website. The visitor will be able to perform the following actions on the website.
This user will be able to browse to all public pages on the website. This user will be
able to contact to the admin via contact us page. This user can also have the
access to the registration page where this user can register him on the site.

2.3.2 Student functionally

Activate email/mobile number
After successful registration student will get notified by an email with the
activation link and SMS on his registered mobile number with unique activation
code. User will have to verify his email by clicking the verification link. Then user
needs to go the visit the mobile verification link where user needs to enter
activation code which he received on registered mobile number.

Page | 12

Manage profile
Students will be able to manage their profiles. They will be able to edit the
following information.
First name
Last name
Institute / Company name
Date of birth
Address
Street name
City
Country
o Mobile number
o Email address
o Telephone number
o
o
o
o
o

Search for the projects

Student will be able to search for the project, for searching the project
student can search it on the home page or they can visit the separate project
listing page where they can find the advance search option to find the best
suitable project matching their profile.
Request for a project
After searching the project student can view the project by clicking one of
the projects. It will be redirect that users to the project detail page, here user will
see all the requirement of the client and can review the entire documents posted
by client if any. If user seems it suitable project for himself then he can ask for
allocating the project by clicking allocate me button.
Review project
This will be project detail page where student can review all the milestones
set up by the project creator. User will be also able to see all the issues or error log
Page | 13

posted by the creator on the top right corner. Student can ask for milestone
completion for that he will select the milestone from the list and put his comment
about how he completed that milestone. Also he can reply to the error list (posted
by creator) after he resolve those issues or errors.

Post feedback about project

This functionality is only available after all the milestone is completed by the
project creator. Where user will add his feedback about the project and the project
creator with rating of poor will be 1 and 5 will be excellent kind.
Forum functionality
This is the place where user can jump on by clicking on the projects forum
button to post his thoughts about the project on the public forum. On the forum
page student will be able to open or create new topic and post the comment on
that. Student can also post the comment on the topics created by other users.
Chat functionality
This is general website functionality where student can find the all logged in
users on the commet chat module. So he can chat with any of the registered user
on the site which include administrator, industrial sponsors, institutions and expert
advisors.

2.3.3 Industrial Sponsors and Institutions functionality

Manage profile
Industrial Sponsor and college/institutions can edit following fields

First name
Last name
Institute / Company name
Address
o Street name
o City
o Country
Mobile number
Email address
Page | 14

Telephone number

Create Project
Industrial sponsor will be able to create new project where he can enter the
following information while creating the project. And after creation of the project it
will be sent to the Administrator for review. After admin review it, admin will
decide to make it Active or declined the same will be notified with an email to the
Industrial sponsor.

Property

Count

Description

Words

Problem Statement

Core idea and the value proposition of this project.

25 < words < 150

Short Name

Short and popular name for the project.

1 < Words < 2

Long Name

Optional long name for the project

1 < words < 5

Description

Description of the project including expected

results, success criteria, research requirements,
previous findings, design guideline, technology
selection, timeline discussion etc.

100 < words < 1500

Identify important milestones that project will look

forward to monitor and review.

1 < words < 10

Imp Milestones

Pre-populated list
Project Start
Technology selected
Design Start
Design Complete
Development Start
Development Complete
Report complete
Project Close
Milestone completion
criteria

Description and deliverable associated with a

milestone to mark it as complete.

3 < words < 100

Timeline

Associated with each milestone, it indicates the

date by when the milestone is expected to
complete.

Date

Project Issues

Project Risks

The project creation will be divided into 4 steps. First step will contain
project long name, short name, description, creation date, problem statement and
attach documents (with certain allowed file types). Then it will jump to the next
Page | 15

step where user will add the milestones to it (Please mention what will be the
milestone form will contain?), it will consist of milestone name, milestone
completion criteria and timeline of the completion date so user can add n number
of milestone here by clicking add more button. Then user will jump to the third
step where they can insert the project issues if any or they can skip the step here
also user can add n number of issues by clicking add more button. Then user will
jump to the last step where user can add the projects risks if any this step also
can be skip by the user and this step also have the functionality to add more
button.

Edit Project
Industrial sponsors may edit those projects which project status is open. User
can edit the project in 4 different steps mentioned while create the page with the
following fields. After editing project, project is again being sent to the
administrator for review. After reviewing admin can change its status to decline or
approve.
Property

Count

Description

Words

Problem Statement

Core idea and the value proposition of this project.

25 < words < 150

Short Name

Short and popular name for the project.

1 < Words < 2

Long Name

Optional long name for the project

1 < words < 5

Description

Description of the project including expected

results, success criteria, research requirements,
previous findings, design guideline, technology
selection, timeline discussion etc.

100 < words < 1500

Imp Milestones

Identify important milestones that project will look

forward to monitor and review.

1 < words < 10

Pre-populated list
Project Start
Technology selected
Design Start
Design Complete
Development Start
Development Complete
Report complete
Project Close
Milestone completion
criteria

Description and deliverable associated with a

milestone to mark it as complete.

3 < words < 100

Timeline

Associated with each milestone, it indicates the

date by when the milestone is expected to

Date

Page | 16

complete.
Project Issues

Project Risks

Manage projects page

This page is only accessible to the industrial sponsors and institutions where
they can see list of all of their created projects, the list will titled Project
name, date created, admin status (initially active/pending/declined), project
status (Open/Allocated/Closed), Edit, View and Delete buttons.
After clicking the view button initially industrial sponsor will be able to view
all the requests of the users, and then they can view every users public
profile and decide whom to allocate the project.
Note: Please mention the flow of how it will work, after the project is
allocated to the any of the student what will be the possibilities of generating
the reprts
Review project
This will be project detail page where industrial sponsors can review all the
milestones requests and its statuses sponsor can approve or decline the milestone
request posted by the students. There will be place holder to place the project
errors and error logs (I am not sure about how will be posted will it be milestone
basis or project basis and what will be fields of parameters)
Generate Reports
An Industrial sponsor will have page which is only accessible to this user
where he can generate weekly, Bi-Weekly or monthly (As selected by the project
sponsor) project report needs to be published to all users associated with the
project. The detail should includeProject Name
Report Date
Page | 17

Project Schedule Indicator - Behind / Ahead of schedule by weeks/days

Project Status Index / scorecard
List of Milestones completed
Milestones statuses for each milestone - Behind / Ahead of schedule by
weeks/days
Work in progress
RoadblocksOther issuesNew Risks-

Post feedback about student

This functionality is only available after all the milestone is completed by the
sponsor. Where sponsor will add his feedback about the students work on the
project with rating of poor will be 1 and 5 will be excellent kind.
Forum functionality
This is the place where sponsor can jump on by clicking on the projects
forum button to post his thoughts about the project on the public forum. On the
forum page sponsor will be able to open or create new topic and post the
comment on that. Sponsor can also post the comment on the topics created by
other users.
Chat functionality
This is general website functionality where sponsor can find the all logged in
users on the commet chat module. So he can chat with any of the registered user
on the site which includes administrator, industrial sponsors, students and expert
advisors.

2.3.3 Expert Advisors functionality

Manage profile
Industrial sponsors can edit the following fields on their profile page.
o
o
o
o

First name
Last name
Institute / Company name
Date of birth

Page | 18

o Address
Street name
City
Country
o Mobile number
o Email address
o Telephone number

Note: Please mention all the other functionalities of this type of users

2.3.4 Administrators functionality

Manage static pages

Admin will be able to manage the static page on the site using the
WYSIWYG HTML text editor.
The static pages will be as follows:
o About us
o How it works
o FAQs
o Privacy policy
o Terms and conditions

Manage Users

Admin will be able to search / filter users list.

Admin will be able to Add / edit / delete a user accounts.

Manage Projects

Admin will see the placeholder where hell be able to see list of all
projects.
The list will show all the project is pending for review on top of all other
projects
The list will be labeled as project name, date created, creators name and
view detail
On the view detail there will be two button on the top and bottom i.e.
Approve and Decline
Page | 19

Admin can click any of the buttons as per his review and then the project
creator is notified by an email.

Generate Reports
An Industrial sponsor will have page which is only accessible to this user
where he can generate weekly, Bi-Weekly or monthly (As selected by the project
sponsor) project report needs to be published to all users associated with the
project. The detail should includeProject Name
Report Date
Project Schedule Indicator - Behind / Ahead of schedule by weeks/days
Project Status Index / scorecard
List of Milestones completed
Milestones statuses for each milestone - Behind / Ahead of schedule by
weeks/days
Work in progress
RoadblocksOther issuesNew Risks-

Home page slider management

Here admin will have the ability to make add, edit and delete the home page
slider images as per his preferences.

Page | 20

Manage contact us requests

Here admin will be able to view all the requests are made by the front users
through the contact us page.
Forum functionality
This is the place where admin can jump on by clicking on the projects forum
button to post his thoughts about the project on the public forum. On the forum
page admin will be able to open or create new topic and post the comment on
that. Admin can also post the comment on the topics created by other users.

Chat functionality
This is general website functionality where admin can find the all logged in
users on the commet chat module. So he can chat with any of the registered user
on the site which includes all type of users.
Note: Please mention all the other functionalities of this type of users

Development Technology
To match with the requirements of the business logic, the portal will be
developed using:

PHP Codeigniter
MySQL Database

Page | 21

STEPS FOLLOWED WHILE DEVELOPING THE

WEBSITE

3.2 Step 1 Analysis of the project

We will analyze all the functionality of the project and list it out in a Word
Document.
The FSD (Functional specification document) will include
1. Functional Specifications of the project: i.e. a detailed analysis of
the functionalities in the project.
2. Queries to client: Client needs to reply to these queries within 24
hours in order for us to incorporate it into the FSD.
3. Once the FSD is finalized (client approval) there will be no
changes in the functionality. Any changes outside of the FSD will
be treated as rework/ addition to the project and will be billed
separately.
4. Client should give the approval to the FSD before starting the
development milestone. It is of extreme importance that you
should have read the FSD in detail. Please note that any work
outside of that mentioned in the FSD will treated as rework and
charged separately.

3.3 Step 2 Design of the project

In design we follow following steps
1. Wire frames (design concept )for all major pages
2. Index page mock up (sample)
3. HTML pages

3.4 Step 3 Development of the project

1. Coding
2. Milestone based deliveries
3. Quality Assurance

3.5 Step 4 Deployment of the project

1. Final testing on test server and QA

Page | 22

2. Once the client accept the last milestone and QA team gives go
ahead then will start migrating to live server (Client server)

Page | 23